ImportedDocument Class |
Details of a pending or imported document associated with the importation job.
Inheritance HierarchySystemObject
FileHold.LibraryManager.ModelsIndirectDocumentBase
FileHold.LibraryManager.ModelsImportedDocument
FileHold.LibraryManager.ModelsIndirectDocumentBase
FileHold.LibraryManager.ModelsImportedDocument
Namespace: FileHold.LibraryManager.Models
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
SyntaxC#
public class ImportedDocument : IndirectDocumentBase
The ImportedDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ImportedDocument | Initializes a new instance of the ImportedDocument class |
Properties| Name | Description | |
|---|---|---|
 | ApprovalDate | (Inherited from IndirectDocumentBase.) |
| ApprovalStatus | (Inherited from IndirectDocumentBase.) |
| AutoDelete |
If true, the document is deleted after import.
|
| AutoFilingScript |
Name of the auto-filing script to use for importation.
|
| AutoFilingTemplateId | |
| CreatedDate | (Inherited from IndirectDocumentBase.) |
| DateCompleted |
Date and time when the document was imported.
|
| DateQueued |
Date and time when the document was added to the queue.
|
| DCN | (Inherited from IndirectDocumentBase.) |
| DocumentName | (Inherited from IndirectDocumentBase.) |
| DocumentSchemaId |
Identifier of the document schema.
|
| ErrorLog |
Detailed error information for failed import.
|
| Id |
Identifier of the pending or imported document.
|
| ImportType | (Inherited from IndirectDocumentBase.) |
| IsOffline |
If true, document is added to the library as Offline. Calculated base on schema type.
|
| JobId |
Identifier of the import job to which belongs document.
|
| Metadata |
Metadata values in the same format as for AddDocumentInfo.
|
| MetadataVersionId |
Metadata version id of the document in the library. Only valid for successfully imported documents.
|
| Owner | (Inherited from IndirectDocumentBase.) |
| QuickSearchName | (Inherited from IndirectDocumentBase.) |
| SchemaName |
Name of the document schema. Only used when retrieving details of document.
|
| SchemaType |
Use it to change default format of imported document.
|
| SourceFile |
Name of the indirect metadata source file.
|
| SourcePath |
Source path of the document in the file system.
|
| SourcePathShort |
Shortened version of the SourcePath property. For WatchedFolder and WatchedFtpSite job types it has got removed part of source folder. For other types it is the same like SourcePath.
|
| Status |
Status of the document.
|
| TargetFolderId |
Identifier of the target folder in FileHold library.
|
| TargetLocation |
Name of the cabinet, drawer and folder. Only used when retrieving details of document.
|
| UseAutoFiling | |
| VCN | (Inherited from IndirectDocumentBase.) |
| VersionKey | (Inherited from IndirectDocumentBase.) |
| VersionKeyType | (Inherited from IndirectDocumentBase.) |
| VersionSequence | (Inherited from IndirectDocumentBase.) |
Methods| Name | Description | |
|---|---|---|
| ValidateControlNumbers |
Extension Methods| Name | Description | |
|---|---|---|
 | ConvertT | (Defined by ObjectExtension.) |
| ToJson | (Defined by ObjectExtension.) |
See Also