Show / Hide Table of Contents
  • BC HTML Api reference
    • html-api
      • AnnotationArrowOrientation
      • AnnotationTextAlignment
      • AnnotationTextFontFamily
      • BarcodeOrientation
      • BarcodeThresholdMode
      • BarcodeType
      • BatchEnums
        • Mode
        • Queue
      • CallContext
      • DbClient
      • DbServer
      • FileMimeType
      • FileType
      • IAnnotation
      • IAnnotationProperties
      • IApplication
      • IBarcodeData
      • IBaseControl
      • IBatch
      • IBatchClass
      • IButton
      • ICheckBox
      • IComboBox
      • ICustomThemeConfig
      • IDocument
      • IDocumentClass
      • IField
      • IFieldValidation
      • IFileInfo
      • IFolder
      • IFolderClass
      • IFormType
      • IGroup
      • IIndexClass
      • IITModule
      • IJob
      • ILabel
      • ILicenseGroup
      • IListItem
      • IListView
      • ImageColorMode
      • ImageOperationType
      • INode
      • INodeComment
      • INodeReviewComment
      • INuanceEngineConfig
      • IOCRConfiguration
      • IPage
        • Side
      • IRadioButton
      • IRecognitionProfile
      • IRectangle
      • IRegexValidation
      • IScanProfile
      • ITable
      • ITabView
      • ITextBox
      • IthConfig
      • ITitledPanel
      • IUser
      • LevelName
      • NodeReviewStatus
      • NuanceEngine
      • NuanceLanguage
      • NuanceMode
      • PageSideMode
      • RecognitionEngine
      • RpcService
      • ScanService
      • ScanSource
      • ScriptActionType
      • ScriptResultConsts
      • ScriptResultProp
      • UnloadReason

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
INode

Properties list

formType formTypeName
Inherited Properties
allNodes
batch
childCount
children
documentCount
documents
fields
folderCount
folders
id
indexClass
job
jobName
levelIndex
levelName
name
nodeIndex
pageCount
pages
parent
properties
reviewComments
stackCount
stacks
typeName
userObject
uuid

Methods list

getFormType() getFormTypeName() getFormTypes() setFormType(formType) splitFolder() treatedAsReadOnly()
Inherited Methods
add(newChild)
assignDefaultValuesToEmptyIndexFields(doChildren)
deleteProperty(name)
duplicate()
evaluate(expression)
executeDbActions(onMultipleResultsUseFirst)
getAllNodes()
getBatch()
getChildCount()
getChildren()
getDocumentCount()
getDocuments()
getField(name)
getFields()
getFieldsAsList()
getFieldValue(field)
getFieldValues(field)
getFolderCount()
getFolders()
getId()
getIndexClass()
getIndexClasses()
getJob()
getJobName()
getLevelIndex()
getLevelName()
getName()
getNodeIndex()
getPageCount()
getPages()
getParent()
getProperties()
getProperty(name)
getReviewComments()
getStackCount()
getStacks()
getTable(name)
getTypeName()
getUserObject()
getUuid()
insert(newChild, childIndex)
isAtLeastOneFieldEmptyOrInvalid(checkRequiredFieldsOnly)
isNodeRejected(checkChildren)
merge(target, childIndex)
removeAllChildren()
removeFromParent()
setIndexClass(indexClass)
setProperty(name, value, deleteIfEmpty)
setUserObject(userObject)

Properties

formType

see IDocument.getFormType(), IDocument.setFormType()

Declaration
formType: IFormType;
Property Value
Type Description
IFormType

formTypeName

see IDocument.getFormTypeName()

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()

context
returns a java.util.List\<IFormType\> instead of IFormType[]
context
returns a java.util.List\<IFormType\> instead of IFormType[]
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
Back to top Generated by DocFX