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 IITModule

The main object that provides the API methods available to scripting.

Properties list

Application batch debug document err folder job node out page RpcService

Methods list

clearHighlights() createDBServer(dbName) getControl(name) highlightZone(left, top, width, height, pageIndex, options) refreshIndexingView() removeHighlight(highlightHandle) showDBResultPicker(res, columnNames, title)

Properties

Application

An object that provides Application level API methods

Declaration
Application: IApplication;
Property Value
Type Description
IApplication

batch

The IBatch object of the current INode

Declaration
batch: IBatch;
Property Value
Type Description
IBatch

debug

An object with methods that print to the console the given message(s) as DEBUG level messages

Declaration
debug: {
        println: (messages: any[]) => void;
        print: (messages: any[]) => void;
    };
Property Value
Type Description
{ println: (messages: any[]) => void; print: (messages: any[]) => void; }

document

The IDocument object of the current INode

Declaration
document: IDocument;
Property Value
Type Description
IDocument

err

An object with methods that print to the console the given message(s) as ERROR level messages

Declaration
err: {
        println: (messages: any[]) => void;
        print: (messages: any[]) => void;
    };
Property Value
Type Description
{ println: (messages: any[]) => void; print: (messages: any[]) => void; }

folder

The IFolder object of the current INode

Declaration
folder: IFolder;
Property Value
Type Description
IFolder

job

The IJob object of the current INode

Declaration
job: IJob;
Property Value
Type Description
IJob

node

The current INode

Declaration
node: INode;
Property Value
Type Description
INode

out

An object with methods that print to the console the given message(s) as INFO level messages

Declaration
out: {
        println: (messages: any[]) => void;
        print: (messages: any[]) => void;
    };
Property Value
Type Description
{ println: (messages: any[]) => void; print: (messages: any[]) => void; }

page

The IPage object of the current INode

Declaration
page: IPage;
Property Value
Type Description
IPage

RpcService

Object that provides access to RPC operations executed on the core or HTML services.

Declaration
RpcService: RpcService;
Property Value
Type Description
RpcService

Methods

clearHighlights()

Remove all highlights previously installed by highlightZone

Declaration
clearHighlights(): void;
Returns
Type Description
void

createDBServer(dbName)

This creates a new object that provides access to methods that allow executing queries on system pre-configured datasources.

A pre-configured datasource name must be provided.

Declaration
createDBServer(dbName: string): DbServer;
Parameters
Type Name Description
string dbName
Returns
Type Description
DbServer

getControl(name)

Gets a control that is in a Custom Form.

Declaration
getControl(name: string): any;
Parameters
Type Name Description
string name
Returns
Type Description
any

highlightZone(left, top, width, height, pageIndex, options)

Highlights the specified rectangle in the active image viewer. If a page is supplied and is valid it switches the viewer to this page first. The highlights produced are ephemeral i.e. if the user switches to another page on the viewer terminates indexing they go away (much like field zone indications).

Declaration
highlightZone(left: number, top: number, width: number, height: number, pageIndex: any, options: HighlightZoneOptions): any;
Parameters
Type Name Description
number left
number top
number width
number height
any pageIndex
HighlightZoneOptions options
Returns
Type Description
any

refreshIndexingView()

Refreshes the indexing form to display any updated state. This should be run after any node, property or form change.

Declaration
refreshIndexingView(): void;
Returns
Type Description
void

removeHighlight(highlightHandle)

Removes the highlight

Declaration
removeHighlight(highlightHandle: any): void;
Parameters
Type Name Description
any highlightHandle
Returns
Type Description
void

showDBResultPicker(res, columnNames, title)

Displays the given array in a dialog with a table for the end user to select one.

Declaration
showDBResultPicker(res: Array<Array<any>>, columnNames: Array<string>, title: string): Promise<number>;
Parameters
Type Name Description
Array<Array<any>> res
Array<string> columnNames
string title
Returns
Type Description
Promise<number>

the index number of the row that the user has selected

Back to top Generated by DocFX