Interface IDocument
Represents a Document within a Batch in the ImageTrust system.
Note: Write-access to properties depends on the context in which the model is used. When in a read-only context, set* methods will throw an UnmodifiableException.
Inheritance
Properties list
Inherited Properties
Methods list
Inherited Methods
Properties
formType
Declaration
formType: IFormType;
Property Value
| Type | Description |
|---|---|
| IFormType |
formTypeName
Declaration
readonly formTypeName: string;
Property Value
| Type | Description |
|---|---|
| string |
Methods
getFormType()
the IFormType of the document, null if none is assigned
Declaration
getFormType(): IFormType;
Returns
| Type | Description |
|---|---|
| IFormType |
getFormTypeName()
the name of the IFormType this document uses, null if none.
Declaration
getFormTypeName(): string;
Returns
| Type | Description |
|---|---|
| string |
getFormTypes()
Declaration
getFormTypes(): IFormType[];
Returns
| Type | Description |
|---|---|
| IFormType[] | an array of available IFormType for this document. The array of available IFormType comes from the job that this document belongs to. |
setFormType(formType)
Sets the IFormType of the document. To get a list of available form types, use the IDocument.getFormTypes() method.
Declaration
setFormType(formType: IFormType): any;
Parameters
| Type | Name | Description |
|---|---|---|
| IFormType | formType |
the form type |
Returns
| Type | Description |
|---|---|
| any |
splitFolder()
Splits the folder that this document belongs to in two folders so as the second folder contains this document as its first document.
Declaration
splitFolder(): IFolder;
Returns
| Type | Description |
|---|---|
| IFolder | the new folder |
treatedAsReadOnly()
Returns true if this Document has been created from a read-only file (e.g. a signed PDF).
Declaration
treatedAsReadOnly(): boolean;
Returns
| Type | Description |
|---|---|
| boolean |