Get the current value of a window attribute.
| Name | Data Type | Description |
|---|---|---|
| Attribute Name | text | The name of the attribute to get. |
The internal ID for this action is 'GetWindowIdentifier'
Works with the following element types:
Get the current value of an Active Accessibility attribute.
| Name | Data Type | Description |
|---|---|---|
| Attribute Name | text | The name of the attribute to get. |
The internal ID for this action is 'GetAAIdentifier'
Works with the following element types:
Get the current value of an HTML attribute.
| Name | Data Type | Description |
|---|---|---|
| Attribute Name | text | The name of the attribute to get. |
The internal ID for this action is 'GetHTMLIdentifier'
Works with the following element types:
Get the current value of a Java Access Bridge attribute.
| Name | Data Type | Description |
|---|---|---|
| Attribute Name | text | The name of the attribute to get. |
The internal ID for this action is 'GetJABIdentifier'
Works with the following element types:
Get the current value of a UI Automation attribute.
| Name | Data Type | Description |
|---|---|---|
| Attribute Name | text | The name of the attribute to get. |
The internal ID for this action is 'GetUIAIdentifier'
Works with the following element types:
Gets information about the bounding rectangle of the element, in coordinates relative to the parent.
This action takes no parameters
The internal ID for this action is 'GetElementBounds'
Works with the following element types:
Gets information about the bounding rectangle of the element, in coordinates relative to the parent.
This action takes no parameters
The internal ID for this action is 'GetRelativeElementBounds'
Works with the following element types:
Gets information about the bounding rectangle of the element, in screen coordinates.
This action takes no parameters
The internal ID for this action is 'GetElementScreenBounds'
Works with the following element types:
Gets information about the bounding rectangle of the element, in coordinates relative to the parent.
This action takes no parameters
The internal ID for this action is 'RegionGetElementBounds'
Works with the following element types:
'''Global action''' - the target application must have focus.
Gets information about the bounding rectangle of the element, in coordinates relative to the parent.
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
The internal ID for this action is 'ListRegionGetElementBounds'
Works with the following element types:
'''Global action''' - the target application must have focus.
Gets information about the bounding rectangle of the element, in coordinates relative to the parent.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
The internal ID for this action is 'GridRegionGetElementBounds'
Works with the following element types:
'''Global action''' - the target application must have focus.
Gets information about the bounding rectangle of the element, in screen coordinates.
This action takes no parameters
The internal ID for this action is 'RegionGetElementScreenBounds'
Works with the following element types:
'''Global action''' - the target application must have focus.
Gets information about the bounding rectangle of the element, in screen coordinates.
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
The internal ID for this action is 'ListRegionGetElementScreenBounds'
Works with the following element types:
'''Global action''' - the target application must have focus.
Gets information about the bounding rectangle of the element, in screen coordinates.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
The internal ID for this action is 'GridRegionGetElementScreenBounds'
Works with the following element types:
'''Global action''' - the target application must have focus.
Send a click message to the window at the specified position. The position is relative to the top left of the window.
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to click, relative to the window |
| Y | number | The Y coordinate of the point at which to click, relative to the window |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'ClickWindow'
Works with the following element types:
Send a click message to the centre of the window.
| Name | Data Type | Description |
|---|---|---|
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'ClickWindowCentre'
Works with the following element types:
Click the element at the specified position, using a global mouse click. The position is relative to the top left of the element's bounding rectangle. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to click, relative to the window |
| Y | number | The Y coordinate of the point at which to click, relative to the window |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'MouseClick'
Works with the following element types:
'''Global action''' - the target application must have focus.
Double click the element at the specified position, using a global mouse click. The position is relative to the top left of the element's bounding rectangle. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to click, relative to the window |
| Y | number | The Y coordinate of the point at which to click, relative to the window |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'MouseDoubleClick'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the element at its centre, using a global mouse click.
| Name | Data Type | Description |
|---|---|---|
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'MouseClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Double click the element at its centre, using a global mouse click.
| Name | Data Type | Description |
|---|---|---|
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'MouseDoubleClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the region at the specified position, using a global mouse click. The position is relative to the top left of the region. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to click, relative to the window |
| Y | number | The Y coordinate of the point at which to click, relative to the window |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'RegionMouseClick'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the region at the specified position, using a global mouse click. The position is relative to the top left of the region. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
| X | number | The X coordinate of the point at which to click, relative to the window |
| Y | number | The Y coordinate of the point at which to click, relative to the window |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'ListRegionMouseClick'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the region at the specified position, using a global mouse click. The position is relative to the top left of the region. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
| X | number | The X coordinate of the point at which to click, relative to the window |
| Y | number | The Y coordinate of the point at which to click, relative to the window |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'GridRegionMouseClick'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the region at its centre, using a global mouse click. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'RegionMouseClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the region at its centre, using a global mouse click. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'ListRegionMouseClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the region at its centre, using a global mouse click. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'GridRegionMouseClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the parent window of the region at the centre of the region.
This action takes no parameters
The internal ID for this action is 'RegionParentClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the parent window of the region at the centre of the region.
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
The internal ID for this action is 'ListRegionParentClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the parent window of the region at the centre of the region.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
The internal ID for this action is 'GridRegionParentClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Start a drag-drop operation by dragging from the centre of the region. Must be followed by a drop operation on another element.
This action takes no parameters
The internal ID for this action is 'RegionStartDrag'
Works with the following element types:
'''Global action''' - the target application must have focus.
Start a drag-drop operation by dragging from the centre of the region. Must be followed by a drop operation on another element.
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
The internal ID for this action is 'ListRegionStartDrag'
Works with the following element types:
'''Global action''' - the target application must have focus.
Start a drag-drop operation by dragging from the centre of the region. Must be followed by a drop operation on another element.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
The internal ID for this action is 'GridRegionStartDrag'
Works with the following element types:
'''Global action''' - the target application must have focus.
End a drag-drop operation by dropping onto the region, at its centre. Must be preceded by a drag operation on another element.
This action takes no parameters
The internal ID for this action is 'RegionDropOnto'
Works with the following element types:
'''Global action''' - the target application must have focus.
End a drag-drop operation by dropping onto the region, at its centre. Must be preceded by a drag operation on another element.
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
The internal ID for this action is 'ListRegionDropOnto'
Works with the following element types:
'''Global action''' - the target application must have focus.
End a drag-drop operation by dropping onto the region, at its centre. Must be preceded by a drag operation on another element.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
The internal ID for this action is 'GridRegionDropOnto'
Works with the following element types:
'''Global action''' - the target application must have focus.
Start dragging from a given position over the window
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to start dragging, relative to the window |
| Y | number | The Y coordinate of the point at which to start dragging, relative to the window |
The internal ID for this action is 'Drag'
Works with the following element types:
'''Global action''' - the target application must have focus.
Drop at the given position over the window - must follow a drag
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to perform the drop, relative to the window |
| Y | number | The Y coordinate of the point at which to perform the drop, relative to the window |
The internal ID for this action is 'Drop'
Works with the following element types:
'''Global action''' - the target application must have focus.
Start dragging the listview item with the specified text
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the listview item to be dragged. If not unique, then the first matching item found will be dragged. |
The internal ID for this action is 'DragItem'
Works with the following element types:
'''Global action''' - the target application must have focus.
Drop onto the listview item with the specified text - must follow a drag
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the listview item onto which the drop should be performed. If not unique, then the first matching item found will be chosen. |
The internal ID for this action is 'DropOntoItem'
Works with the following element types:
'''Global action''' - the target application must have focus.
Asks a window to close.
This action takes no parameters
The internal ID for this action is 'CloseWindow'
Works with the following element types:
Focuses an HTML element.
This action takes no parameters
The internal ID for this action is 'HTMLFocus'
Works with the following element types:
Press a button
This action takes no parameters
The internal ID for this action is 'Press'
Works with the following element types:
'''Global action''' - the target application must have focus.
Set the contents of a terminal field
| Name | Data Type | Description |
|---|---|---|
| Text | text | The new text to be entered into the field. |
The internal ID for this action is 'SetField'
Works with the following element types:
Read the contents of a terminal field
This action takes no parameters
The internal ID for this action is 'GetField'
Works with the following element types:
Search the whole terminal for instances of the given text. Case insensitive.
| Name | Data Type | Description |
|---|---|---|
| Text | text | The text to search for. |
The internal ID for this action is 'SearchTerminal'
Works with the following element types:
Gets the row/column position of the cursor in the presentation space
This action takes no parameters
The internal ID for this action is 'GetMainframeCursorPos'
Works with the following element types:
Sets the row/column position of the cursor in the presentation space
| Name | Data Type | Description |
|---|---|---|
| Row Index | number | The 1-based index of the row at which the cursor should be located. This value must not exceed the number of rows available. |
| Column Index | number | The 1-based index of the column at which the cursor should be located. This value must not exceed the number of columns available. |
The internal ID for this action is 'SetMainframeCursorPos'
Works with the following element types:
Gets the title of the window in which the terminal emulator resides
This action takes no parameters
The internal ID for this action is 'GetMainframeParentWindowTitle'
Works with the following element types:
Sets the title of the window in which the terminal emulator resides
| Name | Data Type | Description |
|---|---|---|
| New Title | text | The new title of the mainframe emulator window. |
The internal ID for this action is 'SetMainframeParentWindowTitle'
Works with the following element types:
Runs the specified macro defined on the emulator instance
| Name | Data Type | Description |
|---|---|---|
| Macro Name | text | The name of the macro to be run, only. File paths are not supported. |
The internal ID for this action is 'RunMainframeMacro'
Works with the following element types:
Set the windowtext for a window.
| Name | Data Type | Description |
|---|---|---|
| Text | text | The new text to be sent to the window. |
The internal ID for this action is 'SetText'
Works with the following element types:
Read text using OCR from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Language | text | The Tesseract language code to use. Default is 'eng'. |
| Page Segmentation Mode | text | The Tesseract page segmentation mode to use. Default is 'Auto'. |
| Character Whitelist | text | Whitelist of characters to recognise. |
| Diagnostics Path | text | Optional. Can be used to specify a directory where diagnostics files will be saved - e.g. intermediate processed images. |
| Scale | number | Set the internal image scale factor. Default is 4. |
The internal ID for this action is 'ReadTextOCR'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using OCR from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
| Language | text | The Tesseract language code to use. Default is 'eng'. |
| Page Segmentation Mode | text | The Tesseract page segmentation mode to use. Default is 'Auto'. |
| Character Whitelist | text | Whitelist of characters to recognise. |
| Diagnostics Path | text | Optional. Can be used to specify a directory where diagnostics files will be saved - e.g. intermediate processed images. |
| Scale | number | Set the internal image scale factor. Default is 4. |
The internal ID for this action is 'ListReadTextOCR'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using OCR from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
| Language | text | The Tesseract language code to use. Default is 'eng'. |
| Page Segmentation Mode | text | The Tesseract page segmentation mode to use. Default is 'Auto'. |
| Character Whitelist | text | Whitelist of characters to recognise. |
| Diagnostics Path | text | Optional. Can be used to specify a directory where diagnostics files will be saved - e.g. intermediate processed images. |
| Scale | number | Set the internal image scale factor. Default is 4. |
The internal ID for this action is 'GridReadTextOCR'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text discovered using invasive techniques within a rectangular area of a window
This action takes no parameters
The internal ID for this action is 'GetText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text discovered using invasive techniques within a rectangular area of a window
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
The internal ID for this action is 'ListGetText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text discovered using invasive techniques within a rectangular area of a window
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
The internal ID for this action is 'GridGetText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text discovered values. The text was found based on the centre of the text being contained within the specified region within the window. (Method used: Invasive)
This action takes no parameters
The internal ID for this action is 'GetTextCenter'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text discovered values. The text was found based on the centre of the text being contained within the specified region within the window. (Method used: Invasive)
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
The internal ID for this action is 'ListGetTextCenter'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text discovered values. The text was found based on the centre of the text being contained within the specified region within the window. (Method used: Invasive)
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
The internal ID for this action is 'GridGetTextCenter'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Font | text | The name of the font to use. Default is 'System'. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
The internal ID for this action is 'RecogniseText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
| Font | text | The name of the font to use. Default is 'System'. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
The internal ID for this action is 'ListRecogniseText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
| Font | text | The name of the font to use. Default is 'System'. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
The internal ID for this action is 'GridRecogniseText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window, which is known to represent a single line of text.
| Name | Data Type | Description |
|---|---|---|
| Font | text | The name of the font to use. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
The internal ID for this action is 'RecogniseSingleLineText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window, which is known to represent a single line of text.
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
| Font | text | The name of the font to use. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
The internal ID for this action is 'ListRecogniseSingleLineText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window, which is known to represent a single line of text.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
| Font | text | The name of the font to use. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
The internal ID for this action is 'GridRecogniseSingleLineText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window, which is known to represent more than one line of text.
| Name | Data Type | Description |
|---|---|---|
| Font | text | The name of the font to use. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
| Erase Blocks | flag | Optional; default False. Set to True to automatically detect and erase coloured blocks surrounding text, such as a highlighted selection in a listview. |
The internal ID for this action is 'RecogniseMultiLineText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window, which is known to represent more than one line of text.
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
| Font | text | The name of the font to use. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
| Erase Blocks | flag | Optional; default False. Set to True to automatically detect and erase coloured blocks surrounding text, such as a highlighted selection in a listview. |
The internal ID for this action is 'ListRecogniseMultiLineText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window, which is known to represent more than one line of text.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
| Font | text | The name of the font to use. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
| Erase Blocks | flag | Optional; default False. Set to True to automatically detect and erase coloured blocks surrounding text, such as a highlighted selection in a listview. |
The internal ID for this action is 'GridRecogniseMultiLineText'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Font | text | The name of the font to use. Default is 'System'. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
| Split Lines | flag | True to split each subregion into lines before matching. Default: False |
| Use Original Algorithm | flag | True to use the backwards compatible algorithm for reading characters which scans across then down. Default: False |
| Erase Blocks | flag | Optional; default False. Set to True to automatically detect and erase coloured blocks surrounding text, such as a highlighted selection in a listview. |
The internal ID for this action is 'ReadChars'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
| Font | text | The name of the font to use. Default is 'System'. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
| Split Lines | flag | True to split each subregion into lines before matching. Default: False |
| Use Original Algorithm | flag | True to use the backwards compatible algorithm for reading characters which scans across then down. Default: False |
| Erase Blocks | flag | Optional; default False. Set to True to automatically detect and erase coloured blocks surrounding text, such as a highlighted selection in a listview. |
The internal ID for this action is 'ListReadChars'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
| Font | text | The name of the font to use. Default is 'System'. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
| Split Lines | flag | True to split each subregion into lines before matching. Default: False |
| Use Original Algorithm | flag | True to use the backwards compatible algorithm for reading characters which scans across then down. Default: False |
| Erase Blocks | flag | Optional; default False. Set to True to automatically detect and erase coloured blocks surrounding text, such as a highlighted selection in a listview. |
The internal ID for this action is 'GridReadChars'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read image from a rectangular area on a window
This action takes no parameters
The internal ID for this action is 'ReadBitmap'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read image from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
The internal ID for this action is 'ListReadBitmap'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read image from a rectangular area on a window
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
The internal ID for this action is 'GridReadBitmap'
Works with the following element types:
'''Global action''' - the target application must have focus.
Read text using character matching from a series of rectangular areas on a window, which are known to represent a single line of text.
| Name | Data Type | Description |
|---|---|---|
| First Element | number | The first element in the list region to read. Default is 1 |
| Last Element | number | The last element in the list region to read. Default is 1 |
| Split Lines | flag | True to split each subregion into lines before matching. Default: False |
| Font | text | The name of the font to use. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
| Erase Blocks | flag | Optional; default False. Set to True to automatically detect and erase coloured blocks surrounding text, such as a highlighted selection in a listview. |
The internal ID for this action is 'ListReadCharsInRange'
Works with the following element types:
'''Global action''' - the target application must have focus.
Reads the text in each cell defined in the grid region.
| Name | Data Type | Description |
|---|---|---|
| Split Lines | flag | True to split each subregion into lines before matching. Default: False |
| Font | text | The name of the font to use. |
| Colour | text | The text colour, e.g. FF0000. Default is black. |
| Background Colour | text | Optional. Used to specify the background colour against which the text is set. If used, the colour of the text must not be specified. Input format must be a six-character hex sequence specifying the background colour, e.g. FF0000. |
| Erase Blocks | flag | Optional; default False. Set to True to automatically detect and erase coloured blocks surrounding text, such as a highlighted selection in a listview. |
The internal ID for this action is 'GridReadTable'
Works with the following element types:
'''Global action''' - the target application must have focus.
Get a collection of conflicting character groups. Each row contains a string under the 'Character Group' field, representing a group of characters whose appearance is identical within the font of interest.
| Name | Data Type | Description |
|---|---|---|
| Font | text | The name of the font of interest. |
The internal ID for this action is 'GetConflictingFontCharacters'
Works with the following element types:
Get the text for a window
This action takes no parameters
The internal ID for this action is 'GetWindowText'
Works with the following element types:
Get the text for a region's Win32 parent control/window
This action takes no parameters
The internal ID for this action is 'GetRegionWindowText'
Works with the following element types:
Indicates whether a window is the active window - the window which receives user input
This action takes no parameters
The internal ID for this action is 'IsWindowActive'
Works with the following element types:
Reads the 'checked' value from a checkbox, radio button, etc
This action takes no parameters
The internal ID for this action is 'GetChecked'
Works with the following element types:
Reads the 'checked' value from a checkbox, radio button, etc
This action takes no parameters
The internal ID for this action is 'NetGetChecked'
Works with the following element types:
Show the dropdown list on a combobox or menu
This action takes no parameters
The internal ID for this action is 'ShowDropdown'
Works with the following element types:
Hide the dropdown list on a combobox or menu
This action takes no parameters
The internal ID for this action is 'HideDropdown'
Works with the following element types:
Read the text of a java element
This action takes no parameters
The internal ID for this action is 'JABGetText'
Works with the following element types:
Read the selected text of a java element
This action takes no parameters
The internal ID for this action is 'JABGetSelectedText'
Works with the following element types:
Select a portion of the text in an editable java element
| Name | Data Type | Description |
|---|---|---|
| Start Position | number | The one-based start index of the text to be selected. This must be within the range of available characters. |
| Length | number | The number of characters to be selected. This must be within the range of available characters, relative to the specified start position. |
The internal ID for this action is 'JABSelectText'
Works with the following element types:
Select all of the text in an editable java element
This action takes no parameters
The internal ID for this action is 'JABSelectAllText'
Works with the following element types:
Reads the 'checked' value from a java checkbox, radio button, toggle button, etc
This action takes no parameters
The internal ID for this action is 'JABGetChecked'
Works with the following element types:
Writes the 'checked' value to a java checkbox, radio button, toggle button, etc
This action takes no parameters
The internal ID for this action is 'JABSetChecked'
Works with the following element types:
Reads the 'selected' value from a java element, such as a list item, a tab page, etc
This action takes no parameters
The internal ID for this action is 'JABIsSelected'
Works with the following element types:
Reads the 'expanded' value from a java element, such as a tree node, a combo box, etc
This action takes no parameters
The internal ID for this action is 'JABIsExpanded'
Works with the following element types:
Hides the drop-down portion of a java element such as a menu, combobox, etc
This action takes no parameters
The internal ID for this action is 'JABHideDropdown'
Works with the following element types:
Shows the drop-down portion of a java element such as a menu, combobox, etc
This action takes no parameters
The internal ID for this action is 'JABShowDropdown'
Works with the following element types:
Collapse a java tree node, if it is expanded
This action takes no parameters
The internal ID for this action is 'JABCollapseTreeNode'
Works with the following element types:
Expand a java tree node, if it is expanded
This action takes no parameters
The internal ID for this action is 'JABExpandTreeNode'
Works with the following element types:
Toggles the expanded state of a java tree node, if it has children
This action takes no parameters
The internal ID for this action is 'JABToggleTreeNode'
Works with the following element types:
Selects a java item identified by its text or its position - eg from a menu dropdown, a combo box, a tab control, etc
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item to be selected. If not unique, then the first matching item found will be selected. |
| Item Position | number | The 1-based index of the item to be selected. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'JABSelectItem'
Works with the following element types:
Selects a java item identified by its text or its position - eg from a menu dropdown, a combo box, a tab control, etc
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item. Only used when no value is supplied to the Position parameter |
| Item Position | number | The 1-based index of the item. If this parameter is used then the Text parameter will be ignored |
The internal ID for this action is 'JABEnsureItemVisible'
Works with the following element types:
Selects all child items - eg in a list
This action takes no parameters
The internal ID for this action is 'JABSelectAllItems'
Works with the following element types:
Clears the selection of child items - eg in a list
This action takes no parameters
The internal ID for this action is 'JABClearSelection'
Works with the following element types:
Counts and returns the number of selected items contained in a java listview, Treeview, ListBox, etc.
This action takes no parameters
The internal ID for this action is 'JABGetSelectedItemCount'
Works with the following element types:
Gets all rows and columns (of a listview, combobox, datagrid etc) as a collection. For simple controls, the collection has a single field called 'Item Text'. For multi-column controls, the fields will be named as they are in the control, where possible - otherwise names such as 'Column1', 'Column2' will be used.
This action takes no parameters
The internal ID for this action is 'GetAllItems'
Works with the following element types:
Gets all child items of the specified item in a treeview, as a collection.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the treenode of interest. If not unique, then the first matching item will be retrieved. |
The internal ID for this action is 'GetTreenodeChildItems'
Works with the following element types:
Gets all sibling items of the specified item in a treeview, as a collection. The returned collection includes the item specified, as well as its siblings.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the treenode of interest. If not unique, then the first matching item will be retrieved. |
The internal ID for this action is 'GetTreenodeSiblingItems'
Works with the following element types:
Set the current position to a particular cell
| Name | Data Type | Description |
|---|---|---|
| Row | number | The 1-based row number |
| Column | number | The 1-based column number |
The internal ID for this action is 'GoToCell'
Works with the following element types:
Set the top visible row - this row may not actually go to the top if there are not enough rows below it.
| Name | Data Type | Description |
|---|---|---|
| Row | number | The 1-based row number |
The internal ID for this action is 'SetTopRow'
Works with the following element types:
Get the offset, in pixels, of the top of the given row from the top of the grid.
| Name | Data Type | Description |
|---|---|---|
| Row | number | The 1-based row number |
The internal ID for this action is 'GetRowOffset'
Works with the following element types:
Select a range of cells
| Name | Data Type | Description |
|---|---|---|
| Row | number | The 1-based row number |
| Column | number | The 1-based column number |
| End Row | number | The end column number |
| End Column | number | The end column number |
The internal ID for this action is 'SelectRange'
Works with the following element types:
Gets all data associated with an item, as a collection (eg every column of a listview, for the item in question).
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The main text of the item of interest (eg the text of the first column in a listview item). If not unique, then the first matching item will be retrieved. |
| Item Position | number | The 1-based index of the item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'GetItem'
Works with the following element types:
Gets all selected rows and columns (of a listview, combobox, datagrid etc) as a collection.
This action takes no parameters
The internal ID for this action is 'GetSelectedItems'
Works with the following element types:
Reads the 'selected' value from a child of the chosen element. Eg from an item in a listview, etc
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item. Only used when no value is supplied to the Position parameter |
| Item Position | number | The 1-based index of the item. If this parameter is used then the Text parameter will be ignored |
The internal ID for this action is 'IsItemSelected'
Works with the following element types:
Reads the 'checked' value from a child of the chosen element. Eg from an item in a listview, etc
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item. Only used when no value is supplied to the Position parameter |
| Item Position | number | The 1-based index of the item. If this parameter is used then the Text parameter will be ignored |
The internal ID for this action is 'IsItemChecked'
Works with the following element types:
Reads the 'expanded' value from a child of the chosen element. Eg from an item in a treeview, etc
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item. Only used when no value is supplied to the Position parameter |
| Item Position | number | The 1-based index of the item. If this parameter is used then the Text parameter will be ignored |
The internal ID for this action is 'IsItemExpanded'
Works with the following element types:
Reads the 'focused' value from a child of the chosen element. Eg from an item in a treeview, etc.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item. Only used when no value is supplied to the Position parameter |
| Item Position | number | The 1-based index of the item. If this parameter is used then the Text parameter will be ignored |
The internal ID for this action is 'IsItemFocused'
Works with the following element types:
Reads the Image Index of a child of the chosen element. Eg from an item in a listview, treeview, etc.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item. Only used when no value is supplied to the Position parameter |
| Item Position | number | The 1-based index of the item. If this parameter is used then the Text parameter will be ignored |
The internal ID for this action is 'GetItemImageIndex'
Works with the following element types:
Gets the current value (of a textbox, combobox, listview current row, checkbox, etc). The data type will be that of the calling control (eg flag for a checkbox).
This action takes no parameters
The internal ID for this action is 'ReadCurrentValue'
Works with the following element types:
Makes sure that the specified item is visible in a Listview or Treeview, by adjusting the scrollbars where necessary.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item. Only used when no value is supplied to the Index parameter |
| Item Position | number | The 1-based index of the item. If this parameter is used then the Text parameter will be ignored |
The internal ID for this action is 'EnsureItemVisible'
Works with the following element types:
Scrolls a listview to the top when in details mode.
This action takes no parameters
The internal ID for this action is 'ScrollListviewToTop'
Works with the following element types:
Scrolls a listview to the bottom when in details mode.
This action takes no parameters
The internal ID for this action is 'ScrollListviewToBottom'
Works with the following element types:
Counts and returns the number of items contained in a listview or Treeview.
This action takes no parameters
The internal ID for this action is 'GetItemCount'
Works with the following element types:
Counts and returns the number of selected items contained in a listview or Treeview.
This action takes no parameters
The internal ID for this action is 'GetSelectedItemCount'
Works with the following element types:
Gets the number of items that can be displayed on one page, in a Listview (in details mode) or a Treeview.
This action takes no parameters
The internal ID for this action is 'GetPageCapacity'
Works with the following element types:
Gets the text of the first selected item. Returns an error if no items are selected.
This action takes no parameters
The internal ID for this action is 'GetSelectedItemText'
Works with the following element types:
Expands the specified Treeview item.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the treenode to be expanded. If not unique, then the first matching node will be expanded. |
The internal ID for this action is 'ExpandTreeNode'
Works with the following element types:
Collapses the specified Treeview item.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the treenode to be collapsed. If not unique, then the first matching node will be collapsed. |
The internal ID for this action is 'CollapseTreeNode'
Works with the following element types:
Toggles the expanded state of the specified Treeview item.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the treenode to be toggled. If not unique, then the first matching node will be toggled. |
The internal ID for this action is 'ToggleTreeNode'
Works with the following element types:
Gets the numeric value of a control such as the position on a trackbar, a scrollbar, or the value in a numeric up/down control.
This action takes no parameters
The internal ID for this action is 'GetNumericValue'
Works with the following element types:
Sets the numeric value of a control such as the position on a trackbar, a scrollbar, or the value in a numeric up/down control.
| Name | Data Type | Description |
|---|---|---|
| Value | number | The new value to be set in the control. |
The internal ID for this action is 'SetNumericValue'
Works with the following element types:
Gets the maximum numeric value allowed by a control such as a trackbar, a scrollbar, or a numeric up/down control.
This action takes no parameters
The internal ID for this action is 'GetMaxNumericValue'
Works with the following element types:
Gets the minimum numeric value allowed by a control such as a trackbar, a scrollbar or a numeric up/down control.
This action takes no parameters
The internal ID for this action is 'GetMinNumericValue'
Works with the following element types:
Gets the numeric value of a control such as a java trackbar, a java scrollbar or a java numeric up/down control.
This action takes no parameters
The internal ID for this action is 'JABGetNumericValue'
Works with the following element types:
Sets the numeric value of a control such as a java trackbar, a java scrollbar or a java numeric up/down control.
| Name | Data Type | Description |
|---|---|---|
| Value | number | The new value to be set in the control. |
The internal ID for this action is 'JABSetNumericValue'
Works with the following element types:
Gets the maximum numeric value allowed by a control such as a java trackbar, a java scrollbar or a java numeric up/down control.
This action takes no parameters
The internal ID for this action is 'JABGetMaxNumericValue'
Works with the following element types:
Gets the minimum numeric value allowed by a control such as a java trackbar, a java scrollbar or a java numeric up/down control.
This action takes no parameters
The internal ID for this action is 'JABGetMinNumericValue'
Works with the following element types:
Gets the datetime value of a VB6 date picker control.
This action takes no parameters
The internal ID for this action is 'GetDTPickerDateTime'
Works with the following element types:
Gets the datetime value of a control such as a date picker.
This action takes no parameters
The internal ID for this action is 'GetDateTimeValue'
Works with the following element types:
Sets the datetime value of a control such as a date picker.
| Name | Data Type | Description |
|---|---|---|
| Value | datetime | The new value to be set in the control. |
The internal ID for this action is 'SetDateTimeValue'
Works with the following element types:
Gets the maximum allowable datetime value of a control such as a date picker.
This action takes no parameters
The internal ID for this action is 'GetMaxDateTimeValue'
Works with the following element types:
Sets the minimum allowable datetime value of a control such as a date picker.
This action takes no parameters
The internal ID for this action is 'GetMinDateTimeValue'
Works with the following element types:
Gets the maximum selected datetime value of a control such as a date picker.
This action takes no parameters
The internal ID for this action is 'GetMaxSelectedDateTimeValue'
Works with the following element types:
Gets the minimum selected datetime value of a control such as a date picker.
This action takes no parameters
The internal ID for this action is 'GetMinSelectedDateTimeValue'
Works with the following element types:
Sets a scrollbar to its minimum value - ie either the extreme left, or to the top depending on its orientation.
This action takes no parameters
The internal ID for this action is 'ScrollToMinimum'
Works with the following element types:
Sets a scrollbar to its maximum value - ie either the extreme right, or to the bottom depending on its orientation.
This action takes no parameters
The internal ID for this action is 'ScrollToMaximum'
Works with the following element types:
Adjusts the value of a scroll bar by the specified amount in pages, where one page is the size represented by the "thumb" on the scroll bar. Both positive and negative values are permitted, as well as fractional values.
| Name | Data Type | Description |
|---|---|---|
| Number of Pages | number | The number of pages to scroll. Fractional values such as '0.5' are valid as well as whole values such as '3'. A negative value indicates scrolling up/left; a positive value indicates scrolling down/right. |
The internal ID for this action is 'ScrollByAmount'
Works with the following element types:
Sets a java scrollbar to its minimum value - ie either the extreme left, or to the top depending on its orientation.
This action takes no parameters
The internal ID for this action is 'JABScrollToMinimum'
Works with the following element types:
Sets a java scrollbar to its maximum value - ie either the extreme right, or to the bottom depending on its orientation.
This action takes no parameters
The internal ID for this action is 'JABScrollToMaximum'
Works with the following element types:
Adjusts the value of a java scroll bar by the specified amount in pages, where one page is the size represented by the "thumb" on the scroll bar. Both positive and negative values are permitted, as well as fractional values.
| Name | Data Type | Description |
|---|---|---|
| Number of Pages | number | The number of pages to scroll. Fractional values such as '0.5' are valid as well as whole values such as '3'. A negative value indicates scrolling up/left; a positive value indicates scrolling down/right. |
The internal ID for this action is 'JABScrollByAmount'
Works with the following element types:
Adds the item to a multiple selection in a Windows ListBox that matches the given text.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item to be selected. If not unique, then the first matching item will be selected. |
The internal ID for this action is 'MultiSelectItem'
Works with the following element types:
Selects the item in a Windows ComboBox, ListBox, Listview or Treeview that matches the given text.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item to be selected. If not unique, then the first matching item found will be selected. |
| Item Position | number | The 1-based index of the item to be modified. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'SelectItem'
Works with the following element types:
Clicks the item in a Windows Listview that matches the given text.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item to be clicked. If not unique, then the first matching item found will be selected. |
| Item Position | number | The 1-based index of the item to be clicked. This parameter is ignored unless the 'Item Text' parameter is blank. |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'ClickItem'
Works with the following element types:
Gets the bounds of an item within a Listview, relative to the listview's top left corner.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item of interest. If not unique, then the first matching item found will be used. |
| Item Position | number | The 1-based index of the item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'GetItemBoundsAsCollection'
Works with the following element types:
Gets the bounds of an item within a Listview, in screen coordinates.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item of interest. If not unique, then the first matching item found will be used. |
| Item Position | number | The 1-based index of the item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'GetItemScreenBoundsAsCollection'
Works with the following element types:
Selects a node in a TreeView.
| Name | Data Type | Description |
|---|---|---|
| Node Text | text | The text of the node to be selected. If not unique, then the first matching item found will be selected. |
The internal ID for this action is 'SelectTreeNode'
Works with the following element types:
Clicks the item in a Windows Toolbar (or similar) that matches the given text.
| Name | Data Type | Description |
|---|---|---|
| Item Position | number | The 1-based index of the item to be clicked. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'ClickToolbarButton'
Works with the following element types:
Reads the 'enabled' value of a toolbar button.
| Name | Data Type | Description |
|---|---|---|
| Item Position | number | The 1-based index of the item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'IsToolbarButtonEnabled'
Works with the following element types:
Reads the 'checked' value of a toolbar button.
| Name | Data Type | Description |
|---|---|---|
| Item Position | number | The 1-based index of the item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'IsToolbarButtonChecked'
Works with the following element types:
Reads the 'pressed' value of a toolbar button.
| Name | Data Type | Description |
|---|---|---|
| Item Position | number | The 1-based index of the item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'IsToolbarButtonPressed'
Works with the following element types:
Selects the specified menu item from the main menu.
| Name | Data Type | Description |
|---|---|---|
| Menu Path | text | The path to the menu item of interest, as a descent through the menu tree-structure. Eg "{File}{Backup Options}{Backup Configuration}". The escape character for the special "{","}" characters is the backslash: "\". |
The internal ID for this action is 'SelectMenuItem'
Works with the following element types:
Reads the 'checked' value of a menu item.
| Name | Data Type | Description |
|---|---|---|
| Menu Path | text | The path to the menu item of interest, as a descent through the menu tree-structure. Eg "{File}{Backup Options}{Backup Configuration}". The escape character for the special "{","}" characters is the backslash: "\". |
The internal ID for this action is 'IsMenuItemChecked'
Works with the following element types:
Reads the 'enabled' value of a menu item.
| Name | Data Type | Description |
|---|---|---|
| Menu Path | text | The path to the menu item of interest, as a descent through the menu tree-structure. Eg "{File}{Backup Options}{Backup Configuration}". The escape character for the special "{","}" characters is the backslash: "\". |
The internal ID for this action is 'IsMenuItemEnabled'
Works with the following element types:
Sends a click message to a tab control, located at the centre of the specified tab.
| Name | Data Type | Description |
|---|---|---|
| Tab Text | text | The text of the tab to receive the click messages. If not unique, then the first matching tab found will be used. |
| Item Position | number | The 1-based index of the tab to be used. This parameter is ignored unless the 'Tab Text' parameter is blank. |
The internal ID for this action is 'ClickTab'
Works with the following element types:
Clicks a tab control, at the centre of the specified tab, using a global mouse click.
| Name | Data Type | Description |
|---|---|---|
| Tab Text | text | The text of the tab to be clicked. If not unique, then the first matching tab found will be used. |
| Item Position | number | The 1-based index of the tab to be clicked. This parameter is ignored unless the 'Tab Text' parameter is blank. |
The internal ID for this action is 'MouseClickTab'
Works with the following element types:
'''Global action''' - the target application must have focus.
Sets the 'checked' value of the item in a Windows Listview or Treeview that matches the given text.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item to be modified. If not unique, then the first matching item found will be used. |
| Item Position | number | The 1-based index of the item to be modified. This parameter is ignored unless the 'Item Text' parameter is blank. |
| Value | flag | A flag value indicating whether the item specified should be checked or unchecked. |
The internal ID for this action is 'SetItemChecked'
Works with the following element types:
'''Global action''' - the target application must have focus.
Selects a child item identified by its text, or by its index - eg from a menu dropdown, or a combo box, etc
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item to be selected. If not unique, then the first matching item found will be selected. |
| Item Position | number | The 1-based index of the item to be selected. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'AASelectItem'
Works with the following element types:
Counts and returns the number of items contained in an active accessibility element such as a listview, Treeview or ComboBox.
This action takes no parameters
The internal ID for this action is 'AAGetItemCount'
Works with the following element types:
Gets all rows and columns (of a listview, combobox, datagrid, listbox etc) as a collection. For simple controls, the collection has a single field called 'Item Text'. For multi-column controls, the fields will be named as they are in the control, where possible - otherwise names such as 'Column1', 'Column2' will be used.
This action takes no parameters
The internal ID for this action is 'AAGetAllItems'
Works with the following element types:
Gets all selected rows and columns (of a listview, combobox, datagrid, listbox etc) as a collection.
This action takes no parameters
The internal ID for this action is 'AAGetSelectedItems'
Works with the following element types:
Gets the text of the principal selection (of a listview, combobox, datagrid, listbox etc).
This action takes no parameters
The internal ID for this action is 'AAGetSelectedItemText'
Works with the following element types:
Reads the current value from an active accessibility element
This action takes no parameters
The internal ID for this action is 'AAGetValue'
Works with the following element types:
Reads the 'checked' value from an active accessibility checkbox, radio button, etc
This action takes no parameters
The internal ID for this action is 'AAGetChecked'
Works with the following element types:
Show the dropdown list on a combobox or menu, etc
This action takes no parameters
The internal ID for this action is 'AAShowDropdown'
Works with the following element types:
Hide the dropdown list on a combobox or menu, etc
This action takes no parameters
The internal ID for this action is 'AAHideDropdown'
Works with the following element types:
Clears the selection (of child items where appropriate) - eg in a edit field, listview, listbox, etc
This action takes no parameters
The internal ID for this action is 'ClearSelection'
Works with the following element types:
Sets the checked status of a radio button or checkbox
| Name | Data Type | Description |
|---|---|---|
| Checked | flag | The new value to be applied. |
The internal ID for this action is 'SetChecked'
Works with the following element types:
Launch the mainframe. The parameters supplied in the Application Modeller wizard may be optionally overridden in this call. To use the value supplied in the wizard, leave the corresponding parameter blank. To supply an empty string to a parameter, use an expression which represents an empty string (eg "", or use a data item with an empty value).
This action takes no parameters
The internal ID for this action is 'LaunchMainframe'
Works with the following element types:
Attach to the target mainframe.
| Name | Data Type | Description |
|---|---|---|
| Session Identifier | text | Often called the session short name this is a single letter in the range A..Z. |
The internal ID for this action is 'AttachMainframe'
Works with the following element types:
Detach from the mainframe.
This action takes no parameters
The internal ID for this action is 'DetachMainframe'
Works with the following element types:
Terminate the mainframe.
This action takes no parameters
The internal ID for this action is 'TerminateMainframe'
Works with the following element types:
Send keys to the mainframe. See the 'Mainframe Integration' help page for more details.
| Name | Data Type | Description |
|---|---|---|
| Text | text | The key-codes to be sent to the target application. |
The internal ID for this action is 'MainframeSendKeys'
Works with the following element types:
Launch the target application. The parameters supplied in the Application Modeller wizard may be optionally overridden in this call. To use the value supplied in the wizard, leave the corresponding parameter blank. To supply an empty string to a parameter, use an expression which represents an empty string (eg "", or use a data item with an empty value).
This action takes no parameters
The internal ID for this action is 'Launch'
Works with the following element types:
Attaches to an existing instance of the target application. The parameters supplied in the Application Modeller wizard may be optionally overridden in this call. To use the value supplied in the wizard, leave the corresponding parameter blank. To supply an empty string to a parameter, use an expression which represents an empty string (eg "", or use a data item with an empty value).
| Name | Data Type | Description |
|---|---|---|
| Window Titles (as Collection) | collection | Optional Parameter. A collection of different patterns designed to match any one of a number of window titles. Window title matching patterns should be contained in a field called "Window Title". A successful match amongst any of the patterns will cause the matching application to be attached. The wildcard characters "*", "?", "#" are valid, and may be escaped with a backslash character ("\"). |
| Window Title | text | Optional parameter. A pattern specifying a single window title to be matched. The wildcard characters "*", "?", "#" are valid, and may be escaped with a backslash character ("\"). |
| Process Name | text | Optional parameter. A pattern specifying the process name of the application. The wildcard characters "*", "?", "#" are valid, and may be escaped with a backslash character ("\"). |
| Process ID | number | Optional parameter. The process identifier (pid) of the process. |
| User Name | text | Optional parameter. The username of the user who the process is running as. |
| Child Index | number | Optional parameter. The child process index |
The internal ID for this action is 'AttachApplication'
Works with the following element types:
Detaches from the currently connected application.
This action takes no parameters
The internal ID for this action is 'DetachApplication'
Works with the following element types:
Terminate the target application. For emergency use only
This action takes no parameters
The internal ID for this action is 'Terminate'
Works with the following element types:
Detects whether the business object is currently connected to the application (be it through launching or attaching).
This action takes no parameters
The internal ID for this action is 'IsConnected'
Works with the following element types:
Send keys to the active application
| Name | Data Type | Description |
|---|---|---|
| Text | text | The key-codes to be sent to the target application. Full details at [http://msdn2.microsoft.com/en-us/library/system.windows.forms.sendkeys.send.aspx MSDN Sendkeys.Send()]. |
| Interval | number | The number of seconds to wait between each keypress. Note that if this is set to a non-zero value, 'Text' must not contain any control characters or an error will occur |
The internal ID for this action is 'SendKeys'
Works with the following element types:
'''Global action''' - the target application must have focus.
Send keys to the application using events. These events take place at the lowest level, and are received by whichever application is currently focused. The SendKeys method is preferred unless there is a special reason for using this method.
| Name | Data Type | Description |
|---|---|---|
| Text | text | The key events to be sent to the target application. Special characters should be enclosed in curly braces (eg {SPACE}, {ESC}, {PGUP}, {PGDN}, {LEFT}, {RIGHT}, {UP}, {DOWN}). The modifiers "<" and ">" change the following letter into a key-down or key-up operation (respectively), instead of a full key-press (ie key-down followed by key-up operation). For example "hello" sends those keystrokes; "<{CTRL}s>{CTRL}" simulates depressing the control key, pressing "s" and releasing the control key again. Special characters (such as "<", ">", "{", "}") should be enclosed in curly braces if meant literally. Any key name listed at [https://msdn.microsoft.com/en-us/library/system.windows.forms.keys.aspx MSDN Keys Enumeration] can also be used. |
| Interval | number | The number of seconds to wait between each keypress. Default is 0.1, ie. 100ms |
The internal ID for this action is 'SendKeyEvents'
Works with the following element types:
'''Global action''' - the target application must have focus.
Activate the application, i.e. brings to the foreground. Target element should be the app's main window.
This action takes no parameters
The internal ID for this action is 'ActivateApp'
Works with the following element types:
Send keypresses to the given window. Note that care must sometimes be taken to direct the keypresses to the correct window. For example, in Notepad, sending to the main window will have no effect, but sending to the 'Edit' window contained within it will work.
| Name | Data Type | Description |
|---|---|---|
| Text | text | The text to be sent. Each letter represents a different keystroke, which will be sent one by one. |
| Interval | number | The number of seconds to wait between each keystroke. |
The internal ID for this action is 'TypeText'
Works with the following element types:
Send keypresses to the given window with the alt key down
| Name | Data Type | Description |
|---|---|---|
| Text | text | The text to be sent. Each letter represents a different keystroke, which will be sent one by one. |
| Interval | number | The number of seconds to wait between each keystroke. |
The internal ID for this action is 'TypeTextAlt'
Works with the following element types:
'''Global action''' - the target application must have focus.
Perform the default action for the application element
This action takes no parameters
The internal ID for this action is 'Default'
Works with the following element types:
Move a window to the specified location.
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the new window location, relative to the top-left corner of the screen. |
| Y | number | The Y coordinate of the new window location, relative to the top-left corner of the screen. |
The internal ID for this action is 'MoveWindow'
Works with the following element types:
Resize a window.
| Name | Data Type | Description |
|---|---|---|
| Width | number | The new width of the window, in pixels. |
| Height | number | The new width of the window, in pixels. |
The internal ID for this action is 'ResizeWindow'
Works with the following element types:
Maximises the window to fill the screen.
This action takes no parameters
The internal ID for this action is 'MaximiseWindow'
Works with the following element types:
Minimises the window to the task tray.
This action takes no parameters
The internal ID for this action is 'MinimiseWindow'
Works with the following element types:
Restores the window from its minimised or maximised state.
This action takes no parameters
The internal ID for this action is 'RestoreWindow'
Works with the following element types:
Hides all top-level windows belonging to an application. Use 'Hide Window' to hide an individual window
This action takes no parameters
The internal ID for this action is 'HideAllWindows'
Works with the following element types:
Hides a top-level window by moving it offscreen, and removing from the taskbar.
This action takes no parameters
The internal ID for this action is 'HideWindow'
Works with the following element types:
Unhides a top-level window which has previously been hidden.
This action takes no parameters
The internal ID for this action is 'UnhideWindow'
Works with the following element types:
Determines whether a window has previously been hidden using a call to 'Hide Window'.
This action takes no parameters
The internal ID for this action is 'IsWindowHidden'
Works with the following element types:
Performs an action
| Name | Data Type | Description |
|---|---|---|
| Action | text | No Description Found. Please fix this problem |
The internal ID for this action is 'DoJava'
Works with the following element types:
Brings a java element into focus, ready to receive keyboard input
This action takes no parameters
The internal ID for this action is 'JABFocus'
Works with the following element types:
Selects a java tab from a java tab control
This action takes no parameters
The internal ID for this action is 'JABSelectTab'
Works with the following element types:
Gets the number of items contained in a java component, eg the number of rows in a table, eg the number of items in a combo box
This action takes no parameters
The internal ID for this action is 'JABGetItemCount'
Works with the following element types:
Gets all items from a java table, combo box, etc. For simple controls, the collection has a single field called 'Item Text'. For multi-column controls, the fields will be named as they are in the control, where possible - otherwise names such as 'Column1', 'Column2' will be used.
This action takes no parameters
The internal ID for this action is 'JABGetAllItems'
Works with the following element types:
Gets all selected items from a java table, combo box, etc
This action takes no parameters
The internal ID for this action is 'JABGetSelectedItems'
Works with the following element types:
Click at the centre of the Active Accessibility element.
| Name | Data Type | Description |
|---|---|---|
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'AAClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click the element at the specified position, using a global mouse click. The position is relative to the top left of the element's bounding rectangle. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to click, relative to the window |
| Y | number | The Y coordinate of the point at which to click, relative to the window |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'AAMouseClick'
Works with the following element types:
'''Global action''' - the target application must have focus.
Gets the name of the Accessibility element. Some applications expose current value information in the Name Attribute
This action takes no parameters
The internal ID for this action is 'AAGetName'
Works with the following element types:
Gets the description of the Accessibility element. Some applications expose current value information in the Description Attribute
This action takes no parameters
The internal ID for this action is 'AAGetDescription'
Works with the following element types:
Get the Active Accessibility table specified
This action takes no parameters
The internal ID for this action is 'AAGetTable'
Works with the following element types:
Focus the Active Accessibility element.
This action takes no parameters
The internal ID for this action is 'AAFocus'
Works with the following element types:
Send keys to the active application
| Name | Data Type | Description |
|---|---|---|
| Text | text | The key-codes to be sent to the target application. Full details at [http://msdn2.microsoft.com/en-us/library/system.windows.forms.sendkeys.send.aspx MSDN Sendkeys.Send()]. |
| Interval | number | The number of seconds to wait before each keypress. Note that if this is set to a non-zero value, 'Text' must not contain any control characters or an error will occur |
The internal ID for this action is 'AASendKeys'
Works with the following element types:
'''Global action''' - the target application must have focus.
Retrieves the URL of the currently loaded document
This action takes no parameters
The internal ID for this action is 'HTMLGetDocumentURL'
Works with the following element types:
Retrieves the URL domain of the currently loaded document
This action takes no parameters
The internal ID for this action is 'HTMLGetDocumentURLDomain'
Works with the following element types:
Navigate to a URL
| Name | Data Type | Description |
|---|---|---|
| URL | text | The URL to navigate to. |
The internal ID for this action is 'HTMLNavigate'
Works with the following element types:
Click the centre of an HTML element.
This action takes no parameters
The internal ID for this action is 'HTMLClickCentre'
Works with the following element types:
Double click the centre of an HTML element.
This action takes no parameters
The internal ID for this action is 'HTMLDoubleClickCentre'
Works with the following element types:
Get all child items of an HTML element, as a collection. For simple controls, the collection has a single field called 'Item Text'. For multi-column controls, the fields will be named as they are in the control, where possible - otherwise names such as 'Column1', 'Column2' will be used.
This action takes no parameters
The internal ID for this action is 'HTMLGetAllItems'
Works with the following element types:
Gets all elements of a HTML table, as a collection.
This action takes no parameters
The internal ID for this action is 'HTMLGetTable'
Works with the following element types:
Get all child items of an HTML element which are selected, as a collection.
This action takes no parameters
The internal ID for this action is 'HTMLGetSelectedItems'
Works with the following element types:
Gets the text of the first selected item. Returns an error if no items are selected.
This action takes no parameters
The internal ID for this action is 'HTMLGetSelectedItemText'
Works with the following element types:
Selects the item in a ComboBox that matches the given parameters.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the item to be selected. If not unique, then the first matching item found will be selected. |
| Item Position | number | The 1-based index of the item to be modified. This parameter is ignored unless the 'Item Text' parameter is blank. |
| Item Value | text | The value of the item to selected. This parameter is ignored unless the 'Item Text' and 'Item Position' parameter is blank. |
The internal ID for this action is 'HTMLSelectItem'
Works with the following element types:
Get the number of child items of an HTML element.
This action takes no parameters
The internal ID for this action is 'HTMLCountItems'
Works with the following element types:
Get the number of child items of an HTML element, which are selected.
This action takes no parameters
The internal ID for this action is 'HTMLCountSelectedItems'
Works with the following element types:
Calls the specified javascript function. This can be a standard javascript function, or one which is defined in the target HTML page.
| Name | Data Type | Description |
|---|---|---|
| Function Name | text | The name of the function to be called. |
| Arguments | text | The arguments to pass to the function, as an array of objects in JSON format |
The internal ID for this action is 'HTMLInvokeJavascriptMethod'
Works with the following element types:
Inserts the supplied javascript fragment into the target document. This can be a mixture of methods and variables. The methods can later be invoked using the corresponding method.
| Name | Data Type | Description |
|---|---|---|
| Fragment | text | The javascript fragment to be inserted. Eg var Success; function doSomething() { alert('hello'); Success = true; } |
The internal ID for this action is 'HTMLInsertJavascriptFragment'
Works with the following element types:
Updates the given cookie on the target document. Cookies need to be specified in the format "name=value". By default the cookie will expire when the browser is closed, but to have the cookie persist set an expiry date using "name=value; expires=date". To delete a cookie use "name=; expires=date", where name is the name of the cookie and date is in the past. Dates should be in UTC format e.g. Thu, 18 Dec 2013 12:00:00 UTC
| Name | Data Type | Description |
|---|---|---|
| Cookie | text | The cookie data to be set |
The internal ID for this action is 'HTMLUpdateCookie'
Works with the following element types:
Take a snapshot of all HTML document elements.
This action takes no parameters
The internal ID for this action is 'HTMLSnapshot'
Works with the following element types:
Capture the source of the HTML document.
This action takes no parameters
The internal ID for this action is 'HTMLSourceCap'
Works with the following element types:
Gets the HTML of an element.
This action takes no parameters
The internal ID for this action is 'HTMLGetOuterHTML'
Works with the following element types:
Gets Path of the HTML element.
This action takes no parameters
The internal ID for this action is 'HTMLGetPath'
Works with the following element types:
Take a snapshot of all elements.
This action takes no parameters
The internal ID for this action is 'WindowsSnapshot'
Works with the following element types:
Take a snapshot of all elements.
This action takes no parameters
The internal ID for this action is 'JABSnapshot'
Works with the following element types:
Clicks a .Net Link Label
This action takes no parameters
The internal ID for this action is 'ClickLink'
Works with the following element types:
Reads the value of a DDE field
This action takes no parameters
The internal ID for this action is 'DDEGetText'
Works with the following element types:
Executes the command represented by the current DDE element.
| Name | Data Type | Description |
|---|---|---|
| Value | text | The value (if any) to supply to the DDE command. |
| No Check | flag | If true, then no check will be made as to the success of the operation. This provides a workaround for a badly behaved application which performs the requested command, but fails to feed back a success status. Defaults to False. |
The internal ID for this action is 'ExecuteDDECommand'
Works with the following element types:
Verifies that an element exists, and optionally highlights the element
| Name | Data Type | Description |
|---|---|---|
| Highlight | flag | Specifies that the element should be highlighted |
The internal ID for this action is 'Verify'
Works with the following element types:
Verifies that an element exists, and optionally highlights the element
| Name | Data Type | Description |
|---|---|---|
| Highlight | flag | Specifies that the element should be highlighted |
The internal ID for this action is 'RegionVerify'
Works with the following element types:
'''Global action''' - the target application must have focus.
Verifies that an element exists, and optionally highlights the element
| Name | Data Type | Description |
|---|---|---|
| Element Number | number | The 1-based number indicating which element of the list region to act on. Default is 1 |
| Highlight | flag | Specifies that the element should be highlighted |
The internal ID for this action is 'ListRegionVerify'
Works with the following element types:
'''Global action''' - the target application must have focus.
Verifies that an element exists, and optionally highlights the element
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column of the grid region to act on. Default is 1 |
| Row Number | number | The 1-based row number indicating which row of the grid region to act on. Default is 1 |
| Highlight | flag | Specifies that the element should be highlighted |
The internal ID for this action is 'GridRegionVerify'
Works with the following element types:
'''Global action''' - the target application must have focus.
Clicks on the given element
This action takes no parameters
The internal ID for this action is 'WebClick'
Works with the following element types:
Double click the given element
This action takes no parameters
The internal ID for this action is 'WebDoubleClick'
Works with the following element types:
Selects the current element and any descendant elements
This action takes no parameters
The internal ID for this action is 'WebSelect'
Works with the following element types:
Sets the keyboard focus to the given element
This action takes no parameters
The internal ID for this action is 'WebFocus'
Works with the following element types:
Sets the given attribute on the element
| Name | Data Type | Description |
|---|---|---|
| Attribute Name | text | The name of the attribute to set |
| Value | text | The value to set the attribute to |
The internal ID for this action is 'WebSetAttribute'
Works with the following element types:
Sets the checked state of the element
| Name | Data Type | Description |
|---|---|---|
| Checked | flag | Whether the control should be checked |
The internal ID for this action is 'WebSetCheckState'
Works with the following element types:
Send keys to the active application
| Name | Data Type | Description |
|---|---|---|
| Text | text | The key-codes to be sent to the target application. Full details at [http://msdn2.microsoft.com/en-us/library/system.windows.forms.sendkeys.send.aspx MSDN Sendkeys.Send()]. |
| Interval | number | The number of seconds to wait before each keypress. Note that if this is set to a non-zero value, 'Text' must not contain any control characters or an error will occur |
The internal ID for this action is 'WebSendKeys'
Works with the following element types:
'''Global action''' - the target application must have focus.
Scroll the parent to the element
This action takes no parameters
The internal ID for this action is 'WebScrollTo'
Works with the following element types:
Navigates to the given address
| Name | Data Type | Description |
|---|---|---|
| Address | text | The Web address to navigate to |
The internal ID for this action is 'WebNavigate'
Works with the following element types:
Calls the specified javascript function. This can be a standard javascript function, or one which is defined in the target HTML page.
| Name | Data Type | Description |
|---|---|---|
| Function Name | text | The name of the function to be called. |
| Arguments | text | The arguments to pass to the function, as an array of objects in JSON format |
The internal ID for this action is 'WebInvokeJavascript'
Works with the following element types:
Inserts the supplied javascript fragment into the target document. This can be a mixture of methods and variables. The methods can later be invoked using the corresponding method.
| Name | Data Type | Description |
|---|---|---|
| Fragment | text | The javascript fragment to be inserted. Eg var Success; function doSomething() { alert('hello'); Success = true; } |
The internal ID for this action is 'WebInjectJavascript'
Works with the following element types:
Updates the given cookie on the target document. Cookies need to be specified in the format "name=value". By default the cookie will expire when the browser is closed, but to have the cookie persist set an expiry date using "name=value; expires=date". To delete a cookie use "name=; expires=date", where name is the name of the cookie and date is in the past. Dates should be in UTC format e.g. Thu, 18 Dec 2013 12:00:00 UTC
| Name | Data Type | Description |
|---|---|---|
| Cookie | text | The cookie data to be set |
The internal ID for this action is 'WebUpdateCookie'
Works with the following element types:
Submits the form
This action takes no parameters
The internal ID for this action is 'WebSubmit'
Works with the following element types:
Selects an item in the list by name or index
| Name | Data Type | Description |
|---|---|---|
| Item Index | number | The index of the item to select |
| Item Text | text | The text of the item to select |
The internal ID for this action is 'WebSelectListItem'
Works with the following element types:
Adds an item to the list's selected items by name or index
| Name | Data Type | Description |
|---|---|---|
| Item Index | number | The index of the item |
| Item Text | text | The text of the item |
The internal ID for this action is 'WebAddToListSelection'
Works with the following element types:
Removes an item from the list's selected items by name or index
| Name | Data Type | Description |
|---|---|---|
| Item Index | number | The index of the item |
| Item Text | text | The text of the item |
The internal ID for this action is 'WebRemoveFromListSelection'
Works with the following element types:
Clicks the menu item identified by name or index
| Name | Data Type | Description |
|---|---|---|
| Item Index | number | The index of the item to click |
| Item Text | text | The text of the item to click |
The internal ID for this action is 'WebClickMenuItem'
Works with the following element types:
Toggles whether the element is expanded or collapsed
This action takes no parameters
The internal ID for this action is 'WebToggleExpandCollapse'
Works with the following element types:
Expands the element
This action takes no parameters
The internal ID for this action is 'WebExpand'
Works with the following element types:
Collapses the element
This action takes no parameters
The internal ID for this action is 'WebCollapse'
Works with the following element types:
Sets the radio button to be the one in its group that's checked
This action takes no parameters
The internal ID for this action is 'WebCheckRadio'
Works with the following element types:
Selects a range of text within the element
| Name | Data Type | Description |
|---|---|---|
| Start Index | number | The character to start the selection at |
| Length | number | The number of characters to select |
The internal ID for this action is 'WebSelectTextRange'
Works with the following element types:
Gets the given attribute of the element
| Name | Data Type | Description |
|---|---|---|
| Attribute Name | text | The name of the attribute to get. |
The internal ID for this action is 'WebGetAttribute'
Works with the following element types:
Gets the bounds of the element relative to the page
This action takes no parameters
The internal ID for this action is 'WebGetBounds'
Works with the following element types:
Gets the checked state of the element
This action takes no parameters
The internal ID for this action is 'WebGetCheckState'
Works with the following element types:
Gets the number of columns in the table
This action takes no parameters
The internal ID for this action is 'WebGetColumnCount'
Works with the following element types:
Gets the values from each input element in a form
This action takes no parameters
The internal ID for this action is 'WebGetFormValues'
Works with the following element types:
Gets the ID of the element
This action takes no parameters
The internal ID for this action is 'WebGetId'
Works with the following element types:
Gets a value indicating whether the element is visible on screen
This action takes no parameters
The internal ID for this action is 'WebGetIsOnScreen'
Works with the following element types:
Gets a value indicating whether the list item is selected
This action takes no parameters
The internal ID for this action is 'WebGetIsSelected'
Works with the following element types:
Gets a value indicating whether the element is visible
This action takes no parameters
The internal ID for this action is 'WebGetIsVisible'
Works with the following element types:
Gets all items from a list
This action takes no parameters
The internal ID for this action is 'WebGetItems'
Works with the following element types:
Gets the label associated with an element
This action takes no parameters
The internal ID for this action is 'WebGetLabel'
Works with the following element types:
Gets the web address that a link points to
This action takes no parameters
The internal ID for this action is 'WebGetLinkAddress'
Works with the following element types:
Gets the maximum value of a numeric element
This action takes no parameters
The internal ID for this action is 'WebGetMaxValue'
Works with the following element types:
Gets the minimum value of a numeric element
This action takes no parameters
The internal ID for this action is 'WebGetMinValue'
Works with the following element types:
Gets the URL of the web page that contains this element
This action takes no parameters
The internal ID for this action is 'WebGetPageUrl'
Works with the following element types:
Gets the number of rows in the table
This action takes no parameters
The internal ID for this action is 'WebGetRowCount'
Works with the following element types:
Gets the items in a list which are selected
This action takes no parameters
The internal ID for this action is 'WebGetSelectedItems'
Works with the following element types:
Gets the items in a list which are selected
This action takes no parameters
The internal ID for this action is 'WebGetSelectedItemsText'
Works with the following element types:
Gets the text selected in an element
This action takes no parameters
The internal ID for this action is 'WebGetSelectedText'
Works with the following element types:
Gets the item in a table at the given row and column
| Name | Data Type | Description |
|---|---|---|
| Column | number | Column index |
| Row | number | Row index |
The internal ID for this action is 'WebGetTableItem'
Works with the following element types:
Gets all items in a table
This action takes no parameters
The internal ID for this action is 'WebGetTableItems'
Works with the following element types:
Gets the text contained in an element
This action takes no parameters
The internal ID for this action is 'WebGetText'
Works with the following element types:
Reads the current value from a Web element
This action takes no parameters
The internal ID for this action is 'WebGetValue'
Works with the following element types:
Gets Path of the Web element.
This action takes no parameters
The internal ID for this action is 'WebGetPath'
Works with the following element types:
Gets the name of the UIA element. Some applications expose current value information in the Name Attribute
This action takes no parameters
The internal ID for this action is 'UIAGetName'
Works with the following element types:
Focus the UIA element.
This action takes no parameters
The internal ID for this action is 'UIAFocus'
Works with the following element types:
Press the UI Automation button element (this will invoke, toggle or expand/collapse the button depending which action the button supports.
This action takes no parameters
The internal ID for this action is 'UIAButtonPress'
Works with the following element types:
Press the UI Automation element
This action takes no parameters
The internal ID for this action is 'UIAPress'
Works with the following element types:
Deselects any selected items and then selects the UI Automation element
This action takes no parameters
The internal ID for this action is 'UIASelect'
Works with the following element types:
Press the UI Automation menu item element, either by expanding a submenu or invoking the menu item itself
This action takes no parameters
The internal ID for this action is 'UIAMenuItemPress'
Works with the following element types:
Change the toggle state of the UI Automation element
This action takes no parameters
The internal ID for this action is 'UIAToggle'
Works with the following element types:
Get the checked state of the UI Automation element
This action takes no parameters
The internal ID for this action is 'UIAGetToggleState'
Works with the following element types:
Get the pressed state of the UI Automation element
This action takes no parameters
The internal ID for this action is 'UIAGetPressedState'
Works with the following element types:
Sets the checked state of the UI Automation element
| Name | Data Type | Description |
|---|---|---|
| Checked | flag | Whether the control should be checked |
The internal ID for this action is 'UIASetToggleState'
Works with the following element types:
Reads the current value from a UI Automation element
This action takes no parameters
The internal ID for this action is 'UIAGetValue'
Works with the following element types:
Writes the current value to a UI Automation element
This action takes no parameters
The internal ID for this action is 'UIASetValue'
Works with the following element types:
Expands or collapses the UI Automation element.
This action takes no parameters
The internal ID for this action is 'UIAExpandCollapse'
Works with the following element types:
Sets the checked status of a UIA radio button
| Name | Data Type | Description |
|---|---|---|
| Checked | flag | Whether the control should be checked |
The internal ID for this action is 'UIARadioSetChecked'
Works with the following element types:
Gets the text of the selected item.
This action takes no parameters
The internal ID for this action is 'UIAGetSelectedItemText'
Works with the following element types:
Gets the text selected in the element
This action takes no parameters
The internal ID for this action is 'UIAGetSelectedText'
Works with the following element types:
Reads the current state of whether the element is expanded or collapsed. If the element cannot be expanded, this will return False
This action takes no parameters
The internal ID for this action is 'UIAGetExpanded'
Works with the following element types:
Get the checked state of the UI Automation element
This action takes no parameters
The internal ID for this action is 'UIAGetRadioCheckedState'
Works with the following element types:
Gets the selected items in the list
This action takes no parameters
The internal ID for this action is 'UIAGetSelectedItems'
Works with the following element types:
Gets the number of items in the list
This action takes no parameters
The internal ID for this action is 'UIAGetItemCount'
Works with the following element types:
Gets all items in the list
This action takes no parameters
The internal ID for this action is 'UIAGetAllItems'
Works with the following element types:
Deselects any selected items and then selects the current element. If the Item Text parameter is supplied, this takes precedence over the Item Position parameter.
| Name | Data Type | Description |
|---|---|---|
| Item Position | number | The one-based index of the item to select |
| Item Text | text | The text of the item to select |
The internal ID for this action is 'UIAListSelect'
Works with the following element types:
Selects the specified item in a UIA combo box. If the Item Text parameter is supplied, this takes precedence over the Item Position parameter.
| Name | Data Type | Description |
|---|---|---|
| Item Position | number | The one-based index of the item to select |
| Item Text | text | The text of the item to select |
The internal ID for this action is 'UIAComboSelect'
Works with the following element types:
Gets the number of items in the list in a UIA combo box.
This action takes no parameters
The internal ID for this action is 'UIAComboGetItemCount'
Works with the following element types:
Gets all items in the list in a UIA combo box.
This action takes no parameters
The internal ID for this action is 'UIAComboGetAllItems'
Works with the following element types:
Scrolls an element vertically
| Name | Data Type | Description |
|---|---|---|
| Big Step | flag | Whether the scroll should be a big step. |
| Scroll Up | flag | Whether the scroll should be in the upwards direction. |
The internal ID for this action is 'UIAScrollVertical'
Works with the following element types:
Scrolls an element horizontally
| Name | Data Type | Description |
|---|---|---|
| Big Step | flag | Whether the scroll should be a big step. |
| Scroll Up | flag | Whether the scroll should be in the upwards direction. |
The internal ID for this action is 'UIAScrollHorizontal'
Works with the following element types:
Adds an item to its parent's selected items
This action takes no parameters
The internal ID for this action is 'UIAAddToSelection'
Works with the following element types:
Removes an item from its parent's selected items
This action takes no parameters
The internal ID for this action is 'UIARemoveFromSelection'
Works with the following element types:
Scrolls the element into view
This action takes no parameters
The internal ID for this action is 'UIAScrollIntoView'
Works with the following element types:
Adds the specfied item to the list's selected items. If the Item Text parameter is supplied, this takes precedence over the Item Position parameter.
| Name | Data Type | Description |
|---|---|---|
| Item Position | number | The one-based index of the item to select |
| Item Text | text | The text of the item to select |
The internal ID for this action is 'UIAListAddToSelection'
Works with the following element types:
Removes the given item from the list's selected items. If the Item Text parameter is supplied, this takes precedence over the Item Position parameter.
| Name | Data Type | Description |
|---|---|---|
| Item Position | number | The one-based index of the item to de-select |
| Item Text | text | The text of the item to de-select |
The internal ID for this action is 'UIAListRemoveFromSelection'
Works with the following element types:
Whether the item is currently selected
This action takes no parameters
The internal ID for this action is 'UIAGetIsItemSelected'
Works with the following element types:
Returns a collection of the text of all the tabs contained within the tab control
This action takes no parameters
The internal ID for this action is 'UIAGetAllTabsText'
Works with the following element types:
Selects the Tab Item
This action takes no parameters
The internal ID for this action is 'UIASelectTabItem'
Works with the following element types:
Selects the Tab within a UIA Tab Control. If the Tab Text parameter is supplied, this takes precedence over the Tab Position parameter.
| Name | Data Type | Description |
|---|---|---|
| Tab Position | number | The one-based index of the tab to select |
| Tab Text | text | The text value of the tab to select |
The internal ID for this action is 'UIASelectTab'
Works with the following element types:
Selects an item in a tree
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the tree view item of interest. |
| Item Position | number | The 1-based index of the tree view item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'UIATreeSelect'
Works with the following element types:
Adds the given item to the tree's selected items.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the tree view item of interest. |
| Item Position | number | The 1-based index of the tree view item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'UIATreeAddToSelection'
Works with the following element types:
Removes the given item from the tree's selected items.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the tree view item of interest. |
| Item Position | number | The 1-based index of the tree view item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'UIATreeRemoveFromSelection'
Works with the following element types:
Expands or collapses the UI Automation element.
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the tree view item of interest. |
| Item Position | number | The 1-based index of the tree view item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'UIATreeExpandCollapse'
Works with the following element types:
Reads the current state of whether the element is expanded or collapsed. If the element cannot be expanded, this will return False
| Name | Data Type | Description |
|---|---|---|
| Item Text | text | The text of the tree view item of interest. |
| Item Position | number | The 1-based index of the tree view item of interest. This parameter is ignored unless the 'Item Text' parameter is blank. |
The internal ID for this action is 'UIATreeIsExpanded'
Works with the following element types:
Reads the text from the cell
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
The internal ID for this action is 'UIATableReadCellText'
Works with the following element types:
Sets the text into the specified cell
| Name | Data Type | Description |
|---|---|---|
| Cell Text | text | The new text for the cell. Default is blank. |
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
The internal ID for this action is 'UIATableSetCellText'
Works with the following element types:
Scrolls the table cell into view
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
The internal ID for this action is 'UIATableScrollIntoView'
Works with the following element types:
Gets the data in the specified rows
| Name | Data Type | Description |
|---|---|---|
| First Row Number | number | The 1-based row number indicating the first row to include in the collection. Defaults to 1 if not specified. |
| Last Row Number | number | The 1-based row number indicating the last row to include in the collection. Defaults to the last row in the table if not specified. |
The internal ID for this action is 'UIATableRows'
Works with the following element types:
Adds a row to the current selection.
| Name | Data Type | Description |
|---|---|---|
| Row Number | number | The 1-based row number indicating which row to act on. |
The internal ID for this action is 'UIATableAddRowToSelection'
Works with the following element types:
Removes a row from the current selection.
| Name | Data Type | Description |
|---|---|---|
| Row Number | number | The 1-based row number indicating which row to act on. |
The internal ID for this action is 'UIATableRemoveRowFromSelection'
Works with the following element types:
Clears the current selection.
This action takes no parameters
The internal ID for this action is 'UIATableClearSelection'
Works with the following element types:
Gets the selected rows as a collection.
This action takes no parameters
The internal ID for this action is 'UIATableGetSelectedRows'
Works with the following element types:
Get the number of rows in the table.
This action takes no parameters
The internal ID for this action is 'UIATableRowCount'
Works with the following element types:
Get the number of columns in the table.
This action takes no parameters
The internal ID for this action is 'UIATableColumnCount'
Works with the following element types:
Gets the number of the first selected row in the table.
This action takes no parameters
The internal ID for this action is 'UIATableSelectedRowNumber'
Works with the following element types:
Gets number of the first selected column in the table.
This action takes no parameters
The internal ID for this action is 'UIATableSelectedColumnNumber'
Works with the following element types:
Changes the Toggle state of the table cell.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
The internal ID for this action is 'UIATableToggleCell'
Works with the following element types:
Gets checked state of the table cell.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
The internal ID for this action is 'UIATableReadToggleState'
Works with the following element types:
Expands or collapses the table cell.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
The internal ID for this action is 'UIATableExpandCollapse'
Works with the following element types:
Reads the current state of whether the cell element is expanded or collapsed.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
The internal ID for this action is 'UIATableExpanded'
Works with the following element types:
Selects an item from a combobox within the table cell element. If the Item Text parameter is supplied, this takes precedence over the Item Position parameter.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
| Item Position | number | The one-based index of the item to select |
| Item Text | text | The text value of the item to select |
The internal ID for this action is 'UIATableSelectComboboxItem'
Works with the following element types:
The number of items within a combobox inside the UI Automation element cell.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
The internal ID for this action is 'UIATableCountComboboxItems'
Works with the following element types:
Get all items from a combobox within the cell element as a collection.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
The internal ID for this action is 'UIATableGetAllComboboxItems'
Works with the following element types:
Gets the value of the selected item from a combobox in a table cell.
| Name | Data Type | Description |
|---|---|---|
| Column Number | number | The 1-based column number indicating which column to act on. |
| Row Number | number | The 1-based row number indicating which row to act on. |
| Element Number | number | Component index within the cell, 0 indicates the cell itself. |
The internal ID for this action is 'UIATableGetSelectedComboboxItem'
Works with the following element types:
Start dragging from a given position over the window
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to start dragging, relative to the window |
| Y | number | The Y coordinate of the point at which to start dragging, relative to the window |
The internal ID for this action is 'UIADrag'
Works with the following element types:
'''Global action''' - the target application must have focus.
Drop at the given position over the window - must follow a drag
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to perform the drop, relative to the window |
| Y | number | The Y coordinate of the point at which to perform the drop, relative to the window |
The internal ID for this action is 'UIADrop'
Works with the following element types:
'''Global action''' - the target application must have focus.
Gets information about the bounding rectangle of the element, in coordinates relative to the parent.
This action takes no parameters
The internal ID for this action is 'UIAGetRelativeElementBounds'
Works with the following element types:
Gets information about the bounding rectangle of the element, in screen coordinates.
This action takes no parameters
The internal ID for this action is 'UIAGetElementScreenBounds'
Works with the following element types:
Click the element at the specified position, using a global mouse click. The position is relative to the top left of the element's bounding rectangle. The mouse cursor will appear to jump across the screen during this method.
| Name | Data Type | Description |
|---|---|---|
| X | number | The X coordinate of the point at which to click, relative to the window |
| Y | number | The Y coordinate of the point at which to click, relative to the window |
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'UIAMouseClick'
Works with the following element types:
'''Global action''' - the target application must have focus.
Click at the centre of the UIA element.
| Name | Data Type | Description |
|---|---|---|
| Mouse Button | text | Optional: the mouse button to use. Valid values are 'left' and 'right'; a null value implies 'left' |
The internal ID for this action is 'UIAClickCentre'
Works with the following element types:
'''Global action''' - the target application must have focus.
Send keys to the active application
| Name | Data Type | Description |
|---|---|---|
| Text | text | The key-codes to be sent to the target application. Full details at [http://msdn2.microsoft.com/en-us/library/system.windows.forms.sendkeys.send.aspx MSDN Sendkeys.Send()]. |
| Interval | number | The number of seconds to wait before each keypress. Note that if this is set to a non-zero value, 'Text' must not contain any control characters or an error will occur |
The internal ID for this action is 'UIASendKeys'
Works with the following element types:
'''Global action''' - the target application must have focus.
Expands or collapses the UI Automation element.
This action takes no parameters
The internal ID for this action is 'UIAComboExpandCollapse'
Works with the following element types:
Set the date range for a control
| Name | Data Type | Description |
|---|---|---|
| Start Date | date | The start date of the range |
| End Date | date | The end date of the range |
The internal ID for this action is 'SelectDateRange'
Works with the following element types:
Get the date range for a control
This action takes no parameters
The internal ID for this action is 'GetDateRange'
Works with the following element types:
Get the minimum horizontal value
This action takes no parameters
The internal ID for this action is 'GetHorizontalMin'
Works with the following element types:
Get the maximum horizontal value
This action takes no parameters
The internal ID for this action is 'GetHorizontalMax'
Works with the following element types:
Get the current horizontal value
This action takes no parameters
The internal ID for this action is 'GetHorizontalValue'
Works with the following element types:
Set the horizontal value
| Name | Data Type | Description |
|---|---|---|
| Value | number | The new value |
The internal ID for this action is 'SetHorizontalValue'
Works with the following element types:
Get the minimum vertical value
This action takes no parameters
The internal ID for this action is 'GetVerticalMin'
Works with the following element types:
Get the maximum vertical value
This action takes no parameters
The internal ID for this action is 'GetVerticalMax'
Works with the following element types:
Get the current vertical value
This action takes no parameters
The internal ID for this action is 'GetVerticalValue'
Works with the following element types:
Set the vertical value
| Name | Data Type | Description |
|---|---|---|
| Value | number | The new value |
The internal ID for this action is 'SetVerticalValue'
Works with the following element types:
Get the key of the selected node in a treeview
This action takes no parameters
The internal ID for this action is 'GetSelectedNodeKey'
Works with the following element types:
Get the text of the node with the specified key
| Name | Data Type | Description |
|---|---|---|
| Key | text | The key of the node |
The internal ID for this action is 'GetNodeText'
Works with the following element types:
Simulate double clicking the tree node
| Name | Data Type | Description |
|---|---|---|
| Text | text | The text of the node |
The internal ID for this action is 'DoubleClickNode'
Works with the following element types:
Selects an item
This action takes no parameters
The internal ID for this action is 'Select'
Works with the following element types:
Selects an item identified by its position.
| Name | Data Type | Description |
|---|---|---|
| Item Position | number | The 1-based index of the item to be selected. This parameter is ignored unless the 'Item Text' |
The internal ID for this action is 'SelectItemByIndex'
Works with the following element types:
Returns the text value of the currently selected cell in a Grid.
| Name | Data Type | Description |
|---|---|---|
| Cell row | number | The row number of the current cell |
| Cell column | number | The column number of the current cell |
The internal ID for this action is 'GetCellValue'
Works with the following element types:
Places the focus for events on to a specific control.
This action takes no parameters
The internal ID for this action is 'SetFocus'
Works with the following element types:
Compares against drawn text retrieved from a rectangular region
Works with the following element types:
Compares against drawn text retrieved from a list element in a rectangular region
Works with the following element types:
Compares against drawn text retrieved from a grid cell in a rectangular region
Works with the following element types:
Compares against an image retrieved from a rectangular region
Works with the following element types:
Compares against an image retrieved from a list element in a rectangular region
Works with the following element types:
Compares against an image retrieved from a grid element in a rectangular region
Works with the following element types:
Determines if the region contains a particular image.
Works with the following element types:
Determines if the specified element in the list region contains a particular image.
Works with the following element types:
Determines if the specified element in the grid region contains a particular image.
Works with the following element types:
Determines if the region contains a particular colour.
Works with the following element types:
Determines if the specified element in the list region contains a particular colour.
Works with the following element types:
Determines if the specified element in the grid region contains a particular colour.
Works with the following element types:
Determines if the region consists of a uniform colour.
Works with the following element types:
Determines if the specified element in the list region consists of a uniform colour.
Works with the following element types:
Determines if the specified element in the grid region consists of a uniform colour.
Works with the following element types:
Compares text using character matching from a rectangular area on a window
Works with the following element types:
Compares text using character matching from a list element in a rectangular area on a window
Works with the following element types:
Compares text using character matching from a grid cell in a rectangular area on a window
Works with the following element types:
Compares against text retrieved from a java element
Works with the following element types:
Counts and returns the number of items contained in a listview or Treeview.
Works with the following element types:
Determines whether a java element is focused
Works with the following element types:
Compares contents of a terminal field
Works with the following element types:
Compares main text of a window or control
Works with the following element types:
Check the element exists - True or False
Works with the following element types:
Check that the Active Accessibility element exists - True or False
Works with the following element types:
Check that the Java element exists - True or False
Works with the following element types:
Check if the terminal field exists, with the text contained when spied - True or False
Works with the following element types:
Check if the item (e.g a checkbox) is checked - True or False
Works with the following element types:
Check if the item (e.g a checkbox) is checked - True or False
Works with the following element types:
Check if the current document has loaded - True or False. Relevant only for browser applications. Do not use this unless you know you are already on the page which you are waiting to load, otherwise it is more appropriate to use Parent Document Loaded on an element on the target page. Parent Document Loaded includes an implicit Check exists on the element as well as a Document Loaded check.
Works with the following element types:
Check the element exists and that the entire page and all of its child frames are fully loaded. Parent Document Loaded includes an implicit Check exists on the element as well as a Document Loaded check.
Works with the following element types:
Check if the URL of the currently loaded document equals a particular value. Relevant only for browser applications
Works with the following element types:
Check if the domain of the URL of the currently loaded document equals a particular value. Relevant only for browser applications
Works with the following element types:
Check if the HTML element is a specific value
Works with the following element types:
Checks whether the supplied DDE element can be located and its value can be read.
Works with the following element types:
Checks whether a DDE conversation can be initiated with the specified Server/Topic pair. The Item attribute of the supplied element is ignored.
Works with the following element types:
Check if the button has been pressed
Works with the following element types:
Check if the left mouse button has been pressed
Works with the following element types:
Checks whether the business object is currently connected to the application (be it through launching or attaching).
Works with the following element types:
Checks whether a window is the current active window - the window which receives user input.
Works with the following element types:
Gets the number of items in the list
Works with the following element types:
Checks if the element has focus
Works with the following element types:
Gets the number of items in the combo box
Works with the following element types:
Gets if the element is checked
Works with the following element types:
Gets if the element is checked
Works with the following element types:
Check that the Web element exists - True or False
Works with the following element types:
Check the current value of a window attribute.
Works with the following element types:
Get the current value of an Active Accessibility attribute.
Works with the following element types:
Get the current value of an HTML attribute.
Works with the following element types:
Get the current value of a Java Access Bridge attribute.
Works with the following element types:
Get the current value of a UI Automation attribute.
Works with the following element types:
An element representing the target application as a whole.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: Application
A standard Windows text edit field.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: Edit
A Windows password text box.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: Password
A standard Windows List Box.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: ListBox
A standard Windows Radio Button
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: RadioButton
A standard Windows check box
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: CheckBox
A .NET check box
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: NetCheckBox
A standard Windows Button
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: Button
A standard Windows Combo Box
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: ComboBox
A standard Windows List View
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: ListView
An ActiveX List View
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: ListViewAx
A standard Windows Tree View
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: Treeview
An ActiveX Tree View
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: TreeviewAx
An ActiveX Status Bar
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: StatusBarAx
A standard Windows Tab Control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: TabControl
A standard Windows Track Bar Control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: TrackBar
A standard Windows Up-Down Control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: UpDown
A standard Windows DateTime-Picker Control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: DateTimePicker
A standard Windows Month Calendar Picker Control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: MonthCalPicker
A standard Windows Scroll Bar
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: ScrollBar
A standard Windows Label
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: Label
A standard .NET Link Label
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: NetLinkLabel
A standard Windows Toolbar
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: Toolbar
A .NET DataGrid control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: DataGrid
A .NET DataGridView control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: DataGridView
A standard Windows Window.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: Window
A Microsoft FlexGrid ActiveX Control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: MSFlexGrid
An Apex Grid ActiveX Control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: ApexGrid
A VB6 Date Picker control
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: DTPicker
A rectangular region within a Window identified using either coordinates or an image. For regions located using an image, actions and conditions will search the parent element in the application window for the region's image to identify its location - actions will raise an error if the region cannot be found.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: WindowRect
A list of contiguous regions within a window
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: Win32ListRegion
A table of regions within a window
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: Win32GridRegion
A terminal emulator field
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: TerminalField
An Active Accessibility element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: AAElement
An Active Accessibility Button element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: AAButton
An Active Accessibility Checkbox element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: AACheckBox
An Active Accessibility Combo Box element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: AAComboBox
An Active Accessibility List Box element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: AAListBox
An Active Accessibility Radio button element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: AARadioButton
An Active Accessibility Edit box element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: AAEdit
A generic UI Automation element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAElement
A UI Automation button element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAButton
A UI Automation check box element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIACheckBox
A UI Automation radio button element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIARadio
A UI Automation combo box element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAComboBox
A UI Automation edit box element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAEdit
A UI Automation menu element
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAMenu
A UI Automation menu item element
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAMenuItem
A UI Automation list element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAList
A UI Automation list item element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAListItem
A UI Automation table element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIATable
A UI Automation Tab Control.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIATabControl
A UI Automation Tab Item.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIATabItem
A UI Automation hyperlink element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAHyperlink
A UI Automation tree view element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIATreeView
A UI Automation tree view item element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIATreeViewItem
A UI Automation window element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: UIAWindow
A generic Web element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebElement
A Web page button element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebButton
A Web page check box element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebCheckBox
A Web form element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebForm
A Web hyperlink element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebLink
A Web list element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebList
A Web list item element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebListItem
A Web menu element
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebMenu
A Web menu item element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebMenuItem
A Web progress bar element
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebProgressBar
A Web radio button element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebRadio
A Web slider element
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebSlider
A Web table element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebTable
A Web table item element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebTableItem
A Web text element
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebText
A Web text edit element
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: WebTextEdit
An HTML DOM element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: HTML
An HTML Button element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: HTMLButton
An HTML Checkbox element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: HTMLCheckBox
An HTML Radio button element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: HTMLRadioButton
An HTML Edit box element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: HTMLEdit
An HTML Combo box element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: HTMLCombo
An HTML Table element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: HTMLTable
A Java edit box.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: JavaEdit
A Java password edit field.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: JavaPasswordEdit
A Java check box.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaCheckBox
A Java radio button.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaRadioButton
A toggle button - ie a button that retains its pressed state until it is pressed again.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaToggleButton
A Java menu item.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaMenuItem
A Java menu, often found at the top of a main application window.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaMenu
A Java button.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: JavaButton
A Java scrollbar.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaScrollBar
A Java combobox.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaComboBox
A dialog window, as often used in pop-up forms.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaDialog
A tab in a tab control, which when selected changes the currently viewed page.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaTabSelector
A Java progress bar.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaProgressBar
A track bar control, which consists of a pointer on a sliding scale to indicate a numeric value.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaTrackBar
An up-down box, consisting of a textbox with some up/down buttons for adjusting the value in the box.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaUpDown
A java table - an analogous control to the windows listview, when viewed in details mode.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaTable
A java tree view.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaTreeView
A java tree view node.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaTreeNode
A java list box.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaListBox
A java tab control.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaTabControl
A java tool bar.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaToolBar
A Java popup menu.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: JavaPopupMenu
A Java element.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: Java
A Dynamic Data Exchange (DDE) field.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: DDEElement
A SAP Status Bar.
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPStatusBar
A SAP Title Bar.
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPTitleBar
A SAP Main Window.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPMainWindow
A SAP Calendar.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPCalendar
A SAP grid view.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPGridView
A SAP password field.
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPPasswordField
A SAP textbox.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPTextBox
A SAP combobox.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPComboBox
A SAP OK Code Field.
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPOkCodeField
A SAP button.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPButton
A SAP checkbox.
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPCheckBox
A SAP radio button.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPRadioButton
A SAP Tab Strip
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPTabStrip
A SAP Tab
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPTab
A SAP Treeview
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPCtrlTree
A user area - the main area of the application.
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPUserArea
A splitter shell - the child panes should contain useful elements.
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPSplitter
A shell component.
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPGuiContainerShell
A toolbar - not useful directly, but should contain usable buttons.
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPToolbar
A menu bar
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPMenubar
A label
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPLabel
A table
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPTable
A scrollbar
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPScrollbar
A scroll container with (potentially) a horizontal and vertical scrollbar within.
Supports the following actions:
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPScrollContainer
An HTML viewer
Supports the following read actions:
Supports the following conditions:
Internal ID: SAPHTMLViewer
A generic SAP component
Supports the following read actions:
Supports the following conditions:
The following alternate types can be selected:
Internal ID: SAPComponent
Windows Application
Internal ID: Win32
My application is launched from an executable file
Internal ID: Win32Launch
My application will already be running - I want to attach to an existing instance
Internal ID: Win32Attach
Java-based Application
Internal ID: Java
My application is launched from an executable file
Internal ID: JavaLaunch
My application will already be running - I want to attach to an existing instance
Internal ID: JavaAttach
Browser-based Application (Chrome, Firefox)
Internal ID: Browser
A browser which is already running
Internal ID: BrowserAttach
A browser that is launched from an executable file
Internal ID: BrowserLaunch
Browser-based Application (Internet Explorer)
Internal ID: HTML
A browser which is already running
Internal ID: HTMLAttach
A browser that is launched from an executable file
Internal ID: HTMLLaunch
Mainframe Application
Internal ID: Mainframe
Generic HLLAPI
Internal ID: MainframeGEN
IBM iAccess For Windows (We do not currently support IBM iAccess Client Solutions) (EHLLAPI)
Internal ID: MainframeIAC
IBM Personal Communicator (COM API)
Internal ID: MainframeIBM
IBM Personal Communicator (HLLAPI)
Internal ID: MainframePCH
Micro Focus Attachmate Extra! X-treme 9.3 (ATMAPI32)
Internal ID: MainframeATM
Micro Focus Infoconnect (WinHLLAPI)
Internal ID: MainframeINF
Micro Focus Reflection 9.x and earlier (COM API)
Internal ID: MainframeART
Micro Focus Reflection for Desktop 16 (.NET API)
Internal ID: MainframeARN
NeoWare (later WallData) Rumba terminal emulator, via the HLLAPI interface. With version 6 (Rumba 2000) the working directory must be the one where the emulator's HLLAPI DLLs reside, otherwise attempting to connect results in an 'invalid presentation space' error message.
Internal ID: MainframeRUM
OpenText HostExplorer (formerly Hummingbird) (COM API)
Internal ID: MainframeHUM
OpenText HostExplorer (formerly Hummingbird) (EHLLAPI)
Internal ID: MainframeHEE
Ericom PowerTerm terminal emulator, via standard HLLAPI interface. Version 6 is not supported due to a flawed HLLAPI implementation. Version 9 is fully supported. The status of versions 7 and 8 is unknown.
Internal ID: MainframePWT
Pericom (later HP) TeemTalk terminal emulator, via the HLLAPI interface. Version 4 of TeemTalk does not work with HLLAPI when using IBM 5250 emulation. (See issue #4976). It is known to work with IBM 3270. The status for other emulation modes on that version is unknown.Support for HLLAPI was completely removed from TeemTalk from version 7 onwards. We have never tested with versions 5 and 6.
Internal ID: MainframeTMT
NDL Active Conductor (HLLAPI)
Internal ID: MainframeCON
RMD (HTTP/XML)
Internal ID: MainframeRMD
Rocket PASSPORT (COM API)
Internal ID: MainframePSS