Form 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 Form object is a template and the current data image combination.

The Form object is applicable to the following phases:

  • Post Extraction

  • AnyApp Post Extraction

  • Pre-Verification

  • Interactive

  • Interactive FKey

  • Post Verification

Property

Description

Applicable Events

AutoIDRotation

Read-only. Returns the rotation, in degrees, applied during Auto ID. For more information, see AutoIDRotation (Property)(page AutoIDRotation (Property)).

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

AutoOCRCurrentProfile

Read-write. Determines the setting of Automatically OCR Estimated Fields for the template. For more information, see AutoOCRCurrentProfile (Property)(page AutoOCRCurrentProfile (Property)).

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

AverageOMRHitFillPercent

Read-only. Returns the average fill percent of all OMR boxes that are enabled. 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 AverageOMRNonQuestionableHitFillPercent (Property) (page AverageOMRNonQuestionableHitFillPercent (Property)).

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

BatchControlExpression

Read-only. Returns the batch control expression for the current data image. For more information, see BatchControlExpression (Property)(page BatchControlExpression (Property)).

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

BatchControlNumber

Read-write. Gets or sets the user-defined batch control number of the current batch. For more information, see BatchControlNumber (Property)(page BatchControlNumber (Property)).

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

BatchID (page BatchID (Property))

Read-only. Returns the batch ID number, which is created internally by OCR for AnyDoc, as an eight character string. For more information, see BatchID (Property)(page BatchID (Property)).

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

BatchOriginalBatchID

Read-only. Returns the original batch ID, if a batch was rerouted. For more information, see BatchOriginalBatchID (Property)(page BatchOriginalBatchID (Property)).

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

BatchScanStationID

Read-only. Returns the station ID that scanned the current batch. For more information, seeBatchScanStationID (Property) (page BatchScanStationID (Property)).

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

BatchSourceIdentifier

Read-only. Identifies the origin of the batch, such as scanned in OCR for AnyDoc or CAPTUREit or imported from Infiniworx. For more information, see BatchSourceIdentifier (Property)(page BatchSourceIdentifier (Property)).

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

CondenseGroupColumnZones

Collapses the AnyApp grid columns in the display when a column is hidden. For more information, see CondenseGroupColumnZones (Property)(page CondenseGroupColumnZones (Property)).

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

CurrentDataImageName

Read-only. This function returns the fully qualified path name of the current data image. For more information, see CurrentDataImageName (Property)(page CurrentDataImageName (Property)).

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

CurrentDataImageOriginalImportName

Read-only. Returns the original data image's name before it was imported. For more information, see CurrentDataImageOriginalImport Name (Property)(page CurrentDataImageOriginalImportName (Property)).

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

CurrentDataImageShortName

Read-only. This function returns the file name, without the path, of the current data image. For more information, see CurrentDataImageShortName (Property)(page CurrentDataImageShortName (Property)).

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

CurrentDocSetNumber

Read-only. Returns the current document set's number within the batch. For more information, see CurrentDocSetNumber (Property)(page CurrentDocSetNumber (Property)).

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

CurrentLayout

Read-only. For more information, see CurrentLayout (Property)(page CurrentLayout (Property)).

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

CurrentLayoutLanguage

Read-only. For more information, see CurrentLayoutLanguage (Property)(page CurrentLayoutLanguage (Property)).

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

DocumentControlExpression

Read-only. This function returns the document control expression for the current data image. For more information, see DocumentControlExpression (Property)(page DocumentControlExpression (Property)).

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

FamilyName

Read-only. Returns the name of the current form family. For more information, see FamilyName (Property)(page FamilyName (Property)).

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

FoundRegPoints

Read-only. Returns the number of registration points on the current data image. For more information, see FoundRegPoints (Property)(page FoundRegPoints (Property)).

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

GetASCIIOutputFile

Read-only. Returns the fully qualified name of the ASCII output file. For more information, see GetASCIIOutputFile (Property)(page GetASCIIOutputFile (Property)).

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

