Documenttype, Fieldtypes, Fieldtype – Kofax DOKuStar Validation User Manual

Page 56

Advertising
background image

DOKuStar Validation Programming Manual

Page

52

DocumentType

The

DocumentType

object describes one single document type and belongs to the

Schema

part of the

Dataset

. On the

Data

side, the

Document

object is an instance of the

DocumentType

object.

Properties and methods of the

DocumentType

object (excerpt):

Property/Method

Returns

Description

FieldTypes

FieldTypes

Returns the collection of

FieldTypes

defined for this

DocumentType

Name

String

Name of the

DocumentType

.

FieldTypes

See the description for

DocumentTypes

. The properties and methods are identical after replacing

DocumentTypes

by

FieldTypes

and

DocumentType

by

FieldType

respectively.

FieldType

FieldType

s are used at two places:

-

linked to a

DocumentType

object, they describe the index fields for this document type,

-

linked to a

FieldType

itself, they describe sub-fields of an index field.

Currently, the only place where

FieldType

s are used as sub-fields of a

FieldType

is the

TableField

. Here,

these

FieldType

s describe the column definition of a table.

Properties and methods of the

FieldType

object (excerpt):

Property/Method

Returns

Description

FieldTypes

FieldTypes

Returns the collection of

FieldType

s , i.e. sub-fields, for this

FieldType

Name

String

Name of the

FieldType

. If the

FieldType

is used as a sub-field

of a table, this is the column name from the DOKuStar table
definition.

Advertising