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 IFolder

Represents a Folder 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

folderClassName
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

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

folderClassName

see IFolder.getFolderClassName()

Declaration
readonly folderClassName: string;
Property Value
Type Description
string

Methods

getFolderClassName()

Returns the name of the Folder Class for this Folder object.

Declaration
getFolderClassName(): string;
Returns
Type Description
string

the name of the Folder Class

Back to top Generated by DocFX