HasStickyNotes (page HasStickyNotes (Property))

Read-only. Returns True if a zone on the form has a sticky note attached to it. For more information, see HasStickyNotes (Property) (page HasStickyNotes (Property)).

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

Height

Read-only. Returns the current data image's height. For more information, see Height (Property) (page Height (Property)).

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

ImageRequiresAudit

Read-only. Returns True if the image must be audited. For more information, see ImageRequiresAudit (Property)(page ImageRequiresAudit (Property)).

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

ImprinterString

Read-write. Sets or returns the imprinter string for the current data image. If imprinter strings are not used and one has not been set, the property returns “N/A.” For more information, see ImprinterString (Property)(page ImprinterString (Property)).

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

MaxRegPoints

Read-only. Returns the maximum number of user-defined registration points OCR for AnyDoc searches for on the image (according to the current template). For more information, see MaxRegPoints (Property)(page MaxRegPoints (Property)).

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

MinRegPoints

Read-only. Returns the minimum number of user-defined registration points to successfully register an image (per to the current template). For more information, see MinRegPoints (Property)(page MinRegPoints (Property)).

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

Name

Read-only. Returns the object's name and the master template's fully qualified path 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

NeedsVerification

Read-only. Returns True if the form requires Verification. For more information, see NeedsVerification (Property)(page NeedsVerification (Property)).

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

NumberOfAttachments

Read-only. Returns the number of Attachment pages in the current document set. For more information, see NumberOfAttachments (Property)(page NumberOfAttachments (Property)).

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

NumberOfAttachmentsInBatch

Read-only. Returns the number of attachment pages in the current batch. For more information, see NumberOfAttachmentsInBatch (Property)(page NumberOfAttachmentsInBatch (Property)).

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

ShortName

Read-only. Returns the eight character MS-DOS file name of the current master template. For more information, see ShortName (Property)(page ShortName (Property)).

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

TotalBatchPages

Read-only. Returns the total number of pages in the batch. For more information, see TotalBatchPages (Property) (page TotalBatchPages (Property)).

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

TotalRegPoints

Read-only. Returns the total number of registration points defined on the template. For more information, see TotalRegPoints (Property)(page TotalRegPoints (Property)).

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

TotalSetCount

Read-only. Returns the number of TotalSet objects for the current template. For more information, see TotalSetCount (Property)(page TotalSetCount (Property)).

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

TotalSetInfoIsValid

Read-only. Indicates if the current template contains any TotalSets or not. For more information, see TotalSetInfoIsValid (Property)(page TotalSetInfoIsValid (Property)).

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

Width

Read-only. Returns the current data image's width. For more information, see Width (Property) (page Width (Property)).

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

ZoneCount

Read-only. Returns the number of zones on the form. For more information, see ZoneCount (Property) (page ZoneCount (Property)).

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

Method

Description

Applicable Events

CheckCrop

Manually crops the check for BROKERit processing and optionally endorses, if specified. Not supported in VERIFYit. For more information, seeCheckCrop (page CheckCrop (Method)).

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

CheckEndorse

Virtually endorses the back of the check for DEPOSit processing. Not supported in VERIFYit. For more information, seeCheckEndorse (page CheckEndorse (Method)).

 

CurrentBatchPage

Read-only. Returns the page number for the current data image, relative to the batch. For more information, see CurrentBatchPage (Method)(page CurrentBatchPage (Method)).

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

CurrentDocSetPage

Read-only. Returns the current data image's page number in the active document set. This is used to determine if you are on the first or last page of a doc set to trigger an event. For more information, see CurrentDocSetPage (Method)(page CurrentDocSetPage (Method)).

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

DataMatchesCheckumRoutine

Returns True if the given data matches the current checksum routine and False otherwise. For more information, see DataMatchesChecksumRoutine (Method)(page DataMatchesChecksumRoutine (Method)).

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

DeleteDocSet

