CollectionSchemaField Class Documentation
class CollectionSchemaField : SystemIDisposableNamespace: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.
Referenced by
Uses types
Constructor & Destructor Documentation
CollectionSchemaField
CollectionSchemaField(string fieldID, SchemaFieldSubtype subtype)Parameters
fieldID: stringthe 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: SchemaFieldSubtypethe 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]GetEditable allows to obtain information about edit mode of the current field.
ID
string ID[get]GetID allows to obtain the unique id with which schema field has been created.
Index
int Index[get, set]GetIndex allows to obtain field index.
Name
string Name[get, set]GetName allows to obtain field name.
Subtype
SchemaFieldSubtype Subtype[get]GetSubtype allows to obtain the field subtype.
Visible
bool Visible[get, set]GetVisible allows to obtain information about filed visibility.
Member Function Documentation
Dispose
void Dispose()Returns:
void