Therefore Programming Interface 3.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore API > API Reference > Classes > TheCategoryField

TheCategoryField Properties

Name	Description
BelongsTo	Gets the field number of the TheCategoryField this field belongs to (set for dependent fields only).
Caption	Gets or sets the caption of the field.
CaseSensitive	Gets or sets whether the field is case sensitive or not.
ColName	Gets the column name of the field in the database.
Condition	Gets the condition for value dependent formatting of the field.
ConditionalFormatting	Gets the TheConditionalFormatting of this field.
CounterMode	Gets the counter mode of the TheCategoryField if it is a counter field.
DefaultVal	Gets or sets the default value for this field.
DependencyMode	Gets the TheDependencyMode of this field.
DisplayOrderPos	Gets or sets the position of the field inside a table field or the position in the document title.
DisplayProperties	Gets the TheDisplayProperties of this field.
DontLoadValues	Gets or sets whether or not choices will be pre-loaded for display (only for keyword and dependent fields).
FieldID	Gets the field ID of this field.
FieldNo	Gets the field number of this field.
FieldType	Gets the TheCategoryFieldType of this field.
ForeignCol	Gets the column name of the referenced column in a foreign table (set for dependent fields only).
Formula	Gets the formula for value calculation of the field.
GUID	Gets the GUID of the category field.
Height	Gets or sets the height of this field in the category dialog.
IndexDataFieldName	Gets the Name of the index data field.
IndexType	Gets or sets the index type of the field (no / normal / unique).
IsForeignDatatype	Returns whether or not the field is a foreign datatype.
IsMultipleKeyword	Returns whether or not the field is a multiple keyword.
IsSingleKeyword	Returns whether or not the field is a single keyword.
KeepRedundant	Gets information if values from a foreign data type should be copied to the TWC table and kept there redundant.
Length	Gets the length of the field.
Mandatory	Gets or sets whether or not the field is mandatory and must be filled out before saving a document or changing the index data.
ParentFieldNo	Gets the field number of the parent TheCategoryField object. This value is set for fields located in tabs or that are columns in table fields.
PosX	Gets or sets the horizontal position of this field in the category dialog in pixels.
PosY	Gets or sets the vertical position of this field in the category dialog in pixels.
RegularExpr	Gets or sets the regular expression.
Scale	Gets the scale of the field.
SelectFromDropDownBox	Gets or sets whether or not values are displayed in a drop down box (only for keyword and dependent fields).
ShowInTabNo	Gets the tab no containing this field.
SortDescending	Gets or sets whether or not the possible values of the keyword or referenced field are sorted descending.
TabOrderPos	Gets or sets the tabulator position of this field in the category dialog in pixels.
Tabs	Gets the TheTabInfoList of this field.
Type	Gets the TheCategoryFieldType of this field.
TypeGroup	Gets the type group of the field.
TypeIndexColumn	Gets the type index column of the field. Additional information for user defined data type (TypeNo > 6).
TypeMultiInner	Gets the type multi inner of the field. Additional information for user defined data type (TypeNo > 6).
TypeMultiJoin	Gets the type multi join of the field. Additional information for user defined data type (TypeNo > 6).
TypeMultiOuter	Gets the type multi outer of the field. Additional information for user defined data type (TypeNo > 6).
TypeNo	Gets the type number of this field.
TypeTableName	Gets the type table name of the field. Additional information for user defined data type (TypeNo > 6).
ValidDefaultMacros	Gets the list of valid default macros for the field.
Visible	Gets or sets whether or not the field is visible in the category dialog.
Width	Gets the width of this field in the category dialog.
WorkflowField	Gets or sets the name of the corresponding Microsoft® Exchange form field (if Microsoft® Exchange workflow is enabled for the category).