Therefore Programming Interface 3.0

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

API Reference

The API Reference provides detailed descriptions of all classes, methods, properties and enumerations in the Therefore™ Application Programming Interface (API).

Classes can be categorized in two ways: by problem area and by type.

Name	Description
TheApplication	TheApplication contains a variety of utility methods that do not fit into any specific class.
TheCase	TheCase represents and Therefore™ case containing one or more Therefore™ documents. All meta information for the case is contained in the IndexData member.
TheCaseDefinition	TheCaseDefinition represents the definition of a Therefore™ case loaded from a data base table on the server.
TheCaseHistory	TheCaseHistory is a list of TheCaseHistoryEntry objects.
TheCaseHistoryEntry	TheCaseHistoryEntry represents an entry in the Therefore™ case history.
TheCategory	TheCategory represents the definition of an Therefore™ category loaded from a data base table on the server.
TheCategoryDialog	Category dialog used for query specification and index data assignment in Capture, Navigator and Viewer. This class is currently only used in the AddIn event system and does not provide methods to load and show the dialog in custom applications.
TheCategoryField	TheCategoryField represents a field in an TheCategory.
TheCategoryFieldRights
TheCondition	TheCondition represents a boolean test to the value of an TheCategoryField. When defining a new TheQuery you may add one or more TheCondition objects to the TheConditionList exposed through the TheQuery.Conditions property.
TheConditionalFormatting	TheConditionalFormatting contains the properties of formatting fields on certain Conditions.
TheConditionalFormattingList	The TheConditionalFormattingList class contains a list of TheConditionalFormatting objects.
TheConditionalFormattingResult	TheConditionalFormattingResult contains the result of fields formatted by their Conditions.
TheConditionalFormattingResultList	The TheConditionalFormattingResultList class is returned by EvaluateConditionalFormatting and contains a list of results of field calculations.
TheConditionList	As the name suggests, an TheConditionList is a linked list of TheCondition objects.
TheConversionOptions	TheConversionOptions is used to convert files to PDF or TIFF.
TheDeletedObject	TheDeletedObject represents one item in the TheDeletedObjectList returned by an TheRecycleBinQuery.
TheDeletedObjectList	TheDeletedObjectList represents the result of a successful TheRecycleBinQuery as a table exposed as an array of TheDeletedObject items.
TheDependentFieldsQuery	TheDependentFieldsQuery is used for searching and finding information within one category field with dependent fields like single keywords and referenced table fields in the data base.
TheDependentFieldsQueryResult	The TheDependentFieldsQueryResult class represents the result of an TheDependentFieldsQuery as a table. It exposes the table as an array of TheDependentFieldsQueryResultRow items. All contained data is read-only.
TheDependentFieldsQueryResultRow	The TheDependentFieldsQueryResultRow is a row within a TheDependentFieldsQueryResult table, the result of a successful TheDependentFieldsQuery execution. It exposes its values as an array of Object (Variant in some languages) items.
TheDisplayProperties	TheDisplayProperties represents the display properties of TheCategoryField objects.
TheDocument	TheDocument represents and Therefore™ compound file containing one or more document streams (e.g. a Word document and a PDF). The class provides various methods for adding, removing and extracting streams. All meta information for the document is contained in the IndexData member.
TheDocumentHistory	TheDocumentHistory is a list of TheDocumentHistoryEntry objects and can be used for loading the history of a document.
TheDocumentHistoryEntry	TheDocumentHistoryEntry represents an entry in the Therefore™ document history.
TheDocumentProperties	Contains additional meta data information of a Therefore™ document.
TheDocumentRetentionInfo	Contains information about the retention date of a Therefore™ document.
TheFieldCalculationResult	The TheFieldCalculationResult class is returned by CalculateFields and contains the result of the field calculations.
TheFieldCalculationResultItem	TheFieldCalculationResultItem contains the result of calculated field values.
TheFieldValidator	TheFieldValidator can be used to check if a value is valid for a certain index data field.
TheEnumerable	TheEnumerable is a generic, read-only data class that can be iterated with the For-Each statement. The FieldNames and Values properties of TheIndexData, for example, return an TheEnumerable to allow their client to iterate index data keys and values separately.
TheEvent	An event raised by an Therefore™ client application (Capture, Navigator, Viewer, ...). Therefore™ events can be handed by registered Therefore™ AddIns.
TheEventSet	A set of TheEventType items. When implementing ITheAddIn.GetHandledEvents AddIn classes add the event types they wish to receive to the provided TheEventSet instance.
TheFieldList	TheFieldList is a linked list of field numbers (as integers). It also maintains a reference to the Category containing the field numbers which it uses to add and find fields by their column name.
TheFolder	TheFolder represents a folder in the Therefore™ directory structure.
TheFolderItem	TheFolderItem represents an item within an TheFolder. This item can be e.g. a category, a query, a document or a workflow instance.
TheFolderItemList	As the name suggests, TheFolderItemList is a list of TheFolderItem objects.
TheFolderList	As the name suggests, TheFolderList is a list of TheFolder objects.
TheFullTextQuery	TheFullTextQuery searches the contents of Therefore™ documents in one or more categories using information gathered by the Therefore™ indexing service.
TheFullTextQueryResult	TheFullTextQueryResult represents the result of a successful TheFullTextQuery as a table exposed as an array of TheFullTextQueryResultRow items.
TheFullTextQueryResultRow	TheFullTextQueryResultRow represents one row in the TheFullTextQueryResult returned by an TheFullTextQuery.
TheIndexData	TheIndexData maintains all meta information for an TheDocument. It contains a map of {string key, object value} pairs.
TheIndexDataList	A list of TheIndexData objects.
TheIntArray	As the name suggests, the TheIntArray class is a type-safe array of integers. The array automatically grows when items are added beyond the current capacity.
TheKeyword	Represents a keyword element of a keyword dictionary.
TheKeywordDictionary	As the name suggests, TheKeywordDictionary is a list of TheKeyword objects.
TheLinkedObject	Contains information about an object that is linked to a Therefore™ document.
TheLinkedObjectList	A list of TheLinkedObject items.
TheMenu	A top, sub or context menu in an Therefore™ application (Capture, Navigator, Viewer, ...).
TheMultiQuery	TheMultiQuery is used for searching and finding information across multiple categories with potentially different field selections, orders and conditions. Execution returns an TheMultiQueryResult, a list of TheQueryResult tables.
TheMultiQueryResult	TheMultiQueryResult is the result of an TheMultiQuery. It contains a list of TheQueryResult items, one for every category we have searched.
TheObjectList	A generic list of objects returned by TheIndexData.GetKeywords and TheCategory.GetKeywords.
ThePDFPrinter	ThePDFPrinter class can be used to modify document that are printed directly to Therefore™ by using the Therefore™ PDF Printer.
ThePair	ThePair represents a key-value pair in a map, hashtable or similar data structure. For ThePair the Key is always a string while the Value can be any object. ThePair is used for accessing and iterating TheIndexData entries.
ThePairList	As the name suggests, ThePairList is a list of ThePair objects.
TheQuery	TheQuery is used for searching and finding information within one category in the data base. Three different query modes are offered.
TheQueryResult	The TheQueryResult class represents the result of an TheQuery in one category as a table. It exposes the table as an array of TheQueryResultRow items. All contained data is read-only.
TheQueryResultRow	The TheQueryResultRow is a row within a TheQueryResult table, the result of a successful TheQuery execution. It exposes its values as an array of Object (Variant in some languages) items.
TheRecycleBinQuery	TheRecycleBinQuery searches the deleted Therefore™ documents and cases.
TheReferencedTable	TheReferencedTable represents a data type referencing a table in the database.
TheReferencedTableColumn	TheReferencedTableColumn represents a column of a TheReferencedTable.
TheReportDefinition	TheReportDefinition represents the definition of a report or a report template.
TheReportExecution	TheReportExecution is used to execute an existing report definition on the report server.
TheReportParameter	TheReportParameter represents a parameter for a report.
TheReportParameterList	As the name suggests, TheReportParameterList is a list of TheReportParameter objects.
TheRetentionPolicy	Represents a retention policy that is used for deleting documents.
TheRetentionPolicyList	As the name suggests, TheRetentionPolicyList is a list of TheRetentionPolicy objects.
TheRole	Represents the definition of an Therefore™ role used for permission management.
TheRoleAccessMask	Contains functionality to combine permissions to an access mask as well as to remove permissions from it and to check if an access mask contains a specific permission.
TheRoleAssignment	Represents a assignment of a role to a user on one Therefore™ object.
TheRoleAssignments	A type-safe container for TheRoleAssignment objects used to load and change role assignments on any supported object.
TheRolePermission	The TheRolePermission class is a replacement for the old ThePermissionConstants class which is outdated because the change to role based security required changes in the permission values. This class consists of read only properties only and each one of them represents a permission in Therefore™.
TheServer	TheServer controls and manages all queries and transactions to and from the Therefore™ server and the database.
TheStringList	As the name suggests, the TheStringList is a linked list of strings.
TheTabInfo	TheTabInfo represents a tab of a tab control field in an TheCategory.
TheTabInfoList	As the name suggests, TheTabInfoList is a list of TheTabInfo objects.
TheTableDataType	TheTableDataType maintains all index information for a table field.
TheTask	TheTask represents the task definition of a task. The task definition is used to create a new task or to change details of a task.
TheTaskInfo	TheTaskInfo is used for working with a task.
TheTaskQuery	TheTaskQuery is used to create a query for tasks.
TheTaskQueryResult	The result set returned by a TheTaskQuery object.
TheUser	The TheUser class contains information about a user in Therefore™ and/or the active directory.
TheUserList	As the name suggests, the TheUserList is a linked list of TheUser items.
TheWFChecklistItem	TheWFChecklistItem represents an item in a checklist. It can be either checked or unchecked and can be assigned to an TheWFTask.
TheWFChoice	TheWFChoice represents a workflow choice. It represents a user and belongs to a TheWFTask.
TheWFDocument	TheWFDocument represents a linked workflow document.
TheWFHistoryEntry	TheWFHistoryEntry represents an entry in the Therefore™ workflow history.
TheWFInstance	TheWFInstance represents an instance of an Therefore™ workflow process. It maintains task sequences, transitions and document links. It can be claimed an unclaimed by a user and controls task completion and delegation.
TheWFInstanceInfo	TheWFInstanceInfo contains basic information about the workflow instance. This is only for informational purposes and hence this class has no methods. To process a workflow please use the TheWFInstance class.
TheWFInstanceInfoList	As the name suggests, the TheWFInstanceInfoList is a linked list of TheWFInstanceInfo items.
TheWFProcess	TheWFProcess represents the definition of an Therefore™ workflow process loaded from a data base table on the server.
TheWFTask	TheWFTask represents a task in an TheWFInstance. It maintains process, task name, type, version and duration information and contains a list of TheWFChoice items.
TheWFTransition	TheWFTransition represents a transition from one TheWFTask to another.

