Line 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 Line object represents a single line (row) from a Text zone. Use this object on a multi-line zone only. On single-line zones, use the Zone object.

The Line object is applicable to the following phases:

  • Post Extraction

  • AnyApp Post Extraction

  • Pre-Verification

  • Interactive

  • Interactive FKey

  • Post Verification

Property

Descriptions

Applicable Events

Area

Read-write. Returns the Rectangle object during the Post Extract and Pre-Verification phases. For more information, see Area (Property) (page Area (Property)).

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

AddressType

Read-only. Returns a value indicating the object's Address Component Type. For more information, see AddressType (Property) (page AddressType (Property)).

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

BackgroundColor

Sets the background color for specific lines in a 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

Changed

Returns True if the Zone or Line object's value has changed. Read-write. For more information, see Changed (Property) (page Changed (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

DataIsFromMemory

Read-only. Specifies if the data was determined by AnyApp Memory. For more information, see DataIsFromMemory (Property) (page DataIsFromMemory (Property)).

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

DataWasPropagated

Indicates whether or not the data was propagated by AAC (Advanced ASCII Controls). Read-only. For more information, see DataWasPropagated (Property)(page DataWasPropagated (Property)).

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

DateValue

Returns the date value after date extraction. Read-only. For more information, see DateValue (Property) (page DateValue (Property)).

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

DiscardedByProcedure

Read-only. Indicates if the data was hidden by a conditional procedure or not. For more information, see DiscardedByProcedure (Property)(page DiscardedByProcedure (Property)).

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

DynamicDoubleKey

Read-only. Indicates a zone is flagged for dynamic double-key. For more information, see DynamicDoubleKey (Property) (page DynamicDoubleKey (Property)).

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

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)).

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

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

IsAdvancedImportFilled

Read-only. Returns TRUE if the line was populated via Advanced Import, such as OPEX, IBML, Infiniworx, and EXCHANGEit. For more information, see IsAdvancedImportFilled (Property)(page IsAdvancedImportFilled (Property)).

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

IsAlpha

Read-only. Returns True if the object contains data that is entirely alphabetic, and False otherwise. For more information, see IsAlpha (Property) (page IsAlpha (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

IsBlank

Read-only. Returns True if the object is blank, and False otherwise. For more information, see IsBlank (Property) (page IsBlank (Property)).

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

IsNotAlpha

Read-only. Returns True if the object is not entirely alphabetic. For more information, see IsNotAlpha (Property) (page IsNotAlpha (Property)).

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

IsNotBlank

Read-only. Returns True if the object has ANSI data in it. For more information, see IsNotBlank (Property) (page IsNotBlank (Property)).

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

IsNotNumeric

Read-only. Returns True if the given object is not entirely numeric. For more information, see IsNotNumeric (Property) (page IsNotNumeric (Property)).

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

IsNumeric

Read-only. Returns True if the object contains data that is entirely numeric, and False otherwise. For more information, see IsNumeric (Property) (page IsNumeric (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

NumericValue

Returns the zone or line's numeric value. Alpha characters are either ignored or dropped. Strings that are entirely alpha return zero. Leading zeros are ignored. For more information, see NumericValue (Property) (page NumericValue (Property)).

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

PageNumber

Gets or sets the page number for the specified line. Read-write. For more information, see PageNumber (Property) (page PageNumber (Property)).

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

PercentQuestionable

Read-only. Returns the questionable characters' percentage in the given object. For more information, see PercentQuestionable (Property) (page PercentQuestionable (Property)).

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

QuesCharCount

Read-only. Returns the number of questionable characters in the given object. For more information, see QuesCharCount (Property) (page QuesCharCount (Property)).

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

RawCharCount

Read-only. Returns the number of non-space characters contained in the object. For more information, see RawCharCount (Property) (page RawCharCount (Property)).

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

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

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

TranslatedValue

Read-only. Returns the zone's translated value or an empty string if the value was not found in the table. For more information, see TranslatedValue (Property) (page TranslatedValue (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 line. For more information, see VerifierLandedOn (Property) (page VerifierLandedOn (Property)).

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

Value

Gets or sets the ANSI data for the given object. Read-write. For more information, see Value (Property) (page Value (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

Method

Description

Applicable Events

ApplyCropMask

Applies the OCR for AnyDoc crop mask routine to the data. For more information, see ApplyCropMask (Method) (page ApplyCropMask (Method)).

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

ApplyDateExtraction

Applies the OCR for AnyDoc date extraction routine to the data. For more information, see ApplyDateExtraction (Method) (page ApplyDateExtraction (Method)).

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

ApplyEditMask

Applies the OCR for AnyDoc edit mask routine to the data. For more information, see ApplyEditMask (Method) (page ApplyEditMask (Method)).

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

ClearQuesChars

Clears the questionable status from the characters in the given object. For more information, see ClearQuesChars (Method) (page ClearQuesChars (Method)).

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

ContainsAlphas

Determines if the object contains alphabetic characters. For more information, see ContainsAlphas (Method) (page ContainsAlphas (Method)).

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

ContainsNumerics

Determines if the object contains numeric characters. For more information, see ContainsNumerics (Method) (page ContainsNumerics (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 example, to audit a dollar amount zone any time the amount exceeds a certain value. For more information, see ForceAudit (Method) (page ForceAudit (Method)).

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

FoundInTable

Returns the value found in the table for zones attached to an internal table. For more information, see FoundInTable (Method) (page FoundInTable (Method)).

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

FuzzyCompare

Returns True if the ANSI data stored in the object matches a given string (case sensitive) within a given percentage of the row (not a percentage of the word). For more information, see FuzzyCompare (Method) (page FuzzyCompare (Method)).

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

FuzzyCompareNoCase

Returns True if the ANSI data stored in the object matches a given string (case insensitive) within a given percentage of the row (not a percentage of the word). For more information, see FuzzyCompareNoCase (Method) (page FuzzyCompareNoCase (Method)).

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

MatchesChecksumRoutine

Returns True if the object's data matches the current Checksum Routine and False otherwise. For more information, see MatchesChecksumRoutine (Method) (page MatchesChecksumRoutine (Method)).

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

MatchesEditMask

Returns True if the ASCII data in the object matches the given edit mask, and False otherwise. For more information, see MatchesEditMask (Method) (page MatchesEditMask (Method)).

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

QuesCharOffset

Returns the character offset of the given questionable character identifier. For more information, see QuesCharOffset (Method) (page QuesCharOffset (Method)).

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

RemoveAuditFlags (page RemoveAuditFlags (Method))

Removes all 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

RemoveChars

Removes specified characters from ANSI data. For more information, see RemoveChars (Method).

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

RemoveExtraSpaces

Removes all occurrences of adjacent spaces, leaving only single spaces in the ANSI data. For more information, see RemoveExtraSpaces (Method) (page RemoveExtraSpaces (Method)).

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

RemoveSpaces

Removes all spaces from the ANSI data. For more information, see RemoveSpaces (Method) (page RemoveSpaces (Method)).

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

RetainChars

Removes all but the specified characters from ANSI data. For more information, see RetainChars (Method) (page RetainChars (Method)).

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

StringMatchPercent

Returns the match percentage between the ANSI data in the object and the given string. The comparison is case sensitive. For more information, see StringMatchPercent (Method) (page StringMatchPercent (Method)).

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

StringMatchPercentNoCase

Returns the match percentage between the ANSI data in the object and the given string. The comparison is case insensitive. For more information, see StringMatchPercentNoCase (Method) (page StringMatchPercentNoCase (Method)).

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