Click or drag to resize

IDocument Interface

Interface to metadata for a document

Namespace:  EdaIntegrationContract.Document
Assembly:  EdaIntegration.Contract (in EdaIntegration.Contract.dll) Version: 7.6
Syntax
C#
public interface IDocument

The IDocument type exposes the following members.

Properties
  NameDescription
Public propertyCompositeName
A concatenated value used to describe the location of a document within its container.
Public propertyCompressedSize
The compressed size of the native file (in bytes) if it was contained within certain archive types (e.g. not populated for 7zip items).
Public propertyContainerPath
If the file was originally contained within a container, e.g. .zip file or .pst, this is the path to the file's location within the container.
Public propertyCustodian
The custodian responsible for the document.
Public propertyDateFilterLowerBound
For emails, this field contains the sent date of the message. For calendar / appointment items, this holds the appointment start date and time. For e-documents, the earlier of the two dates found in the creation and last modified fields (within the internal document metadata (if available)) is used.
Public propertyDateFilterUpperBound
For emails, this field contains the sent date of the message. For calendar / appointment items, this holds the appointment end date and time. For e-documents, the latest of the two dates found in the creation and last modified fields (within the internal document metadata (if available)) is used.
Public propertyDecrypted
Indicates if the native file was password protected but able to be decrypted during import.
Public propertyDedupeStatus
Indicates if the document was identified as a duplicate of another document in the case during Analysis. See DeduplicationStatus for possible values.
Public propertyDirectory
The path to the original folder/location of the native file. For each item that originated in a mail store, the Directory will list the path to the mail store.
Public propertyDocumentType
The type of document that this represents, e.g. Email or EDocument.
Public propertyEDocMetadata
Metadata specific to non-email documents. For Email documents this will be Null.
Public propertyEmailMetadata
Metadata specific to Email documents. For non-email documents this will be Null.
Public propertyEncrypted
Indicates if the native file was password protected and unable to be decrypted.
Public propertyFamilyParentId
The unique identifier of the "family parent" document, i.e. the "top" document in the document family
Public propertyFileName
The filename of the native file.
Public propertyFileType
A numeric representation of the native file type (provided by third-party file identification engine).
Public propertyFileTypeDescription
A textual description of native file type (provided by third-party file identification engine).
Public propertyFileUri
Used internally by the system to retrieve mail store items for exporting and viewing native files, e.g. (Lotus Notes email): note-id://D2D09967C7679B3E8625711400748A11.
Public propertyHasAttachments
Indicates whether the document has attachments.
Public propertyHash
The MD5 or SHA-1 hash of the email or edocument, depending on the Deduplication Mode setting at the time of import.
Public propertyId
The unique identifier for the document.
Public propertyImported
The date/time that the file was imported into the case.
Public propertyImportSet
The document's import session.
Public propertyInventoryId
The internal numeric identifier for the document.
Public propertyIsArchiveItem
Indicates whether the native file was contained with an archive (e.g. 7zip) when imported into the case.
Public propertyIsAttachment
Indicates whether the native file was an attachment of another document.
Public propertyIsCompound
Indicates whether the native file is a "compound document" (contains embedded files).
Public propertyIsCompoundChild
Indicates whether the native file was embedded inside another document (the parent document would have IsCompound set to True).
Public propertyIsEmailAttachment
Indicates whether the native file was an attachment of an email.
Public propertyIsTextStoredOnDisk
Indicates if the text of the document is being returned in the Text or if the text was stored on disk. If it is on disk then the TextLocation will contain the path the file.
Public propertyLevel
A numeric representation of the depth of the document within its container. For example, a PST file might be level 0, an email in the PST level 1, an attachment to an email in the PST level 2, etc.
Public propertyMimeType
Information about the content of the file extracted from the header of emails (with the exception of MS Outlook items) and e-documents. Not all e-documents contain this information.
Public propertyParentId
The unique identifier (Id) of the immediate parent document in the parent-child relationship hierarchy, e.g. parent doc or mail store.
Public propertyPassword
The password used to decrypt the native file during import.
Public propertySize
The size of the native file in bytes.
Public propertySource
The source of the document.
Public propertySourceDocumentId
The unique identifier (Id) of the top-level document in the parent-child relationship hierarchy, e.g. parent doc or mail store.
Public propertySourceFile
The full path to the native file. If the file was in a container then the full path to the top-most container is returned.
Public propertyText
The text of the document extracted during Analysis or OCR. If the text was stored on disk (IsTextStoredOnDisk) then this value will be null.
Public propertyTextLocation
The full path to the location of the document text if it was stored on disk. If the text was not stored on disk (IsTextStoredOnDisk) then this value will be null.
Public propertyTextSize
Size of the extracted or OCR text (in bytes).
Top
See Also