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 Class

Scroll

TheCategory represents the definition of an Therefore™ category loaded from a data base table on the server.

Data includes:

bullet Category number and name

bullet Data base table information

bullet Field numbers, types and names

bullet Watermark information

bullet Dialog layout information

Namespace: Therefore.API

Name	Description
AutoAppendMode	Gets the auto append mode for this category.
BackgroundColor	Gets or sets the background color of the category dialog.
BelongsToCaseDefinition	Gets the unique identifier of the case definition the category belongs to.
CheckInCommentsMode	Gets or sets the Check-in Comments Mode for the current category.
CoverMode	Gets or sets the cover sheet mode for the current category.
CtgryNo	Gets the number of the current category.
Description	Gets or sets the description of the current category.
DocumentPreview	Gets or sets whether or not document previews are shown in Navigator.
DocumentTitleLength	Gets or sets the length of the document title.
EmptyDocMode	Gets or sets the empty document mode for the current category.
FieldCount	Gets the number of category fields in the current category.
FolderNo	Gets or sets the number of the folder containing the current category.
FullTextDate	Gets or sets the date limit for the full-text indexing.
FullTextMode	Gets or sets the full text mode for the current category.
GUID	Gets the GUID of the category.
Height	Gets or sets the height of the category dialog.
IsFullTextEnabled	Returns whether or not the full text search on this category is enabled.
Name	Gets or sets the name of the category.
NewVersionOnIndexDataChange	Gets or sets if changes on the index data in this category generates a new document version or not.
QueryTemplateNo	Gets the number of the query template (if one is associated with the current category).
SubCtgryFieldIx	Gets the sub category field index (if the current category has a sub category field).
TableName	Gets the name of the date base table containing the definition for the current category.
Title	Gets the title of the current category.
Version	Gets the version number of the current category.
WatermarkDocNo	Gets the document number of the watermark image.
WatermarkHPos	Gets or sets the horizontal position of the watermark image.
WatermarkMode	Gets or sets the watermark mode.
WatermarkResolution	Gets or sets the resolution of the watermark image in dots per inch (dpi).
WatermarkVPos	Gets or sets the vertical position of the watermark image.
Width	Gets or sets the width of the category dialog.
WorkflowFolder	Gets the full path of the Microsoft® Exchange public folder (if Microsoft® Exchange workflow is enabled for the current category).
WorkflowForm	Gets the name of the Microsoft® Exchange form (if Microsoft® Exchange workflow is enabled for the current category).
WorkflowProcessNo	Gets or sets the process number of the associated workflow process (only for Therefore™ integrated workflow) a new workflow instance will be started in when a new document has been archived.
WorkflowProcessNoUpdate	Gets or sets the process number of the associated workflow process (only for Therefore™ integrated workflow) a new workflow instance will be started in when a document has been changed.

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.