Therefore Programming Interface 3.0

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

TheIndexDataList

A list of TheIndexData objects.

Name	Description
CalculateFields	Triggers the field calculation for the current index data object.
Clear	Clears the specified index data parts.
ClearAll	Clears all parts of the index data.
CopyFrom	Copies an index data object.
EditIxData	Displays the Therefore™ Index Data dialog and lets the user edit values. If no category is assigned to the document, this function will first call SelectCtgry and then display the dialog.
EvaluateConditionalFormatting	Evaluates the format conditions for all fields and returns the result.
FillAutoAppendFields	Prepares the index data object for automated auto append processing.
FillDependentFields	If user-defined data types are used (foreign tables) this function will lookup all referenced entries in foreign tables and fill in the dependent fields.
FillDependentFieldsEx	If user-defined data types are used (foreign tables) this function will lookup all referenced entries in foreign tables and fill in the dependent fields.
GetAutoAppendIxData	Gets the index data object from the existing document.
GetEnumerator	Returns an enumerator for this list.
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.
GetTableValueByFieldNo	Gets the value of the field with the specified FieldNo.
GetTableValueByIndexDataFieldName	Gets the value of the field with the specified index data field name.
GetTitle	Returns the document title.
GetValueByCaption	Gets the value of the index data field with the specified caption.
GetValueByColName	Gets the value of the index data field with the specified database column name.
GetValueByFieldID	Gets the value of the index data field with the specified field ID.
GetValueByFieldNo	Gets the value of the index data field with the specified field number.
GetValueByIndex	Gets the value of the index data field with the specified index.
GetValueByIndexDataFieldName	Gets the value of the index data field with the specified name.
Load	Loads index data from the Therefore™ server using the number of the associated document.
ResetToCategoryDefaults	Resets all index data values to the default values if there is one for the field.
RetrieveDocument	Retrieves and returns the TheDocument for the current DocNo and Category.
SaveChanges	Saves changes made to the IndexData object to the database without incrementing the version number.
SetCaseDefinition	Overloaded. Sets the case definition for the index data.
SetCategory	Overloaded. Sets the category for the document.
SetTableValueByFieldNo	Sets the table object for the specified FieldNo.
SetTableValueByIndexDataFieldName	Sets the field with the specified index data field name to the specified value.
SetKeywordByIndexDataFieldName	Sets value for a keyword field with the specified name.
SetKeywordByColName	Sets value for a keyword field with the specified database column name.
SetKeywordByCaption	Sets value for a keyword field with the specified caption.
SetKeywordByFieldNo	Sets value for a keyword field with the specified field number.
SetKeywordByIndex	Sets value for a keyword field with the specified index.
SetValueByCaption	Sets the value of the index data field with the specified caption.
SetValueByColName	Sets the value of the index data field with the specified database column name.
SetValueByFieldID	Sets the value of the index data field with the specified field ID.
SetValueByFieldNo	Sets the value of the index data field with the specified field number.
SetValueByIndex	Sets the value of the index data field with the specified index.
SetValueByIndexDataFieldName	Sets the value of the index data field with the specified name.
ShowIndexDataReadOnly
ToString	Returns a string representation of the object (for debugging).

Name	Description
AutoAppendInViewer
AutoAppendMode
CaseDefinition	Gets or sets the case definition of the associated TheDocument.
CaseNo	Gets or sets the case number of the associated TheCase.
Category	Gets or sets the category of the associated TheDocument.
Count	Gets the number number of entries in the index data map.
CtgryName	Gets or sets the name of the category the associated TheDocument belongs to.
CtgryNo	Gets or sets the number of the category the associated TheDocument belongs to.
DocNo	Gets or sets the document number of the associated TheDocument.
FieldNames	Gets an TheEnumerable object allowing you to iterate through the field names (i.e. the string keys) of the index data map.
Item	Gets or sets the ThePair item with the specified index.
LastChangeTime	Gets or sets the timestamp when the index data was changed.
Title	Gets or sets the title of the document.
Values	Gets an TheEnumerable object allowing you to iterate through the values of the index data map.
VersionNo	Gets or sets the version number of the associated TheDocument.