Document – Kofax DOKuStar Validation User Manual

Page 59

Advertising
background image

DOKuStar Validation Programming Manual

Page

55

Document

Holds information about one document, especially the fields and the images. Furthermore, there is an

Activate

method which lets the document get activated.

Properties and methods of the

Document

object (excerpt):

Property/Method

Returns

Description

Activate

Boolean

Activates the document. Returns

True

if successful.

Activated

Boolean

Returns

True

if the document is currently activated.

DataSources

DocumentDataSources

Returns the list of

DataSource

objects for this document.

Deactivate

Boolean

Deactivates the document, moving activation to the next one.

Fields

Fields

Returns the list of fields for this document. This will always
deliver the complete list of fields as defined for the
corresponding

DocumentType

, no matter if the fields were

found by DOKuStar or not.

Name

String

Name of the document. This is the

DocumentType

name.

Note that the

Activate

and

Deactivate

methods return a Boolean; these methods will fire the event

OnDocumentActivating/ed,

or

OnDocumentDeactivating/ed

respectively, which might be cancelled

by a scripting routine; in this case, they would return

False

.

Advertising