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 > TheCategory

TheCategory Methods

Name	Description
ColNameToFieldNo	Gets the field number for the specified column name.
Create	Creates a new category.
CreateField	Creates a new category field and adds it to the current category.
CreateTab	Creates a new tab in a tab control field.
DeleteField	Deletes a field from the category.
DeleteTab	Deletes a tab in a tab control field.
DeleteTranslation	Deletes the translation with the specified LCID from the category including category fields and tabs.
FieldNoToColName	Gets the column name for the specified field number.
GetAvailableLCIDs	Returns an array of LCIDs used in the current category.
GetCalculationTriggerFields	Returns an array of field numbers that are used in calculation formulas for other fields.
GetCurrentLCID	Gets the currently used LCID.
GetDescription	Gets the description of the category in the specified language.
GetFieldByColName	Gets an TheCategoryField object representing the field with the specified column name.
GetFieldByFieldID	Gets an TheCategoryField object representing the field with the specified field ID.
GetFieldByFieldNo	Gets an TheCategoryField object representing the field with the specified field number.
GetFieldByIndex	Gets an TheCategoryField object representing the field with the specified field index.
GetFormattingTriggerFields	Returns an array of field numbers that are used for conditional formatting for other fields.
GetKeywords	Gets the keywords or possible values for the specified field.
GetKeywordsSorted	Gets an alphabetically sorted list of valid keywords or values for dependent fields for a certain field.
GetName	Gets the name of the category in the specified language.
GetTableFields	Returns an array of TheCategoryField objects that are part of the specified table field.
IsAutoAppendField	Returns whether or not the specified field is an auto append field.
Load	Loads the category definition from the Therefore™ server.
LoadForEdit	Loads the category definition from the Therefore™ server for editing.
MoveField	Moves the field to a tab or from a tab to the main part of the dialog.
SaveChanges	Saves the changes made on the category definition.
SetCurrentLCID	Sets the currently used LCID.
SetDescription	Sets the description of the category for the specified language.
SetName	Sets the name of the category for the specified language.
SetSubCtgryFieldIx	Sets the number of a TheCategoryField object that is used as the subcategory index data field.
SetWatermarkDocNo	Sets the document number that is used for watermarks.
Unlock	Removes the object lock from the category definition on the Therefore™ server.