DocumentInfo Class

Class representing a document to be added.

Definition

Namespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.1.0.0
C#
public class DocumentInfo
Inheritance
Object    DocumentInfo
Derived

Constructors

DocumentInfoInitializes a new instance of the DocumentInfo class

Properties

AutoFilingScriptToUse Name of the auto-filing script to use in order to determine the destination folder. Optional. When specified, the FolderId and AutoFilingTemplateId properties are ignored.
AutoFilingTemplateId Id of the auto-filing template to use in order to determine the destination folder. Optional. When specified, the FolderId property is ignored.
CreatedDate Custom date to override original created date. Optional.
DocumentName Document name. Required.
DocumentNumber Value of the Document number control field. Required if document schema uses a document number control field.
DocumentSchemaId Document schema ID. Required.
DocumentSchemaType Format of the document (electronic, record or offline). It should ony be set to a non-null value if the document should have a different format than the default format for the document schema, and the appropriate format conversion is enabled in general FileHold settings.
FieldsWithValues Array of metadata values. Required; may be empty if schema has no associated metadata. Values of read-only fields must match their initial value unless the user has permission to modify read-only fields.
FolderId Destination folder ID. Required unless an auto-filing script or template is used.
OriginalFileName Original file name. Required unless document is an offline document.
SendEmailToMembers Send email notification to folder members. Optional.
SnapshotId Snapshot to add the document to. Optional.
UploadToken Upload token of the document in repository. Required unless document is an offline document.
VersionNumber Value of the version number control field. Optional.

Extension Methods

See Also