CollectionSchemaField Class Documentation

class CollectionSchemaField : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

Allows for the creation of collection schema field objects.

Parameters that are part of a schema's field may be set.

Constructor & Destructor Documentation

CollectionSchemaField

CollectionSchemaField(string fieldID, SchemaFieldSubtype subtype)

Parameters

fieldID: string

the schema field ID. The ID is used during creation and extraction of the schema field. It is the unique identifier of the schema field.

subtype: SchemaFieldSubtype

the schema field subtype. The subtypes are predefined. The value of this parameter must correspond to the one of the SchemaFieldSubtype enum values.

CCollectionSchemaField allows to create CollectionSchemaField object.

The constructor accepts identifier value and subtype required by the schema field.

Property Documentation

Editable

bool Editable[get, set]

ID

string ID[get]

Index

int Index[get, set]

Name

string Name[get, set]

Subtype

SchemaFieldSubtype Subtype[get]

Visible

bool Visible[get, set]

Member Function Documentation

Dispose

void Dispose()

Returns:

void