Algorithm 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 Algorithm object represents a single algorithm in the AnyApp application.

The Algorithm object is applicable to the following phases:

  • AnyApp Pre-Application

  • AnyApp Post-Algorithm

  • AnyApp Post-Application

Property

Description

Applicable Events

DisplayName

Indicates the display name that is used for the algorithm when it is displayed in the Verifier. For more information, see DisplayName (Property)(page DisplayName (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

DisplayViewArea

Accesses the Rectangle object that holds the coordinates of the data image that is displayed to the Verifier. For more information, see DisplayViewArea (Property)(page DisplayViewArea (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

MaxTokenDistance

Used to set the Maximum Pixel Distance between tokens in an algorithm that is returning multi-token solutions. For more information, see MaxTokenDistance (Property)(page MaxTokenDistance (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

PageNumber

Returns the page number within the document set of the current data image. For more information, see PageNumber (Property) (page PageNumber (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

PARM_AlgorithmHasMultiTokenSolutions

Controls if the algorithm returns multi-token solutions. For more information, see PARM_AlgorithmHasMultiTokenSolutions (Property)(page PARM_AlgorithmHasMultiTokenSolutions (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

PARM_DefaultViewingArea

Used to access the algorithm's default viewing area that is measured in percentages. For more information, see PARM_DefaultViewingArea (Property)(page PARM_DefaultViewingArea (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

PARM_DefaultViewingAreaPixels

Used to access the algorithm's default viewing area that is measured in pixels. For more information, see PARM_DefaultViewingAreaPixels (Property)(page PARM_DefaultViewingAreaPixels (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

PARM_MaxDistance

Controls the maximum allowable distance between a found given KeyWord and the DataWords that are returned by it. For more information, see PARM_MaxDistance (Property)(page PARM_MaxDistance (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

PARM_RetainTokensAggressively

Accesses the GUI feature "Allow Large Gaps Between Word." For more information, see PARM_RetainTokensAggressively (Property)(page PARM_RetainTokensAggressively (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

PARM_SearchArea

Can be used to access the rectangle that contains the GUI based search area. This Rectangle object uses percentages. For more information, seePARM_SearchArea (Property) (page PARM_SearchArea (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

PARM_SearchAreaPixels

This property can be used to access the rectangle that contains the GUI based search area. This Rectangle object uses data image coordinates. For more information, see PARM_SearchAreaPixels (Property)(page PARM_SearchAreaPixels (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

PARM_WinnerMethod

Used to access the "winning method" which is set in the GUI. For more information, see PARM_WinnerMethod (Property)(page PARM_WinnerMethod (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

SearchEnabled

Indicates whether or not the GUI based portion of the Algorithm is executed. For more information, see SearchEnabled (Property) (page SearchEnabled (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

SetSolution

Given a number (1 ≤ nNumber ≤ objAlg.SolutionCount), this function replaces the solution in that position with the solution provided. For more information, see SetSolution (Property) (page SetSolution (Property)) .

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

SolutionCount

This property returns the number of solutions currently contained within the Algorithm object. For more information, see SolutionCount (Property) (page SolutionCount (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

TemplateName

Returns the name of the AnyApp template. For more information, see TemplateName (Property) (page TemplateName (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

UserData

This property is not used by the system. It provides an algorithm level means of storage for user defined data. For more information, see UserData (Property) (page UserData (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

VBScriptEnabled

Indicates whether or not the VBScript attached to the algorithm is executed. This property has no effect on any GUI based parameters attached to the algorithm. For more information, see VBScriptEnabled (Property) (page VBScriptEnabled (Property)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

Method

Description

Applicable Events

AddSolution

This function takes the ASCII data and the area supplied in a Rectangle object, and adds an additional solution to the given algorithm. For more information, see AddSolution (Method)(page AddSolution (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

HasMemoryCell

True is returned if the given algorithm has a cell in the Memory database for the given index value. Otherwise, false is returned. For more information, see HasMemoryCell (Method)(page HasMemoryCell (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

RemoveAllSolutions

This function discards all the solutions attached to the Algorithm object. For more information, see RemoveAllSolutions (Method)(page RemoveAllSolutions (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

RemoveSolution

Given a number (1 ≤ nNumber ≤ objAlg.SolutionCount), this function discards the specified solution. For more information, see RemoveSolution (Method) (page RemoveSolution (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

Reset

This function resets the algorithm parameters to the values when the template was saved. For more information, see Reset (Method)(page Reset (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

SetUniqueSolution

Given a number (1 ≤ nNumber ≤ objAlg.SolutionCount), this function discards all solutions in the given algorithm except for the specified one. For more information, see SetUniqueSolution (Method)(page SetUniqueSolution (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

SetUniqueSolutionLiteral

This method discards all solutions, if any, attached to the given algorithm and adds a single solution with the given text. For more information, see SetUniqueSolutionLiteral (Method)(page SetUniqueSolutionLiteral (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application

Solution

Given a number (1 ≤ nNumber ≤ objAlg.SolutionCount), this function returns the Solution object in that position. For more information, see Solution (Method) (page Solution (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application