Deletes the current document set. This method is only valid for the Post Extraction and Post Verification events. For more information, see DeleteDocSet (Method)(page DeleteDocSet (Method)).

Post Extraction, Post Verification

DocSetCount

Read-only. Returns the number of document sets in the current batch. For more information, see DocSetCount (Method)(page DocSetCount (Method)).

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

DocSetPageName

Read-only. Given a page number within a document set, returns the fully qualified path and file name of the image. This is the current location and name of the image, not the archive file name. For more information, see DocSetPageName (Method)(page DocSetPageName (Method)).

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

DocSetPageShortName

Read-only. Given a page number within a document set, returns the short file name of the image in 8.3 format. This is the name of the image, not the archive file name. For more information, see DocSetPageShortName (Method)(page DocSetPageShortName (Method)).

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

GetInfiniworxDocumentGroup

Returns the Infiniworx Document group. If it doesn't exist, a blank value is returned. For more information, seeGetInfiniworxDocumentGroup (Method) (page GetInfiniworxDocumentGroup (Method)).

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

GetInfiniworxDocumentType

Returns the Infiniworx Document type. If it doesn't exist, a blank value is returned. For more information, see GetInfiniworxDocumentType (Method(page GetInfiniworxDocumentType (Method))).

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

GetVerifyLayoutList

Returns an array containing the list of defined layouts. For more information, see GetVerifyLayoutList (Method)(page GetVerifyLayoutList (Method)).

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

RegPointX

Returns the horizontal coordinates of the Nth registration point on the current data image. For more information, see RegPointX (Method)(page RegPointX (Method)).

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

RegPointY

Returns the vertical coordinates of the Nth registration point on the current data image. For more information, see RegPointY (Method)(page RegPointY (Method)).

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

RemoveFieldFromCurrentProfile

Removes the specified zone from the QuickApp profile. For more information, see RemoveFieldFromCurrentProfile (Method)(page RemoveFieldFromCurrentProfile (Method)).

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

RouteDocSet

Routes the entire document set to the Import directory for a different form family for further processing. For more information, see RouteDocSet (Method)(page RouteDocSet (Method)).

Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Post-Verify

RouteToAutoIDX

Routes the current data image or document set to the Exceptions phase. For more information, see RouteToAutoIDX (Method)(page RouteToAutoIDX (Method)).

none

RouteToQAReview

Routes the current image to the QA Review phase. For more information, see RouteToQAReview (Method)(page RouteToQAReview (Method)).

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

SetVerifyLayout

Sets the verify screen that will be used and optionally sets the applicable system language. This method is only valid for the Pre Verification and Interactive events. For more information, see SetVerifyLayout (Method)(page SetVerifyLayout (Method)).

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

SubFileGetCount (page SubFileGetCount (Method))

Read-only. Returns the count of sub files for the specified type. By default, the count is for the current batch image sequence, but a specific batch image sequence can also be passed. For more information, seeSubFileGetCount (page SubFileGetCount (Method)).

Pre-Verification, Post-Verification, Post-Extract

SubFileCreate

Read-only. Creates a sub file for the specified type. By default, the file is created for the current batch image sequence, but a specific batch image sequence can also be passed. Returns TRUE if the create succeeded, otherwise FALSE. For more information, seeSubFileCreate (page SubFileCreate (Method)).

Post Verification

TotalDocSetPages

Read-only. Returns the number of pages in the active document set. For more information, see TotalDocSetPages (Method)(page TotalDocSetPages (Method)).

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

TotalSet

Returns the specified TotalSet object. For more information, see TotalSet (Method)(page TotalSet (Method)).

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

ViewFile

Read-only. Takes a parameter of the fully qualified file to view and optionally a Boolean indicating whether to use the AnyDoc viewer for TIF files. All other file types will use the Operating System's registered viewer.

For more information, see ViewFile (Method)(page ViewFile (Method)).

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

Zone

Returns a reference to a Zone object. For more information, see Zone (Method) (page Zone (Method)).

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