beautypg.com

Kofax DOKuStar Validation User Manual

Page 70

background image

DOKuStar Validation Programming Manual

Page

66

For the filter objects, there is a base class called

CursorFilter

. This class has few methods and properties, which

you hardly will use. Derived from this base class there are the three classes

DocumentTypeFilter,

FieldStateFilter

and

FieldConfidenceFilter

, where you define which document types and field states

respectively are switched on and off. For the

FieldConfidenceFilter

, you can set a threshold value that ranges

from 0 to 100. All fields with a value lower or equal to this threshold will then be displayed.

Properties and methods of the

FieldStateFilter

object (excerpt):

Property/Method

Returns

Description

All

--

Switches all field states on. Every field will get activated.

Reset

--

Switches all field states off. No field will get activated.

State

Boolean

Returns/sets a single state to

on

or

off

.

Parameter:

State As State

Values for

State

are:

StateEmpty
StateError
StateNone
StateOk
StateReject

Properties and methods of the

DocumentTypeFilter

object (excerpt):

Property/Method

Returns

Description

All

--

Switches all document types on. Every document will get
activated.

Reset

--

Switches all document types off. No document will get
activated.

Type

Boolean

Returns/sets a document type to

on

or

off

.

Parameter:

doc As DocumentType

Properties and methods of the

FieldConfidenceFilter

object (excerpt):

Property/Method

Returns

Description

Reset

--

Sets the threshold to 100.

Threshold

--

Sets the threshold to a value between 0 and 100. Only fields
with a confidence value less or equal to the threshold will
be activated.