What HTMLAPI functions are provided?
HTMLAPI.getElementbyName
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
Element Name |
String |
Mandatory |
|
|
Index |
Integer |
Optional |
0 |
|
|
|
|
|
Returns: A reference to the HTML element or null if not found.
HTMLAPI.getElementbyLocation
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
Row |
Integer |
Mandatory |
|
|
Column |
Integer |
Mandatory |
|
|
|
|
|
|
Returns: A reference to the HTML element or null if not found.
HTMLAPI.getElementsinRowRange
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
Low Row |
Integer |
Mandatory |
|
|
High Row |
Integer |
Optional |
Low Row |
|
|
|
|
|
Returns: An array of references to the HTML elements.
HTMLAPI.getElementsinColumnRange
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
Low Column |
Integer |
Mandatory |
|
|
High Column |
Integer |
Optional |
Low Column |
|
|
|
|
|
Returns: An array of references to the HTML elements.
HTMLAPI.showElement
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
HTML element |
HTML element reference |
Mandatory |
|
|
|
|
|
|
Returns: null.
HTMLAPI.hideElement
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
HTML element |
HTML element reference |
Mandatory |
|
|
|
|
|
|
Returns: null.
HTMLAPI.hideRow
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
Row number |
Integer |
Mandatory |
|
|
|
|
|
|
Returns: null.
HTMLAPI.insertImage
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
HTML element that image is to be inserted after |
HTML element reference |
Mandatory |
|
|
Image source |
String |
Mandatory |
|
|
Click event handler |
Function |
Optional |
null |
|
Image height |
Integer |
Optional |
Image’s own height |
|
Image width |
Integer |
Optional |
Image’s own width |
|
Horizontal offset |
Integer |
Optional |
2 |
|
Vertical offset |
Integer |
Optional |
0 |
|
|
|
|
|
Returns: Reference to the HTML element created or null in error situations elements.
HTMLAPI.applyFont
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
HTML element to which font is to be applied |
HTML element reference |
Mandatory |
|
|
Font Family |
String |
Mandatory |
|
|
Font Size |
String |
Mandatory |
|
|
|
|
|
|
Returns: null.
HTMLAPI.getcontainerDIV
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
HTML element whose absolutely positioned container DIV is to found |
HTML element reference |
Mandatory |
|
|
|
|
|
|
Returns: Reference to the absolutely positioned container DIV or null if not found.
HTMLAPI.stripTrailingDots
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
HTML element from which dots are to be stripped |
HTML element reference |
Mandatory |
|
Returns: null.
HTMLAPI.insertSubFileScrollers
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
Page up image to use |
String |
Optional |
Null |
|
Page up click handler |
Function |
Optional |
Null |
|
Page Down image to use |
String |
Optional |
Null |
|
Page Down click handler |
Function |
Optional |
Null |
|
Images Height |
Integer |
Optional |
12 |
|
Images Width |
Integer |
Optional |
12 |
|
Horizontal offset |
Integer |
Optional |
0 |
|
Vertical offset |
Integer |
Optional |
0 |
|
|
|
|
|
Returns: null.
HTMLAPI. adjustSubFileHeadings
Parameters:
| Description | Type | Optional/Mandatory | Default Value |
|
Font to use |
String |
Optional |
Lucida Console |
|
Font Size |
String |
Optional |
8pt |
|
Background Color |
String |
Optional |
Buttonface |
|
Text Alignment |
String |
Optional |
center |
|
Border Style |
String |
Optional |
1px solid darkgray |
|
|
|
|
|
Returns: null.