Interface IITModule
The main object that provides the API methods available to scripting.
Properties
list
Methods
list
Properties
Application
An object that provides Application level API methods
Declaration
Application: IApplication;
Property Value
batch
The IBatch object of the current INode
Declaration
Property Value
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
Property Value
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
Property Value
job
The IJob object of the current INode
Declaration
Property Value
node
Declaration
Property Value
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
Property Value
RpcService
Object that provides access to RPC operations executed on the core or HTML services.
Declaration
Property Value
Methods
clearHighlights()
Remove all highlights previously installed by highlightZone
Declaration
Returns
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
getControl(name)
Gets a control that is in a Custom Form.
Declaration
getControl(name: string): any;
Parameters
| Type |
Name |
Description |
| string |
name |
|
Returns
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
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
removeHighlight(highlightHandle)
Declaration
removeHighlight(highlightHandle: any): void;
Parameters
| Type |
Name |
Description |
| any |
highlightHandle |
|
Returns
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
|