Name	Description
TheAutoAppendIdxMerge	Defines how index data values should be merged when auto appending a document.
TheAutoAppendMode	This is available but documentation is pending. Please contact support@therefore.net for information.
TheButtonID	Identifier for command buttons in the TheCategoryDialog.
TheChacheInfoType	It is possible to clear the server cache with TheServer.ClearCacheInfo().
TheCaptureArchiveFlags	Option flags for the TheApplication.CaptureArchive method.
TheCaptureScanFlags	Option flags for the TheApplication.CaptureScan method.
TheCaseHistoryEntryType	Types of entries in the case history.
TheCategoryFieldType	Data types contained and/or accepted by TheCategoryField objects.
TheCheckInCommentsMode	Check-in modes available for a Therefore™ Category.
TheClientType	Type of the client of an TheServer object.
TheConnectMode	Option for user license handling when connecting a Therefore™ Server.
TheConversionType	Identifies the conversion file format.
TheCounterMode	The counter mode for counter fields.
TheDependencyMode	The dependency mode of a user defined data type. This describes a category field setting for user defined data types.
TheErrorCode	Error code descriptions.
TheEventType	Type identifier for TheEvent instances handled by an ITheAddIn implementation.
TheFieldCalculationResultStatus	Description of return values for field calculations.
TheFieldRights	Describes the rights on index data fields.
TheFullTextContext	Option for the TheFullTextQuery, controlling if and how context information is returned with the TheFullTextQueryResult.
TheFullTextMode	Property of the TheCategory class.
TheFullTextSortOrder	Option for the TheFullTextQuery, controlling the sort order of the TheFullTextQueryResult.
TheGetObjectFlags	Option controlling if and how the provided folder array is filled when requesting objects from the TheServer.
TheIndexDataPart	Flags to (un)select various parts of the TheIndexData of an TheDocument.
TheIntQueryField	These internal values are used to define additional document meta data for searching and sorting in a search execution.
TheLevelFunction	This is available but documentation is pending. Please contact support@therefore.net for information.
TheLinkedObjectType	Types of linked objects.
TheNavigatorFindFlags	Flags for the TheApplication.NavigatorFind method.
TheObjectType	Types of Therefore™ objects.
ThePrintingStatus	The status of a print job.
TheQueryMode	Modes for TheQuery and TheMultiQuery.
TheReportFormat	The output file format of a report.
TheReportType	The template type of a Report.
TheRetentionStartDate	Describes the target type for the retention calculation.
TheRetentionStatus	Describes the status of the retention calculation.
TheSelectionType	Used for menu and context menu items to determine under which selection conditions they are enabled/disabled.
TheSignatureMode	Signature modes for The ConversionOptions.
TheSignatureStatus	Signature status of TheDocument.
TheSortOrder	Used for menu and context menu items to determine under which selection conditions they are enabled/disabled.
TheTaskDecision	The decision made for a task. These values are connected to the TheTaskMode values.
TheTaskMode	The different task modes change some texts in the user interface.
TheTaskQueryMode	The query mode as it can be seen in the Tasks view in TheNavigator.
TheTaskViewMode	The view mode as can be seen in the Tasks ribbon bar in TheNavigator.
TheTaskStatus	The status of the task.
TheTypeGroup	Type group for category fields.
TheUserQueryFlags	Flags determining which types of users and/or user groups are returned in a user query.
TheUserType	Types of Therefore™ users.
TheWFDocLinkType	The type of link to the workflow instance.
TheWFHistoryEntryType	Types of entries in the workflow history.
TheWFTaskType	Types of workflow tasks.
TheWorkflowFlags	Flags determining which workflow processes are considered in a workflow query.