GridChoiceDialog 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

This object allows you to build and display a choice window using a multi-column grid format. It is often used when more than one record is retrieved by a database lookup to allow the operator to select the correct record.

This window has a grid format. Therefore, a property is not needed to switch from the single to dual list view. The grid can be attached to an existing recordset. The columns can be sorted and the column width can be adjusted.

The GridChoiceDialog object is applicable to the following phases:

  • Post Extraction

  • AnyApp Post Extraction

  • Pre-Verification

  • Interactive

  • Interactive FKey

  • Post Verification

Property

Descritpion

Applicable Events

CellAlignment

Used to set the cell alignment to the left, center, or right. For more information, see CellAlignment (Property(page CellAlignment (Property))).

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

CellBackColor

Used to set the background color of a cell. For more information, see CellBackColor (Property)(page CellBackColor (Property)).

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

CellText

Used to get the text value of a cell or specify literal text to be output to the specified cell. For more information, see CellText (Property)(page CellText (Property)).

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

CellTextColor

Used to set the color of the text in a cell. For more information, see CellTextColor (Property)(page CellTextColor (Property)).

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

ColAlignment

Used to specify the column alignment. For more information, see ColAlignment (Property)(page ColAlignment (Property)).

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

Col

Used to get or set the column number of the active cell. For more information, see Col (Property)(page Col (Property)).

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

ColHeading

Used to specify the column heading. For more information, see ColHeading (Property)(page ColHeading (Property)).

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

ColWidth

Used to set the width of a column. For more information, see ColWidth (Property).(page ColWidth (Property))

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

DisplayImage

Specifies if the image is displayed with the grid. For more information, see DisplayImage (Property)(page DisplayImage (Property)).

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

GetIndex

Returns an integer representing the index of the value selected in the window. For more information, see GetIndex (Property)(page GetIndex (Property)).

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

GetSelection

Returns the value selected by the user in the GridChoiceDialog. For more information, see GetSelection (Property)(page GetSelection (Property)).

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

HighlightEntireRow

Read-write. If set to TRUE, the entire row of the selected cell is highlighted. If FALSE, just the current cell is highlighted. For more information, see HighlightEntireRow (Property)(page HighlightEntireRow).

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

NumberCols

Used to specify the number of columns in the grid. For more information, see NumberCols (Property)(page NumberCols (Property)).

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

NumberRows

Used to specify the number of rows in the grid. For more information, see NumberRows (Property).(page NumberRows (Property))

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

Row

Used to get or set the row number of the active cell. For more information, see Row (Property)(page Row (Property)).

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

RowHeight

Used to set the height of a row. For more information, see RowHeight (Property) (page RowHeight (Property)).

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

Method

Description

Applicable Events

AddItem

Adds items to the list in the GridChoiceDialog. For more information, see AddItem (Method)(page AddItem (Method)).

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

AppendCol

Adds a column to the end of the grid in the GridChoiceDialog. For more information, see AppendCol (Method).(page AppendCol (Method))

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

AppendRow

Adds a row to the end of the grid in the GridChoiceDialog. For more information, see AppendRow (Method)(page AppendRow (Method)).

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

DeleteCol

Deletes a column from the grid. For more information, see DeleteCol (Method)(page DeleteCol (Method)).

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

DeleteRow

Deletes a row from the grid. For more information, see DeleteRow (Method)(page DeleteRow (Method)).

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

DisplayRecordset

Attaches an existing recordset to the grid in the GridChoiceDialog. For more information, see DisplayRecordset (Method)(page DisplayRecordset (Method)).

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

DoModal

Causes the ChoiceDialog to display, and when the user selects a value, returns True. For more information, see DoModal (Method)(page DoModal (Method)).

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

FitToRows

Resizes the grid in the GridChoiceDialog to display based on the number of rows specified. For more information, see FitToRows (Method)(page FitToRows (Method)).

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

FitToWindow

Resizes the grid in the GridChoiceDialog to display based on the number of columns specified. For more information, see FitToWindow (Method)(page FitToWindow (Method)).

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

InsertCol

Inserts a column in the GridChoiceDialog. For more information, see InsertCol (Method)(page InsertCol (Method)).

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

InsertRow

Inserts a row in the GridChoiceDialog. For more information, see InsertRow (Method)(page InsertRow (Method)).

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

OpenSQL

Use to create a connection to a database and display the SQL statement as a recordset. For more information, see OpenSQL (Method)(page OpenSQL (Method)).

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

ResetContent

Resets the contents of the GridChoiceDialog. For more information, see ResetContent (Method)(page ResetContent (Method)).

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

SetCurrentCell

Used to set the active cell. For more information, see SetCurrentCell (Method).

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

SetCellFont

Used to set the font for a specific cell in the grid on the GridChoiceDialog. For more information, see SetCellFont (Method)(page SetCellFont (Method)).

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

SetDefaultFont

Used to set the default font for the entire grid on the GridChoiceDialog. For more information, see SetDefaultFont (Method)(page SetDefaultFont (Method)).

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

SetDefaultColor

Used to set the default color of the specified cell.

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

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

SetInitialViewArea

Used to set the area of the bitmap to display in the GridChoiceDialog. For more information, see SetInitialViewArea (Method)(page SetInitialViewArea (Method)).

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

SetLineViewArea

Used to display a different image or a different area of the same image on each line of the grid. For more information, see SetLineViewArea(page SetLineViewArea (Method)).

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

SetTitle

Used to set the title to appear at the top of the GridChoiceDialog. For more information, see SetTitle (Method) (page SetTitle (Method)).

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

The following image illustrates the default appearance of GridChoiceDialog: