IQDocument Class |
Inheritance HierarchyNamespace: Informa.ImageQuest.API.Library
Assembly: Informa.ImageQuest.API.Library (in Informa.ImageQuest.API.Library.dll) Version: 14.3.0.0
SyntaxThe IQDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IQDocument |
Create a new ImageQuest document.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | Id |
Unique identifier for this document.
|
| Metadata |
Set of index metadata value associated with this document.
|
RemarksAll documents in the ImageQuest system consist of two elements: the backing file (often call the "image", although there is no requirement that it be an image file), and the index metadata. This class supplies the API consumer application with the index metadata for a given document, and the unique identifier needed to retrieve the backing file.
In addition to the user-defined attributes that appear on a document, there is a set of system attributes that are always available to any document, which are assigned values automatically and should not be altered. The set of attributes available this way are:
| Attribute Name | Attribute Value |
|---|---|
| CreateDateTime | Indicates the date and time the document was added to ImageQuest |
| Deleted | Indicates if a document has been marked deleted. |
| DocumentType | Indicates the type of document (read/write) |
| EnteredBy | Indicates the name of the user that created the document. |
| FileID | Specifies the internal backing file's unique identifier. |
| FileType | Indicates the type of data contained in the backing file. |
| PageCount | Indicates the total number of pages in the backing file (read/write) |
See Also