OMR Zone Object - OCR for AnyDoc - Foundation 23.1 - Foundation 23.1 - AnyDoc - external

OCR for AnyDoc Programming Reference Guide

Platform
AnyDoc
Product
OCR for AnyDoc
Release
Foundation 23.1
License

The OMR Zone object represents a collection of mark sense boxes within a single zone.

The OMR Zone object is applicable to the following phases:

  • Post Extraction

  • AnyApp Post Extraction

  • Pre-Verification

  • Interactive

  • Interactive FKey

  • Post Verification

Property

Description

Applicable Events

AverageOMRHitFillPercent

Read-only. Returns the average fill percent of all OMR Boxes that are enabled read-only. For more information, see AverageOMRHitFillPercent (Property)(page AverageOMRHitFillPercent (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

AverageOMRNonQuestionableHitFillPercent

Read-only. Returns the average fill percent of all OMR Boxes that are enabled and non-questionable. For more information, see AverageOMRNonQuestionableHitFill (page AverageOMRNonQuestionableHitFillPercent (Property))

Percent (Property)(page AverageOMRNonQuestionableHitFillPercent (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

BackgroundColor

Sets the background color for the entire zone. For more information, see BackgroundColor (Property) (page BackgroundColor (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

BoxCount

Read-only. Returns the number of OMR boxes in the given OMR zone. For more information, see BoxCount (Property)(page BoxCount (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

Columns

Read-only. Returns the number of columns of OMR boxes in an OMR zone. For more information, see Columns (Property)(page Columns (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

CustomMessage

Read-write. Gets or sets the custom Verification message that is displayed in the Verifier. For more information, see CustomMessage (Property) (page CustomMessage (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

DefLiteralIfNoMarksFilled

Read-only. Returns the user-defined default literal value for an OMR zone if no marks are filled. For more information, see DefLiteralIfNoMarksFilled (Property)(page DefLiteralIfNoMarksFilled (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

DensestCheckedBoxOffset

Read-only. Returns the box number of the enabled OMR box with the highest fill percent. For more information, see DensestCheckedBoxOffset (Property)(page DensestCheckedBoxOffset (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

FillPercent

Read-only. Returns the fill percent of the given OMR box or Note zone, as calculated by the OMR engine. For more information, see FillPercent (Property) (page FillPercent (Property)).

 

Flagged

Read-write. This property indicates if the object has been flagged by the system for Verification (causing the Verifier to stop on the processed zone). For more information, see Flagged (Property) (page Flagged (Property)).

 

Hidden

Read-write. Whether or not the object is hidden for the Verifier. For more information, see Hidden (Property)(page Hidden (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsAACInputZone

Read-only. Returns True if the current object is used in Advanced ASCII Controls (AAC). For more information, see IsAACInputZone (Property) (page IsAACInputZone (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsAnyAppException

Read-only. Returns True if the AnyApp Exception handler is displayed. For more information, see IsAnyAppException (Property) (page IsAnyAppException (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsAudit

Read-only. Returns True if the specified zone is flagged for Audit. For more information, see IsAudit (Property) (page IsAudit (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsBarCodeZone

Read-only. Returns True if the zone is a Barcode zone. For more information, see IsBarCodeZone (Property) (page IsBarCodeZone (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsNotAACInputZone

Read-only. Returns True if the zone is not an AAC input zone. For more information, see IsNotAACInputZone (Property) (page IsNotAACInputZone (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsNotBarcodeZone

Read-only. Returns True if the zone is not a Barcode zone. For more information, see IsNotBarCodeZone (Property) (page IsNotBarCodeZone (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsNoteZone

Read-only. Returns True if the zone is a Note zone. For more information, see IsNoteZone (Property) (page IsNoteZone (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsNotNoteZone

Read-only. Returns True if the zone is not a Note Zone. For more information, see IsNotNoteZone (Property) (page IsNotNoteZone (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsNotOMR

Read-only. Returns True if the object is not an OMR Zone. For more information, see IsNotOMR (Property) (page IsNotOMR (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

IsOMR

Read-only. Returns True if the object is an OMR Zone. For more information, see IsOMR (Property) (page IsOMR (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

LabelColor

Sets the text color for the field label. For more information, see LabelColor (Property) (page LabelColor (Property))

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

LabelText

Read-write. Sets the text for the zone labels in the Verification screen. For more information, see LabelText (Property) (page LabelText (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

MaxFillPercent

Read-only. Returns the user defined maximum fill percent for an OMR box to be considered a Hit. For more information, see MaxFillPercent (Property)(page MaxFillPercent (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

MinFillPercent

Read-only. Returns the user defined minimum fill percent for an OMR box to be considered a hit. For more information, see MinFillPercent (Property)(page MinFillPercent (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

Name

Read-only. Returns the user defined zone name. For more information, see Name (Property)(page Name (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

QuesBoxCount

Read-only. Returns the number of OMR boxes in the given OMR zone that OCR for AnyDoc reads as questionable. For more information, see QuesBoxCount (Property)(page QuesBoxCount (Property)).

 

ReadOnly

Read-write. This property gets or sets the read-only status of the object. For more information, see ReadOnly (Property) (page ReadOnlyUserClick (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

ReadOnlyUserClick

Read-write. This property gets or sets the object's read-only status. For more information, see ReadOnlyUserClick (Property) (page ReadOnlyUserClick (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

Rows

Read-only. Returns the number of rows containing boxes in the current OMR zone. For more information, see Rows (Property)(page Rows (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

RuleBroken

Read-only. Returns True if a user-defined rule set through Rules parameters is violated on the given object. For more information, see RuleBroken (Property) (page RuleBroken (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

Skip

Read-write. When the script sets it to True, the object becomes read-only in Verification until the operator has passed it, at which time it reverts to normal. For more information, see Skip (Method) (page Skip (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

StickyNote

Read-write. Gets or sets the ANSI text for a sticky note on this object. For more information, see StickyNote (Property) (page StickyNote (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

UniqueCheckedBoxOffSet

Read-only. Returns the box number of the checked box in the OMR Zone. For more information, see UniqueCheckedBoxOffSet (Property)(page UniqueCheckedBoxOffSet (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

VBHidden

Read-write. Indicates if the object is marked as hidden in VBScript for the Verifier. For more information, see VBHidden (Property) (page Hidden (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

VerifierLandedOn

Read-only. Returns True if the verification operator reviewed the specified OMR zone. For more information, see VerifierLandedOn (Property)(page VerifierLandedOn (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

ZoneArchiveFileName

Read-only. Returns the file name of the archived zone snippet. For more information, see ZoneArchiveFileName (Property) (page ZoneArchiveFileName (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

ZoneNumber

Read-only. Returns the zone number of the given zone object. For more information, see ZoneNumber (Property) (page ZoneNumber (Property)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

Method

Description

Applicable Events

Box

Given a box number, returns the box object. For more information, see Box (Method)(page Box (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

CheckAllBoxes

Marks all boxes in the given OMR Zone as enabled. For more information, see CheckAllBoxes (Method)(page CheckAllBoxes (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

CheckImageInSplitter

Displays the BROKERit Check image that is associated with the specified batch image, in the Splitter window. For more information, see CheckImageInSplitter (page CheckImageInSplitter (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

ClearQuesBoxes

Clears the questionable status from all OMR boxes in the given OMR Zone. For more information, see ClearQuesBoxes (Method)(page ClearQuesBoxes (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

ForceAudit

This method is used in conjunction with the form level Verification parameter, Audit This Template, to specify data conditions under which an image is flagged for audit. For more information, see ForceAudit (Method) (page ForceAudit (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

QuesBoxOffSet

Returns the Box Number of the given Questionable Box Identifier. For more information, see QuesBoxOffset (Method)(page QuesBoxOffset (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

RemoveAuditFlags (page RemoveAuditFlags (Method))

Removes all previously assigned audit flags from the ANSI data. For more information, see RemoveAuditFlags (Method) (page RemoveAuditFlags (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

SetSplitterView

Sets the splitter view so the full image or a specific area of an image in the current batch can be displayed. For more information, see SetSplitterView (Method) (page SetSplitterView (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify

UncheckAllBoxes

Marks all boxes in the given OMR Zone as disabled. For more information, see UncheckAllBoxes (Method) (page UncheckAllBoxes (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify