Kofax DOKuStar Validation User Manual

Page 69

Advertising
background image

DOKuStar Validation Programming Manual

Page

65

Properties and methods of the

Cursor

object (excerpt):

Property/Method

Returns

Description

Documents

Documents

Returns the list of documents with respect to the currently selected
filters.

Fields

Fields

Returns the list of fields with respect to the currently selected filters.

Filters

CursorFilters

Returns the list of

CursorFilter

s appended to this cursor.

FirstDocument

Document

Returns the first document from the

Documents

list.

FirstField

Field

Returns the first field from the

Fields

list.

LastDocument

Document

Returns the last document from the

Documents

list.

LastField

Field

Returns the last field from the

Fields

list.

Name

String

Name of the cursor object.

NextDocument

Document

Returns the next document from the

Documents

list.

Parameter:

CurrentDocument As Document

NextField

Field

Returns the next field from the

Fields

list.

Parameter:

CurrentField As Field

PreviousDocument

Document

Returns the previous document from the

Documents

list.

Parameter:

CurrentDocument As Document

PreviousField

Field

Returns the previous field from the

Fields

list.

Parameter:

CurrentField As Field

Properties and methods of the

CursorFilters

object (excerpt):

Property/Method

Returns

Description

Add

CursorFilter

Adds a new filter to the list. The newly created filter is returned.
Parameters:

ClassName As String

: One of the two predefined class names

dataset::FieldStateFilter

and

dataset::DocumentTypeFilter

Name As String

: New name of the filter

At

CursorFilter

Returns the filter from the list at the given index position or with the
specified name.
Parameter:

Index As Long

or

Name As String

Name

is the name under which the filter was added to the list; the

standard filter names are

fieldstate

and

documenttype

In addition, all the methods defined for collections are available.

Advertising