TheCategoryField Class |
Scroll |
TheCategoryField represents a field in an TheCategory.
Data includes:
Field number and type
Constraints for values allowed for the field
Reference to foreign table (if applicable)
Dialog layout information
Namespace: Therefore.API
Visual Basic Public Class TheCategoryField C# public class TheCategoryField |
Name |
Description |
Gets the field number of the TheCategoryField this field belongs to (set for dependent fields only). |
|
Gets or sets the caption of the field. |
|
Gets or sets whether the field is case sensitive or not. |
|
Gets the column name of the field in the database. |
|
Gets the condition for value dependent formatting of the field. |
|
Gets the TheConditionalFormatting of this field. |
|
Gets the counter mode of the TheCategoryField if it is a counter field. |
|
Gets or sets the default value for this field. |
|
Gets the TheDependencyMode of this field. |
|
Gets or sets the position of the field inside a table field or the position in the document title. |
|
Gets the TheDisplayProperties of this field. |
|
Gets or sets whether or not choices will be pre-loaded for display (only for keyword and dependent fields). |
|
Gets the field ID of this field. |
|
Gets the field number of this field. |
|
Gets the TheCategoryFieldType of this field. |
|
Gets the column name of the referenced column in a foreign table (set for dependent fields only). |
|
Gets the formula for value calculation of the field. |
|
Gets the GUID of the category field. |
|
Gets or sets the height of this field in the category dialog. |
|
Gets the Name of the index data field. |
|
Gets or sets the index type of the field (no / normal / unique). |
|
Returns whether or not the field is a foreign datatype. |
|
Returns whether or not the field is a multiple keyword. |
|
Returns whether or not the field is a single keyword. |
|
Gets information if values from a foreign data type should be copied to the TWC table and kept there redundant. |
|
Gets the length of the field. |
|
Gets or sets whether or not the field is mandatory and must be filled out before saving a document or changing the index data. |
|
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. |
|
Gets or sets the horizontal position of this field in the category dialog in pixels. |
|
Gets or sets the vertical position of this field in the category dialog in pixels. |
|
Gets or sets the regular expression. |
|
Gets the scale of the field. |
|
Gets or sets whether or not values are displayed in a drop down box (only for keyword and dependent fields). |
|
Gets the tab no containing this field. |
|
Gets or sets whether or not the possible values of the keyword or referenced field are sorted descending. |
|
Gets or sets the tabulator position of this field in the category dialog in pixels. |
|
Gets the TheTabInfoList of this field. |
|
Gets the TheCategoryFieldType of this field. |
|
Gets the type group of the field. |
|
Gets the type index column of the field. Additional information for user defined data type (TypeNo > 6). |
|
Gets the type multi inner of the field. Additional information for user defined data type (TypeNo > 6). |
|
Gets the type multi join of the field. Additional information for user defined data type (TypeNo > 6). |
|
Gets the type multi outer of the field. Additional information for user defined data type (TypeNo > 6). |
|
Gets the type number of this field. |
|
Gets the type table name of the field. Additional information for user defined data type (TypeNo > 6). |
|
Gets the list of valid default macros for the field. |
|
Gets or sets whether or not the field is visible in the category dialog. |
|
Gets the width of this field in the category dialog. |
|
Gets or sets the name of the corresponding Microsoft® Exchange form field (if Microsoft® Exchange workflow is enabled for the category). |
Name |
Description |
Changes the dependency mode on a dependent field. |
|
Gets the caption of the tab in the specified language. |
|
Gets the currently used LCID. This LCID is used to determine the translation when calling the Caption property. |
|
Gets the list of valid default macros for the field in the specified language. |
|
Returns whether or not the string matches the regular expression defined for this field. If no regular expression has been defined, then "TRUE" will always be returned. |
|
Sets the caption of the tab for the specified language. |
|
Sets the condition for value dependent formatting of the field and validates it. |
|
Sets the currently used LCID. This LCID is used to determine the translation when calling the Caption property. |
|
Sets the formula for value calculation of the field and validates it. |
|
Sets the document number of the image template (Only applies to fields where FieldType is ImageField) and checks if it is valid. |