API Reference |
Scroll |
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.
Core |
Cases and Documents |
Queries |
Security |
Workflow |
|
|
Worker |
Data |
Collection |
|
Name |
Description |
TheApplication contains a variety of utility methods that do not fit into any specific class. |
|
TheCase represents and Thereforeā¢ case containing one or more Thereforeā¢ documents. All meta information for the case is contained in the IndexData member. |
|
TheCaseDefinition represents the definition of a Thereforeā¢ case loaded from a data base table on the server. |
|
TheCaseHistory is a list of TheCaseHistoryEntry objects. |
|
TheCaseHistoryEntry represents an entry in the Thereforeā¢ case history. |
|
TheCategory represents the definition of an Thereforeā¢ category loaded from a data base table on the server. |
|
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 represents a field in an TheCategory. |
|
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 contains the properties of formatting fields on certain Conditions. |
|
The TheConditionalFormattingList class contains a list of TheConditionalFormatting objects. |
|
TheConditionalFormattingResult contains the result of fields formatted by their Conditions. |
|
The TheConditionalFormattingResultList class is returned by EvaluateConditionalFormatting and contains a list of results of field calculations. |
|
As the name suggests, an TheConditionList is a linked list of TheCondition objects. |
|
TheConversionOptions is used to convert files to PDF or TIFF. |
|
TheDeletedObject represents one item in the TheDeletedObjectList returned by an TheRecycleBinQuery. |
|
TheDeletedObjectList represents the result of a successful TheRecycleBinQuery as a table exposed as an array of TheDeletedObject items. |
|
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. |
|
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. |
|
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 represents the display properties of TheCategoryField objects. |
|
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 is a list of TheDocumentHistoryEntry objects and can be used for loading the history of a document. |
|
TheDocumentHistoryEntry represents an entry in the Thereforeā¢ document history. |
|
Contains additional meta data information of a Thereforeā¢ document. |
|
Contains information about the retention date of a Thereforeā¢ document. |
|
The TheFieldCalculationResult class is returned by CalculateFields and contains the result of the field calculations. |
|
TheFieldCalculationResultItem contains the result of calculated field values. |
|
TheFieldValidator can be used to check if a value is valid for a certain index data field. |
|
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. |
|
An event raised by an Thereforeā¢ client application (Capture, Navigator, Viewer, ...). Thereforeā¢ events can be handed by registered Thereforeā¢ AddIns. |
|
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 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 represents a folder in the Thereforeā¢ directory structure. |
|
TheFolderItem represents an item within an TheFolder. This item can be e.g. a category, a query, a document or a workflow instance. |
|
As the name suggests, TheFolderItemList is a list of TheFolderItem objects. |
|
As the name suggests, TheFolderList is a list of TheFolder objects. |
|
TheFullTextQuery searches the contents of Thereforeā¢ documents in one or more categories using information gathered by the Thereforeā¢ indexing service. |
|
TheFullTextQueryResult represents the result of a successful TheFullTextQuery as a table exposed as an array of TheFullTextQueryResultRow items. |
|
TheFullTextQueryResultRow represents one row in the TheFullTextQueryResult returned by an TheFullTextQuery. |
|
TheIndexData maintains all meta information for an TheDocument. It contains a map of {string key, object value} pairs. |
|
A list of TheIndexData objects. |
|
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. |
|
Represents a keyword element of a keyword dictionary. |
|
As the name suggests, TheKeywordDictionary is a list of TheKeyword objects. |
|
Contains information about an object that is linked to a Thereforeā¢ document. |
|
A list of TheLinkedObject items. |
|
A top, sub or context menu in an Thereforeā¢ application (Capture, Navigator, Viewer, ...). |
|
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 is the result of an TheMultiQuery. It contains a list of TheQueryResult items, one for every category we have searched. |
|
A generic list of objects returned by TheIndexData.GetKeywords and TheCategory.GetKeywords. |
|
ThePDFPrinter class can be used to modify document that are printed directly to Thereforeā¢ by using the Thereforeā¢ PDF Printer. |
|
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. |
|
As the name suggests, ThePairList is a list of ThePair objects. |
|
TheQuery is used for searching and finding information within one category in the data base. Three different query modes are offered. |
|
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. |
|
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 searches the deleted Thereforeā¢ documents and cases. |
|
TheReferencedTable represents a data type referencing a table in the database. |
|
TheReferencedTableColumn represents a column of a TheReferencedTable. |
|
TheReportDefinition represents the definition of a report or a report template. |
|
TheReportExecution is used to execute an existing report definition on the report server. |
|
TheReportParameter represents a parameter for a report. |
|
As the name suggests, TheReportParameterList is a list of TheReportParameter objects. |
|
Represents a retention policy that is used for deleting documents. |
|
As the name suggests, TheRetentionPolicyList is a list of TheRetentionPolicy objects. |
|
Represents the definition of an Thereforeā¢ role used for permission management. |
|
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. |
|
Represents a assignment of a role to a user on one Thereforeā¢ object. |
|
A type-safe container for TheRoleAssignment objects used to load and change role assignments on any supported object. |
|
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 controls and manages all queries and transactions to and from the Thereforeā¢ server and the database. |
|
As the name suggests, the TheStringList is a linked list of strings. |
|
TheTabInfo represents a tab of a tab control field in an TheCategory. |
|
As the name suggests, TheTabInfoList is a list of TheTabInfo objects. |
|
TheTableDataType maintains all index information for a table field. |
|
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 is used for working with a task. |
|
TheTaskQuery is used to create a query for tasks. |
|
The result set returned by a TheTaskQuery object. |
|
The TheUser class contains information about a user in Thereforeā¢ and/or the active directory. |
|
As the name suggests, the TheUserList is a linked list of TheUser items. |
|
TheWFChecklistItem represents an item in a checklist. It can be either checked or unchecked and can be assigned to an TheWFTask. |
|
TheWFChoice represents a workflow choice. It represents a user and belongs to a TheWFTask. |
|
TheWFDocument represents a linked workflow document. |
|
TheWFHistoryEntry represents an entry in the Thereforeā¢ workflow history. |
|
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 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. |
|
As the name suggests, the TheWFInstanceInfoList is a linked list of TheWFInstanceInfo items. |
|
TheWFProcess represents the definition of an Thereforeā¢ workflow process loaded from a data base table on the server. |
|
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 represents a transition from one TheWFTask to another. |
Name |
Description |
Defines how index data values should be merged when auto appending a document. |
|
This is available but documentation is pending. Please contact support@therefore.net for information. |
|
Identifier for command buttons in the TheCategoryDialog. |
|
It is possible to clear the server cache with TheServer.ClearCacheInfo(). |
|
Option flags for the TheApplication.CaptureArchive method. |
|
Option flags for the TheApplication.CaptureScan method. |
|
Types of entries in the case history. |
|
Data types contained and/or accepted by TheCategoryField objects. |
|
Check-in modes available for a Thereforeā¢ Category. |
|
Type of the client of an TheServer object. |
|
Option for user license handling when connecting a Thereforeā¢ Server. |
|
Identifies the conversion file format. |
|
The counter mode for counter fields. |
|
The dependency mode of a user defined data type. This describes a category field setting for user defined data types. |
|
Error code descriptions. |
|
Type identifier for TheEvent instances handled by an ITheAddIn implementation. |
|
Description of return values for field calculations. |
|
Describes the rights on index data fields. |
|
Option for the TheFullTextQuery, controlling if and how context information is returned with the TheFullTextQueryResult. |
|
Property of the TheCategory class. |
|
Option for the TheFullTextQuery, controlling the sort order of the TheFullTextQueryResult. |
|
Option controlling if and how the provided folder array is filled when requesting objects from the TheServer. |
|
Flags to (un)select various parts of the TheIndexData of an TheDocument. |
|
These internal values are used to define additional document meta data for searching and sorting in a search execution. |
|
This is available but documentation is pending. Please contact support@therefore.net for information. |
|
Types of linked objects. |
|
Flags for the TheApplication.NavigatorFind method. |
|
Types of Thereforeā¢ objects. |
|
The status of a print job. |
|
Modes for TheQuery and TheMultiQuery. |
|
The output file format of a report. |
|
The template type of a Report. |
|
Describes the target type for the retention calculation. |
|
Describes the status of the retention calculation. |
|
Used for menu and context menu items to determine under which selection conditions they are enabled/disabled. |
|
Signature modes for The ConversionOptions. |
|
Signature status of TheDocument. |
|
Used for menu and context menu items to determine under which selection conditions they are enabled/disabled. |
|
The decision made for a task. These values are connected to the TheTaskMode values. |
|
The different task modes change some texts in the user interface. |
|
The query mode as it can be seen in the Tasks view in TheNavigator. |
|
The view mode as can be seen in the Tasks ribbon bar in TheNavigator. |
|
The status of the task. |
|
Type group for category fields. |
|
Flags determining which types of users and/or user groups are returned in a user query. |
|
Types of Thereforeā¢ users. |
|
The type of link to the workflow instance. |
|
Types of entries in the workflow history. |
|
Types of workflow tasks. |
|
Flags determining which workflow processes are considered in a workflow query. |