You are on page 1of 154

Application Manager Operations

Actions
Get Window Attribute
Get the current value of a window attribute.

Parameters
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:

Edit elements (read stage)


Password elements (read stage)
List Box elements (read stage)
Radio button elements (read stage)
Check box elements (read stage)
Button elements (read stage)
Combo Box elements (read stage)
List View elements (read stage)
List View elements (read stage)
Tree View elements (read stage)
Tree View elements (read stage)
Status Bar elements (read stage)
Tab Control elements (read stage)
Track Bar elements (read stage)
Up-Down Box elements (read stage)
DateTime Picker elements (read stage)
Month Calendar Picker elements (read stage)
Scroll Bar elements (read stage)
Label elements (read stage)
Toolbar elements (read stage)
.NET DataGrid elements (read stage)
.NET DataGridView elements (read stage)
Window elements (read stage)
MSFlexGrid elements (read stage)
ApexGrid elements (read stage)
DTPicker elements (read stage)
Region elements (read stage)
List Region elements (read stage)
Grid Region elements (read stage)
Active Accessibility elements (read stage)
Button (AA) elements (read stage)
Check Box (AA) elements (read stage)
Combo Box (AA) elements (read stage)
List Box (AA) elements (read stage)
Radio Button (AA) elements (read stage)
Edit (AA) elements (read stage)

Get AA Attribute
Get the current value of an Active Accessibility attribute.

Parameters
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:

Active Accessibility elements (read stage)


Button (AA) elements (read stage)
Check Box (AA) elements (read stage)
Combo Box (AA) elements (read stage)
List Box (AA) elements (read stage)
Radio Button (AA) elements (read stage)
Edit (AA) elements (read stage)

Get HTML Attribute


Get the current value of an HTML attribute.

Parameters
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:

HTML Element elements (read stage)


HTML Button elements (read stage)
HTML Check Box elements (read stage)
HTML Radio Button elements (read stage)
HTML Edit elements (read stage)
HTML Combo Box elements (read stage)
HTML Table elements (read stage)

Get JAB Attribute


Get the current value of a Java Access Bridge attribute.

Parameters
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:

Edit (Java) elements (read stage)


Password Edit (Java) elements (read stage)
Check Box (Java) elements (read stage)
Radio Button (Java) elements (read stage)
Toggle Button (Java) elements (read stage)
Menu Item (Java) elements (read stage)
Menu (Java) elements (read stage)
Button (Java) elements (read stage)
Scrollbar (Java) elements (read stage)
ComboBox (Java) elements (read stage)
Dialog Window (Java) elements (read stage)
Tab Page Selector (Java) elements (read stage)
Progess Bar (Java) elements (read stage)
Track Bar (Java) elements (read stage)
Up-Down Box (Java) elements (read stage)
Table (Java) elements (read stage)
Tree View (Java) elements (read stage)
Tree Node (Java) elements (read stage)
List Box (Java) elements (read stage)
Tab Control (Java) elements (read stage)
Tool Bar (Java) elements (read stage)
Popup Menu (Java) elements (read stage)
Java elements (read stage)

Get Bounds
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:

Application elements (read stage)


Edit elements (read stage)
Password elements (read stage)
List Box elements (read stage)
Radio button elements (read stage)
Check box elements (read stage)
Check box (.NET) elements (read stage)
Button elements (read stage)
Combo Box elements (read stage)
List View elements (read stage)
List View elements (read stage)
Tree View elements (read stage)
Tree View elements (read stage)
Status Bar elements (read stage)
Tab Control elements (read stage)
Track Bar elements (read stage)
Up-Down Box elements (read stage)
DateTime Picker elements (read stage)
Month Calendar Picker elements (read stage)
Scroll Bar elements (read stage)
Label elements (read stage)
Link Label (.NET) elements (read stage)
Toolbar elements (read stage)
.NET DataGrid elements (read stage)
.NET DataGridView elements (read stage)
Window elements (read stage)
MSFlexGrid elements (read stage)
ApexGrid elements (read stage)
DTPicker elements (read stage)
Active Accessibility elements (read stage)
Button (AA) elements (read stage)
Check Box (AA) elements (read stage)
Combo Box (AA) elements (read stage)
List Box (AA) elements (read stage)
Radio Button (AA) elements (read stage)
Edit (AA) elements (read stage)
HTML Element elements (read stage)
HTML Button elements (read stage)
HTML Check Box elements (read stage)
HTML Radio Button elements (read stage)
HTML Edit elements (read stage)
HTML Combo Box elements (read stage)
HTML Table elements (read stage)
Edit (Java) elements (read stage)
Password Edit (Java) elements (read stage)
Check Box (Java) elements (read stage)
Radio Button (Java) elements (read stage)
Toggle Button (Java) elements (read stage)
Menu Item (Java) elements (read stage)
Menu (Java) elements (read stage)
Button (Java) elements (read stage)
Scrollbar (Java) elements (read stage)
ComboBox (Java) elements (read stage)
Dialog Window (Java) elements (read stage)
Tab Page Selector (Java) elements (read stage)
Progess Bar (Java) elements (read stage)
Track Bar (Java) elements (read stage)
Up-Down Box (Java) elements (read stage)
Table (Java) elements (read stage)
Tree View (Java) elements (read stage)
Tree Node (Java) elements (read stage)
List Box (Java) elements (read stage)
Tab Control (Java) elements (read stage)
Tool Bar (Java) elements (read stage)
Popup Menu (Java) elements (read stage)
Java elements (read stage)
SAP Status Bar elements (read stage)
SAP Title Bar elements (read stage)
SAP Main Window elements (read stage)
SAP Calendar elements (read stage)
SAP GridView elements (read stage)
SAP Password Field elements (read stage)
SAP TextBox elements (read stage)
SAP ComboBox elements (read stage)
SAP OK Code elements (read stage)
SAP Button elements (read stage)
SAP Check Box elements (read stage)
SAP Radio Button elements (read stage)
SAP Tab Strip elements (read stage)
SAP Tab elements (read stage)
SAP Treeview elements (read stage)
SAP User Area elements (read stage)
SAP Splitter Shell elements (read stage)
SAP Gui Container Shell elements (read stage)
SAP Toolbar elements (read stage)
SAP Menubar elements (read stage)
SAP Label elements (read stage)
SAP Table elements (read stage)
SAP Scrollbar elements (read stage)
SAP Scroll Container elements (read stage)
SAP HTML Viewer elements (read stage)
Generic SAP Component elements (read stage)

Get Relative Bounds


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:

Edit elements (read stage)


Password elements (read stage)
List Box elements (read stage)
Radio button elements (read stage)
Check box elements (read stage)
Button elements (read stage)
Combo Box elements (read stage)
List View elements (read stage)
List View elements (read stage)
Tree View elements (read stage)
Tree View elements (read stage)
Status Bar elements (read stage)
Tab Control elements (read stage)
Track Bar elements (read stage)
Up-Down Box elements (read stage)
DateTime Picker elements (read stage)
Month Calendar Picker elements (read stage)
Scroll Bar elements (read stage)
Label elements (read stage)
Toolbar elements (read stage)
.NET DataGrid elements (read stage)
.NET DataGridView elements (read stage)
Window elements (read stage)
MSFlexGrid elements (read stage)
ApexGrid elements (read stage)
DTPicker elements (read stage)

Get Screen Bounds


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:

Application elements (read stage)


Edit elements (read stage)
Password elements (read stage)
List Box elements (read stage)
Radio button elements (read stage)
Check box elements (read stage)
Check box (.NET) elements (read stage)
Button elements (read stage)
Combo Box elements (read stage)
List View elements (read stage)
List View elements (read stage)
Tree View elements (read stage)
Tree View elements (read stage)
Status Bar elements (read stage)
Tab Control elements (read stage)
Track Bar elements (read stage)
Up-Down Box elements (read stage)
DateTime Picker elements (read stage)
Month Calendar Picker elements (read stage)
Scroll Bar elements (read stage)
Label elements (read stage)
Link Label (.NET) elements (read stage)
Toolbar elements (read stage)
.NET DataGrid elements (read stage)
.NET DataGridView elements (read stage)
Window elements (read stage)
MSFlexGrid elements (read stage)
ApexGrid elements (read stage)
DTPicker elements (read stage)
Active Accessibility elements (read stage)
Button (AA) elements (read stage)
Check Box (AA) elements (read stage)
Combo Box (AA) elements (read stage)
List Box (AA) elements (read stage)
Radio Button (AA) elements (read stage)
Edit (AA) elements (read stage)
HTML Element elements (read stage)
HTML Button elements (read stage)
HTML Check Box elements (read stage)
HTML Radio Button elements (read stage)
HTML Edit elements (read stage)
HTML Combo Box elements (read stage)
HTML Table elements (read stage)
Edit (Java) elements (read stage)
Password Edit (Java) elements (read stage)
Check Box (Java) elements (read stage)
Radio Button (Java) elements (read stage)
Toggle Button (Java) elements (read stage)
Menu Item (Java) elements (read stage)
Menu (Java) elements (read stage)
Button (Java) elements (read stage)
Scrollbar (Java) elements (read stage)
ComboBox (Java) elements (read stage)
Dialog Window (Java) elements (read stage)
Tab Page Selector (Java) elements (read stage)
Progess Bar (Java) elements (read stage)
Track Bar (Java) elements (read stage)
Up-Down Box (Java) elements (read stage)
Table (Java) elements (read stage)
Tree View (Java) elements (read stage)
Tree Node (Java) elements (read stage)
List Box (Java) elements (read stage)
Tab Control (Java) elements (read stage)
Tool Bar (Java) elements (read stage)
Popup Menu (Java) elements (read stage)
Java elements (read stage)
SAP Status Bar elements (read stage)
SAP Title Bar elements (read stage)
SAP Main Window elements (read stage)
SAP Calendar elements (read stage)
SAP GridView elements (read stage)
SAP Password Field elements (read stage)
SAP TextBox elements (read stage)
SAP ComboBox elements (read stage)
SAP OK Code elements (read stage)
SAP Button elements (read stage)
SAP Check Box elements (read stage)
SAP Radio Button elements (read stage)
SAP Tab Strip elements (read stage)
SAP Tab elements (read stage)
SAP Treeview elements (read stage)
SAP User Area elements (read stage)
SAP Splitter Shell elements (read stage)
SAP Gui Container Shell elements (read stage)
SAP Toolbar elements (read stage)
SAP Menubar elements (read stage)
SAP Label elements (read stage)
SAP Table elements (read stage)
SAP Scrollbar elements (read stage)
SAP Scroll Container elements (read stage)
SAP HTML Viewer elements (read stage)
Generic SAP Component elements (read stage)

Get Bounds
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:

Region elements (read stage)

'''Global action''' - the target application must have focus.

Get Bounds
Gets information about the bounding rectangle of the element, in coordinates relative to the parent.

Parameters
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:

List Region elements (read stage)

'''Global action''' - the target application must have focus.

Get Bounds
Gets information about the bounding rectangle of the element, in coordinates relative to the parent.

Parameters
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:

Grid Region elements (read stage)

'''Global action''' - the target application must have focus.

Get Screen Bounds


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:

Region elements (read stage)

'''Global action''' - the target application must have focus.

Get Screen Bounds


Gets information about the bounding rectangle of the element, in screen coordinates.

Parameters
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:

List Region elements (read stage)

'''Global action''' - the target application must have focus.

Get Screen Bounds


Gets information about the bounding rectangle of the element, in screen coordinates.

Parameters
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:

Grid Region elements (read stage)

'''Global action''' - the target application must have focus.


Click Window
Send a click message to the window at the specified position. The position is relative to the top left of the window.

Parameters
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:

Edit elements
Password elements
List Box elements
Button elements
Combo Box elements
List View elements
Tree View elements
Tab Control elements
.NET DataGrid elements
.NET DataGridView elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Button (Java) elements

Click Window Centre


Send a click message to the centre of the window.

Parameters
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:

Edit elements
Password elements
List Box elements
Button elements
Combo Box elements
List View elements
Tree View elements
Tab Control elements
.NET DataGrid elements
.NET DataGridView elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Button (Java) elements

Global Mouse Click


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.

Parameters
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:

Edit elements
Password elements
List Box elements
Button elements
Combo Box elements
List View elements
Tree View elements
Tab Control elements
Label elements
Link Label (.NET) elements
.NET DataGrid elements
.NET DataGridView elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Edit (Java) elements
Password Edit (Java) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Scrollbar (Java) elements
ComboBox (Java) elements
Dialog Window (Java) elements
Tab Page Selector (Java) elements
Progess Bar (Java) elements
Track Bar (Java) elements
Up-Down Box (Java) elements
Table (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
List Box (Java) elements
Tab Control (Java) elements
Tool Bar (Java) elements
Popup Menu (Java) elements
Java elements

'''Global action''' - the target application must have focus.

Global Double Mouse Click


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.

Parameters
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:

Edit elements
Password elements
List Box elements
Button elements
Combo Box elements
List View elements
Tree View elements
Tab Control elements
Label elements
Link Label (.NET) elements
.NET DataGrid elements
.NET DataGridView elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Edit (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Tab Page Selector (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
List Box (Java) elements
Popup Menu (Java) elements
'''Global action''' - the target application must have focus.

Global Mouse Click Centre


Click the element at its centre, using a global mouse click.

Parameters
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:

Edit elements
Password elements
List Box elements
Button elements
Combo Box elements
List View elements
Tree View elements
Tab Control elements
Label elements
Link Label (.NET) elements
.NET DataGrid elements
.NET DataGridView elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Edit (Java) elements
Password Edit (Java) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Scrollbar (Java) elements
ComboBox (Java) elements
Dialog Window (Java) elements
Tab Page Selector (Java) elements
Progess Bar (Java) elements
Track Bar (Java) elements
Up-Down Box (Java) elements
Table (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
List Box (Java) elements
Tab Control (Java) elements
Tool Bar (Java) elements
Popup Menu (Java) elements
Java elements

'''Global action''' - the target application must have focus.

Global Double Mouse Click Centre


Double click the element at its centre, using a global mouse click.

Parameters
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:

Edit elements
Password elements
List Box elements
Button elements
Combo Box elements
List View elements
Tree View elements
Tab Control elements
Label elements
Link Label (.NET) elements
.NET DataGrid elements
.NET DataGridView elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Edit (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Tab Page Selector (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
List Box (Java) elements
Popup Menu (Java) elements

'''Global action''' - the target application must have focus.

Global Mouse Click


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.

Parameters
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:

Region elements

'''Global action''' - the target application must have focus.

Global Mouse Click


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.

Parameters
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:

List Region elements

'''Global action''' - the target application must have focus.

Global Mouse Click


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.

Parameters
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:

Grid Region elements

'''Global action''' - the target application must have focus.


Global Mouse Click Centre
Click the region at its centre, using a global mouse click. The mouse cursor will appear to jump across the screen during this method.

Parameters
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:

Region elements

'''Global action''' - the target application must have focus.

Global Mouse Click Centre


Click the region at its centre, using a global mouse click. The mouse cursor will appear to jump across the screen during this method.

Parameters
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:

List Region elements

'''Global action''' - the target application must have focus.

Global Mouse Click Centre


Click the region at its centre, using a global mouse click. The mouse cursor will appear to jump across the screen during this method.

Parameters
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:

Grid Region elements

'''Global action''' - the target application must have focus.


Click Centre
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:

Region elements

'''Global action''' - the target application must have focus.

Click Centre
Click the parent window of the region at the centre of the region.

Parameters
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:

List Region elements

'''Global action''' - the target application must have focus.

Click Centre
Click the parent window of the region at the centre of the region.

Parameters
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:

Grid Region elements

'''Global action''' - the target application must have focus.

Start Drag
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:

Region elements

'''Global action''' - the target application must have focus.

Start Drag
Start a drag-drop operation by dragging from the centre of the region. Must be followed by a drop operation on another element.

Parameters
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:

List Region elements

'''Global action''' - the target application must have focus.

Start Drag
Start a drag-drop operation by dragging from the centre of the region. Must be followed by a drop operation on another element.

Parameters
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:

Grid Region elements

'''Global action''' - the target application must have focus.

Drop Onto
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:

Region elements
'''Global action''' - the target application must have focus.

Drop Onto
End a drag-drop operation by dropping onto the region, at its centre. Must be preceded by a drag operation on another element.

Parameters
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:

List Region elements

'''Global action''' - the target application must have focus.

Drop Onto
End a drag-drop operation by dropping onto the region, at its centre. Must be preceded by a drag operation on another element.

Parameters
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:

Grid Region elements

'''Global action''' - the target application must have focus.

Drag
Start dragging from a given position over the window

Parameters
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:

Edit elements
Password elements
List Box elements
List View elements
Label elements
Link Label (.NET) elements
Window elements
Active Accessibility elements
HTML Element elements

'''Global action''' - the target application must have focus.

Drop
Drop at the given position over the window - must follow a drag

Parameters
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:

Edit elements
Password elements
List Box elements
List View elements
Label elements
Link Label (.NET) elements
Window elements
Active Accessibility elements
HTML Element elements

'''Global action''' - the target application must have focus.

Drag Listview Item


Start dragging the listview item with the specified text

Parameters
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:

List View elements

'''Global action''' - the target application must have focus.

Drop Onto Listview Item


Drop onto the listview item with the specified text - must follow a drag
Parameters
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:

List View elements

'''Global action''' - the target application must have focus.

Close
Asks a window to close.

This action takes no parameters

The internal ID for this action is 'CloseWindow'

Works with the following element types:

Window elements

Focus
Focuses an HTML element.

This action takes no parameters

The internal ID for this action is 'HTMLFocus'

Works with the following element types:

HTML Element elements

Press
Press a button

This action takes no parameters

The internal ID for this action is 'Press'

Works with the following element types:

Radio button elements


Check box elements
Button elements
Button (AA) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Button (Java) elements
SAP Button elements

'''Global action''' - the target application must have focus.

Set Field
Set the contents of a terminal field

Parameters
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 Field
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:

Field elements (read stage)

Search Terminal
Search the whole terminal for instances of the given text. Case insensitive.

Parameters
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:

Get Cursor Position


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:


Set Cursor Position
Sets the row/column position of the cursor in the presentation space

Parameters
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:

Get Window Title


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:

Set Window Title


Sets the title of the window in which the terminal emulator resides

Parameters
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:

Run Macro
Runs the specified macro defined on the emulator instance

Parameters
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 Text
Set the windowtext for a window.
Parameters
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 with OCR


Read text using OCR from a rectangular area on a window

Parameters
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:

Region elements (read stage)

'''Global action''' - the target application must have focus.

Read Text with OCR


Read text using OCR from a rectangular area on a window

Parameters
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:

List Region elements (read stage)

'''Global action''' - the target application must have focus.


Read Text with OCR
Read text using OCR from a rectangular area on a window

Parameters
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:

Grid Region elements (read stage)

'''Global action''' - the target application must have focus.

Read Text
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:

Region elements (read stage)

'''Global action''' - the target application must have focus.

Read Text
Read text discovered using invasive techniques within a rectangular area of a window

Parameters
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:

List Region elements (read stage)

'''Global action''' - the target application must have focus.


Read Text
Read text discovered using invasive techniques within a rectangular area of a window

Parameters
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:

Grid Region elements (read stage)

'''Global action''' - the target application must have focus.

Recognise Text
Read text using character matching from a rectangular area on a window

Parameters
Data
Name Description
Type
Font text The name of the font to use. Default is 'System'.
Colour text The text colour, e.g. FF0000. Default is black.
Background 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
Colour 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.

Recognise Text
Read text using character matching from a rectangular area on a window

Parameters
Data
Name Description
Type
Element number The 1-based number indicating which element of the list region to act on. Default is 1
Number
Font text The name of the font to use. Default is 'System'.
Colour text The text colour, e.g. FF0000. Default is black.
Background 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
Colour 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.

Recognise Text
Read text using character matching from a rectangular area on a window

Parameters
Data
Name Description
Type
Column number The 1-based column number indicating which column of the grid region to act on. Default is 1
Number
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 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
Colour 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.

Recognise Single Line Text


Read text using character matching from a rectangular area on a window, which is known to represent a single line of text.

Parameters
Data
Name Description
Type
Font text The name of the font to use.
Colour text The text colour, e.g. FF0000. Default is black.
Background 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
Colour 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.

Recognise Single Line Text


Read text using character matching from a rectangular area on a window, which is known to represent a single line of text.

Parameters
Data
Name Description
Type
Element number The 1-based number indicating which element of the list region to act on. Default is 1
Number
Font text The name of the font to use.
Colour text The text colour, e.g. FF0000. Default is black.
Background 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
Colour 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.

Recognise Single Line Text


Read text using character matching from a rectangular area on a window, which is known to represent a single line of text.

Parameters
Data
Name Description
Type
Column number The 1-based column number indicating which column of the grid region to act on. Default is 1
Number
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 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
Colour 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.

Recognise Multi-line Text


Read text using character matching from a rectangular area on a window, which is known to represent more than one line of text.

Parameters
Data
Name Description
Type
Font text The name of the font to use.
Colour text The text colour, e.g. FF0000. Default is black.
Background 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
Colour 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.

Recognise Multi-line Text


Read text using character matching from a rectangular area on a window, which is known to represent more than one line of text.

Parameters
Data
Name Description
Type
Element number The 1-based number indicating which element of the list region to act on. Default is 1
Number
Font text The name of the font to use.
Colour text The text colour, e.g. FF0000. Default is black.
Background 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
Colour 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.

Recognise Multi-line Text


Read text using character matching from a rectangular area on a window, which is known to represent more than one line of text.

Parameters
Data
Name Description
Type
Column number The 1-based column number indicating which column of the grid region to act on. Default is 1
Number
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 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
Colour 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.

Recognise Text
Read text using character matching from a rectangular area on a window
Parameters
Data
Name Description
Type
Font text The name of the font to use. Default is 'System'.
Colour text The text colour, e.g. FF0000. Default is black.
Background 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-
Colour 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 flag True to use the backwards compatible algorithm for reading characters which scans across then down. Default: False
Algorithm
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:

Region elements (read stage)

'''Global action''' - the target application must have focus.

Recognise Text
Read text using character matching from a rectangular area on a window

Parameters
Data
Name Description
Type
Element number The 1-based number indicating which element of the list region to act on. Default is 1
Number
Font text The name of the font to use. Default is 'System'.
Colour text The text colour, e.g. FF0000. Default is black.
Background 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-
Colour 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 flag True to use the backwards compatible algorithm for reading characters which scans across then down. Default: False
Algorithm
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:

List Region elements (read stage)

'''Global action''' - the target application must have focus.

Recognise Text
Read text using character matching from a rectangular area on a window
Parameters
Data
Name Description
Type
Column number The 1-based column number indicating which column of the grid region to act on. Default is 1
Number
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 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-
Colour 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 flag True to use the backwards compatible algorithm for reading characters which scans across then down. Default: False
Algorithm
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:

Grid Region elements (read stage)

'''Global action''' - the target application must have focus.

Read Image
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:

Region elements (read stage)

'''Global action''' - the target application must have focus.

Read Image
Read image from a rectangular area on a window

Parameters
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:

List Region elements (read stage)


'''Global action''' - the target application must have focus.

Read Image
Read image from a rectangular area on a window

Parameters
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:

Grid Region elements (read stage)

'''Global action''' - the target application must have focus.

Recognise Text In Range


Read text using character matching from a series of rectangular areas on a window, which are known to represent a single line of text.

Parameters
Data
Name Description
Type
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 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
Colour 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:

List Region elements (read stage)

'''Global action''' - the target application must have focus.

Recognise Text In Table


Reads the text in each cell defined in the grid region.

Parameters
Data
Name Description
Type
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 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
Colour 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:

Grid Region elements (read stage)

'''Global action''' - the target application must have focus.

Get Conflicting Font Characters


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.

Parameters
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:

Application elements (read stage)

Get Text
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:

Edit elements (read stage)


Password elements (read stage)
List Box elements (read stage)
Radio button elements (read stage)
Check box elements (read stage)
Check box (.NET) elements (read stage)
Button elements (read stage)
Combo Box elements (read stage)
List View elements (read stage)
List View elements (read stage)
Tree View elements (read stage)
Tree View elements (read stage)
Status Bar elements (read stage)
Tab Control elements (read stage)
Track Bar elements (read stage)
Up-Down Box elements (read stage)
DateTime Picker elements (read stage)
Month Calendar Picker elements (read stage)
Scroll Bar elements (read stage)
Label elements (read stage)
Toolbar elements (read stage)
.NET DataGrid elements (read stage)
.NET DataGridView elements (read stage)
Window elements (read stage)
MSFlexGrid elements (read stage)
ApexGrid elements (read stage)
DTPicker elements (read stage)
List Region elements (read stage)
Grid Region elements (read stage)
SAP Status Bar elements (read stage)
SAP Title Bar elements (read stage)
SAP TextBox elements (read stage)
SAP OK Code elements (read stage)
SAP Button elements (read stage)
SAP Check Box elements (read stage)
SAP Radio Button elements (read stage)
SAP Tab Strip elements (read stage)
SAP Tab elements (read stage)
SAP Label elements (read stage)

Get Win32 Parent Text


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:

Region elements (read stage)

Is Window Active
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:

Window elements (read stage)


Get Checked
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:

Radio button elements (read stage)


Check box elements (read stage)
SAP Check Box elements (read stage)
SAP Radio Button elements (read stage)

Get Checked
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:

Check box (.NET) elements (read stage)

Show Dropdown
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:

Combo Box elements

Hide Dropdown
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:

Combo Box elements

Get Text
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:

Edit (Java) elements (read stage)


Check Box (Java) elements (read stage)
Radio Button (Java) elements (read stage)
Toggle Button (Java) elements (read stage)
Menu (Java) elements (read stage)
Button (Java) elements (read stage)
ComboBox (Java) elements (read stage)
Tab Page Selector (Java) elements (read stage)
Up-Down Box (Java) elements (read stage)
Tree Node (Java) elements (read stage)
List Box (Java) elements (read stage)

Get Selected Text


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:

Edit (Java) elements (read stage)


Tree View (Java) elements (read stage)

Select Text
Select a portion of the text in an editable java element

Parameters
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:

Edit (Java) elements

Select All Text


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:

Edit (Java) elements

Get Checked
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:

Check Box (Java) elements (read stage)


Radio Button (Java) elements (read stage)

Set Checked
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:

Is Selected
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:

Tab Page Selector (Java) elements (read stage)


Tree Node (Java) elements (read stage)

Is Expanded
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:


Menu (Java) elements (read stage)
ComboBox (Java) elements (read stage)
Tree Node (Java) elements (read stage)

Hide Drop Down


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:

Menu (Java) elements


ComboBox (Java) elements

Show Drop Down


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:

Menu (Java) elements


ComboBox (Java) elements

Collapse Item
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:

Tree Node (Java) elements

Expand Item
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:


Tree Node (Java) elements

Toggle Item Expansion


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:

Tree Node (Java) elements

Select Item
Selects a java item identified by its text or its position - eg from a menu dropdown, a combo box, a tab control, etc

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 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:

ComboBox (Java) elements


Table (Java) elements
Tree View (Java) elements
List Box (Java) elements
Tab Control (Java) elements
Tool Bar (Java) elements
Popup Menu (Java) elements

Ensure Item Visible


Selects a java item identified by its text or its position - eg from a menu dropdown, a combo box, a tab control, etc

Parameters
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:

Tree View (Java) elements

Select All Items


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:

Table (Java) elements


List Box (Java) elements

Clear Selection
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:

Table (Java) elements


List Box (Java) elements

Count Selected Items


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:

Table (Java) elements (read stage)


Tree View (Java) elements (read stage)
Tree Node (Java) elements (read stage)
List Box (Java) elements (read stage)

Get All Items


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:

List Box elements (read stage)


Combo Box elements (read stage)
List View elements (read stage)
List View elements (read stage)
Status Bar elements (read stage)
Tab Control elements (read stage)
.NET DataGrid elements (read stage)
.NET DataGridView elements (read stage)
MSFlexGrid elements (read stage)
ApexGrid elements (read stage)
SAP GridView elements (read stage)
SAP ComboBox elements (read stage)
SAP Table elements (read stage)

Get Treenode Child Items


Gets all child items of the specified item in a treeview, as a collection.

Parameters
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:

Tree View elements (read stage)


Tree View elements (read stage)

Get Treenode Sibling Items


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.

Parameters
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:

Tree View elements (read stage)


Tree View elements (read stage)

Go To Cell
Set the current position to a particular cell

Parameters
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:

MSFlexGrid elements
ApexGrid elements

Set Top Row


Set the top visible row - this row may not actually go to the top if there are not enough rows below it.

Parameters
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:

MSFlexGrid elements

Get Row Offset


Get the offset, in pixels, of the top of the given row from the top of the grid.

Parameters
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:

MSFlexGrid elements (read stage)


ApexGrid elements (read stage)

Select Range
Select a range of cells

Parameters
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:

MSFlexGrid elements
Get Item
Gets all data associated with an item, as a collection (eg every column of a listview, for the item in question).

Parameters
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:

List View elements (read stage)

Get Selected Items


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:

List Box elements (read stage)


List View elements (read stage)

Is Item Selected
Reads the 'selected' value from a child of the chosen element. Eg from an item in a listview, etc

Parameters
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:

List Box elements (read stage)


List View elements (read stage)
Tree View elements (read stage)

Is Item Checked
Reads the 'checked' value from a child of the chosen element. Eg from an item in a listview, etc

Parameters
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:

List View elements (read stage)


Tree View elements (read stage)

Is Item Expanded
Reads the 'expanded' value from a child of the chosen element. Eg from an item in a treeview, etc

Parameters
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:

Tree View elements (read stage)

Is Item Focused
Reads the 'focused' value from a child of the chosen element. Eg from an item in a treeview, etc.

Parameters
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:

List View elements (read stage)


Tree View elements (read stage)

Get Item Image Index


Reads the Image Index of a child of the chosen element. Eg from an item in a listview, treeview, etc.

Parameters
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:

List View elements (read stage)

Get Current Value


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:

Link Label (.NET) elements (read stage)


HTML Element elements (read stage)
HTML Button elements (read stage)
HTML Check Box elements (read stage)
HTML Radio Button elements (read stage)
HTML Edit elements (read stage)
Password Edit (Java) elements (read stage)
Menu Item (Java) elements (read stage)
Dialog Window (Java) elements (read stage)
Tab Control (Java) elements (read stage)
Tool Bar (Java) elements (read stage)
Java elements (read stage)

Ensure Item Visible


Makes sure that the specified item is visible in a Listview or Treeview, by adjusting the scrollbars where necessary.

Parameters
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:

List View elements


Tree View elements

Scroll To Top
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:


Scroll To Bottom
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:

Count Items
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:

List Box elements (read stage)


Combo Box elements (read stage)
List View elements (read stage)
List View elements (read stage)
Tree View elements (read stage)
Tree View elements (read stage)
Tab Control elements (read stage)
Toolbar elements (read stage)
SAP ComboBox elements (read stage)
SAP Treeview elements (read stage)

Count Selected Items


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:

List Box elements (read stage)


List View elements (read stage)
Tree View elements (read stage)

Get Page Capacity


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:

List View elements (read stage)


Tree View elements (read stage)

Get Selected Item Text


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:

List Box elements (read stage)


Combo Box elements (read stage)
List View elements (read stage)
List View elements (read stage)
Tree View elements (read stage)
Tab Control elements (read stage)
SAP ComboBox elements (read stage)
SAP Treeview elements (read stage)

Expand Item
Expands the specified Treeview item.

Parameters
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:

Tree View elements


SAP Treeview elements

Collapse Item
Collapses the specified Treeview item.

Parameters
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:

Tree View elements


SAP Treeview elements

Toggle Item Expansion


Toggles the expanded state of the specified Treeview item.

Parameters
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:

Tree View elements

Get Value
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:

Track Bar elements (read stage)


Up-Down Box elements (read stage)
Scroll Bar elements (read stage)
SAP Scrollbar elements (read stage)

Set Value
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.

Parameters
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:

SAP Scrollbar elements

Get Max Value


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:

Track Bar elements (read stage)


Up-Down Box elements (read stage)
Scroll Bar elements (read stage)
SAP Scrollbar elements (read stage)

Get Min Value


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:

Track Bar elements (read stage)


Up-Down Box elements (read stage)
Scroll Bar elements (read stage)
SAP Scrollbar elements (read stage)

Get Value
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:

Progess Bar (Java) elements


Scrollbar (Java) elements (read stage)
Progess Bar (Java) elements (read stage)
Track Bar (Java) elements (read stage)
Up-Down Box (Java) elements (read stage)

Set Value
Sets the numeric value of a control such as a java trackbar, a java scrollbar or a java numeric up/down control.

Parameters
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:

Get Max Value


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:

Progess Bar (Java) elements


Scrollbar (Java) elements (read stage)
Progess Bar (Java) elements (read stage)
Track Bar (Java) elements (read stage)
Up-Down Box (Java) elements (read stage)

Get Min Value


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:

Progess Bar (Java) elements


Scrollbar (Java) elements (read stage)
Progess Bar (Java) elements (read stage)
Track Bar (Java) elements (read stage)
Up-Down Box (Java) elements (read stage)

Get Value
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:

DTPicker elements (read stage)

Get Value
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:

Month Calendar Picker elements


DateTime Picker elements (read stage)

Set Value
Sets the datetime value of a control such as a date picker.

Parameters
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:

Month Calendar Picker elements

Get Max Value


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:

Month Calendar Picker elements


DateTime Picker elements (read stage)

Get Min Value


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:

Month Calendar Picker elements


DateTime Picker elements (read stage)

Get Max Selected Value


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:


Month Calendar Picker elements

Get Min Selected Value


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:

Month Calendar Picker elements

Scroll To Minimum
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:

Scroll Bar elements

Scroll To Maximum
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:

Scroll Bar elements

Scroll By Amount
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.

Parameters
Data
Name Description
Type
Number of 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
Pages value indicates scrolling down/right.
The internal ID for this action is 'ScrollByAmount'

Works with the following element types:


Scroll Bar elements

Scroll To Minimum
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:

Scroll To Maximum
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:

Scroll By Amount
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.

Parameters
Data
Name Description
Type
Number of 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
Pages value indicates scrolling down/right.
The internal ID for this action is 'JABScrollByAmount'

Works with the following element types:

Multi Select Item


Adds the item to a multiple selection in a Windows ListBox that matches the given text.

Parameters
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:

List View elements


Select Item
Selects the item in a Windows ComboBox, ListBox, Listview or Treeview that matches the given text.

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.
The internal ID for this action is 'SelectItem'

Works with the following element types:

List Box elements


Combo Box elements
List View elements
Tree View elements
Tab Control elements
HTML Element elements
SAP ComboBox elements
SAP Tab Strip elements
SAP Treeview elements

Click Item
Clicks the item in a Windows Listview that matches the given text.

Parameters
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:

List View elements

Get Item Bounds


Gets the bounds of an item within a Listview, relative to the listview's top left corner.

Parameters
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:


List View elements (read stage)

Get Item Screen Bounds


Gets the bounds of an item within a Listview, in screen coordinates.

Parameters
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:

List View elements (read stage)

Select Tree Node


Selects a node in a TreeView.

Parameters
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:

Tree View elements

Click Item
Clicks the item in a Windows Toolbar (or similar) that matches the given text.

Parameters
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:

Toolbar elements

Is Button Enabled
Reads the 'enabled' value of a toolbar button.

Parameters
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:

Toolbar elements (read stage)

Is Button Checked
Reads the 'checked' value of a toolbar button.

Parameters
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:

Toolbar elements (read stage)

Is Button Pressed
Reads the 'pressed' value of a toolbar button.

Parameters
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:

Toolbar elements (read stage)

Select Menu Item


Selects the specified menu item from the main menu.

Parameters
Data
Name Description
Type
Menu 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
Path special "{","}" characters is the backslash: "\".
The internal ID for this action is 'SelectMenuItem'

Works with the following element types:

Window elements
SAP Menubar elements
Is Menu Item Checked
Reads the 'checked' value of a menu item.

Parameters
Data
Name Description
Type
Menu 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
Path special "{","}" characters is the backslash: "\".
The internal ID for this action is 'IsMenuItemChecked'

Works with the following element types:

Window elements (read stage)

Is Menu Item Enabled


Reads the 'enabled' value of a menu item.

Parameters
Data
Name Description
Type
Menu 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
Path special "{","}" characters is the backslash: "\".
The internal ID for this action is 'IsMenuItemEnabled'

Works with the following element types:

Window elements (read stage)

Click Tab
Sends a click message to a tab control, located at the centre of the specified tab.

Parameters
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:

Tab Control elements

Global Mouse Click Tab


Clicks a tab control, at the centre of the specified tab, using a global mouse click.
Parameters
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:

Tab Control elements

'''Global action''' - the target application must have focus.

Set Item Checked


Sets the 'checked' value of the item in a Windows Listview or Treeview that matches the given text.

Parameters
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:

List View elements


Tree View elements

'''Global action''' - the target application must have focus.

Select Item
Selects a child item identified by its text, or by its index - eg from a menu dropdown, or a combo box, etc

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 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:

Combo Box (AA) elements


List Box (AA) elements

Count Items
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:

Combo Box (AA) elements (read stage)


List Box (AA) elements (read stage)

Get All Items


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:

Combo Box (AA) elements (read stage)


List Box (AA) elements (read stage)

Get Selected Items


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:

Combo Box (AA) elements (read stage)


List Box (AA) elements (read stage)

Get Selected Item Text


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:

Combo Box (AA) elements (read stage)


List Box (AA) elements (read stage)

Get Current Value


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:

Active Accessibility elements (read stage)


Button (AA) elements (read stage)
Combo Box (AA) elements (read stage)
List Box (AA) elements (read stage)
Edit (AA) elements (read stage)

Get Checked
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:

Check Box (AA) elements (read stage)


Radio Button (AA) elements (read stage)

Show Dropdown
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:

Combo Box (AA) elements

Hide Dropdown
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:

Combo Box (AA) elements

Clear Selection
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:

List View elements

Set Checked
Sets the checked status of a radio button or checkbox

Parameters
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:

HTML Check Box elements


HTML Radio Button elements

Launch Mainframe
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 Mainframe
Attach to the target mainframe.

Parameters
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 Mainframe
Detach from the mainframe.

This action takes no parameters


The internal ID for this action is 'DetachMainframe'

Works with the following element types:

Terminate Mainframe
Terminate the mainframe.

This action takes no parameters

The internal ID for this action is 'TerminateMainframe'

Works with the following element types:

Launch
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:

Application elements

Attach
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).

Parameters
Name Data Type Description
Window 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
Titles (as field called "Window Title". A successful match amongst any of the patterns will cause the matching application to be attached. The wildcard characters "*", "?", "#" are
Collection) valid, and may be escaped with a backslash character ("\").
Window 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
Title character ("\").
Process text Optional parameter. A pattern specifying the process name of the application. The wildcard characters "*", "?", "#" are valid, and may be escaped with a backslash
Name 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:

Application elements
Detach
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:

Application elements

Terminate
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:

Application elements

Is Connected
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:

Application elements (read stage)

Global Send Keys


Send keys to the active application

Parameters
Data
Name Description
Type
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:

Application elements
SAP Main Window elements

'''Global action''' - the target application must have focus.

Global Send Key Events


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.

Parameters
Data
Name Description
Type
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:

Application elements

'''Global action''' - the target application must have focus.

Activate Application
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:

Window elements

Window Press Keys


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.

Parameters
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:


Edit elements
Password elements
List Box elements
Combo Box elements
List View elements
Window elements
Combo Box (AA) elements

Window Press Keys with Alt


Send keypresses to the given window with the alt key down

Parameters
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:

Edit elements
Password elements
Combo Box elements
Window elements
Combo Box (AA) elements

'''Global action''' - the target application must have focus.

Default
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:

Active Accessibility elements

Move
Move a window to the specified location.

Parameters
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:

Window elements

Resize
Resize a window.

Parameters
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:

Window elements

Maximise
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:

Window elements

Minimise
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:

Window elements

Restore
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:


Window elements

Hide All Windows


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:

Hide Window
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:

Window elements

Unhide Window
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:

Window elements

Is Window Hidden
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:

Window elements (read stage)

Do
Performs an action
Parameters
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:

Edit (Java) elements


Password Edit (Java) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Scrollbar (Java) elements
ComboBox (Java) elements
Dialog Window (Java) elements
Tab Page Selector (Java) elements
Progess Bar (Java) elements
Track Bar (Java) elements
Up-Down Box (Java) elements
Table (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
List Box (Java) elements
Tab Control (Java) elements
Tool Bar (Java) elements
Popup Menu (Java) elements
Java elements

Focus
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:

Edit (Java) elements


Password Edit (Java) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Scrollbar (Java) elements
ComboBox (Java) elements
Dialog Window (Java) elements
Tab Page Selector (Java) elements
Progess Bar (Java) elements
Track Bar (Java) elements
Up-Down Box (Java) elements
Table (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
List Box (Java) elements
Tab Control (Java) elements
Tool Bar (Java) elements
Popup Menu (Java) elements
Java elements

Select Tab
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:

Tab Page Selector (Java) elements

Count Items
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:

Menu (Java) elements (read stage)


ComboBox (Java) elements (read stage)
Table (Java) elements (read stage)
Tree View (Java) elements (read stage)
Tree Node (Java) elements (read stage)
List Box (Java) elements (read stage)
Popup Menu (Java) elements (read stage)

Get All Items


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:

Menu (Java) elements (read stage)


ComboBox (Java) elements (read stage)
Table (Java) elements (read stage)
List Box (Java) elements (read stage)
Popup Menu (Java) elements (read stage)

Get Selected Items


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:

ComboBox (Java) elements (read stage)


Table (Java) elements (read stage)
List Box (Java) elements (read stage)

Global Mouse Click Centre


Click at the centre of the Active Accessibility element.

Parameters
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:

Active Accessibility elements


Button (AA) elements
Combo Box (AA) elements
List Box (AA) elements
Edit (AA) elements

'''Global action''' - the target application must have focus.

Global Mouse Click


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.

Parameters
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:

Active Accessibility elements


Button (AA) elements
Combo Box (AA) elements
List Box (AA) elements
Edit (AA) elements

'''Global action''' - the target application must have focus.

Get Name
Gets the name of the Accessibility element. Some applications (incorrectly) 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:

Active Accessibility elements (read stage)


Button (AA) elements (read stage)
Check Box (AA) elements (read stage)
Combo Box (AA) elements (read stage)
List Box (AA) elements (read stage)
Radio Button (AA) elements (read stage)
Edit (AA) elements (read stage)

Get Description
Gets the description of the Accessibility element. Some applications (incorrectly) 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:

Active Accessibility elements (read stage)


Button (AA) elements (read stage)
Check Box (AA) elements (read stage)
Combo Box (AA) elements (read stage)
List Box (AA) elements (read stage)
Radio Button (AA) elements (read stage)
Edit (AA) elements (read stage)

Get Table
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:

Active Accessibility elements (read stage)


Button (AA) elements (read stage)
Edit (AA) elements (read stage)

Focus
Focus the Active Accessibility element.

This action takes no parameters

The internal ID for this action is 'AAFocus'

Works with the following element types:

Active Accessibility elements


Button (AA) elements
Combo Box (AA) elements
List Box (AA) elements
Edit (AA) elements

Global Send Keys


Send keys to the active application

Parameters
Data
Name Description
Type
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:

Active Accessibility elements


Button (AA) elements
Combo Box (AA) elements
List Box (AA) elements
Edit (AA) elements

'''Global action''' - the target application must have focus.

Get Document URL


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:

Application elements (read stage)


HTML Element elements (read stage)

Get Document URL Domain


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:

Application elements (read stage)


HTML Element elements (read stage)

Navigate
Navigate to a URL

Parameters
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:

Application elements
HTML Element elements

Click Centre
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:

HTML Element elements


HTML Button elements
HTML Check Box elements
HTML Radio Button elements
HTML Edit elements
HTML Combo Box elements
HTML Table elements

Double Click Centre


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:

HTML Element elements


HTML Button elements
HTML Check Box elements
HTML Radio Button elements
HTML Edit elements
HTML Combo Box elements
HTML Table elements

Get All Items


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:

HTML Combo Box elements (read stage)

Get Table
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:

HTML Element elements (read stage)


HTML Button elements (read stage)
HTML Check Box elements (read stage)
HTML Radio Button elements (read stage)
HTML Edit elements (read stage)
HTML Combo Box elements (read stage)
HTML Table elements (read stage)

Get Selected Items


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:

HTML Combo Box elements (read stage)

Get Selected Item Text


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:

HTML Combo Box elements (read stage)

Select Item
Selects the item in a ComboBox that matches the given parameters.

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:

HTML Combo Box elements

Count Items
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:

HTML Combo Box elements (read stage)

Count Selected Items


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:

HTML Combo Box elements (read stage)

Invoke Javascript Function


Calls the specified javascript function. This can be a standard javascript function, or one which is defined in the target HTML page.

Parameters
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:

Application elements
HTML Element elements

Insert Javascript Fragment


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.

Parameters
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:

Application elements
HTML Element elements

Update Cookie
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

Parameters
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:

Application elements

HTML Snapshot
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:

Application elements (read stage)

Source Capture
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:

Get HTML
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:

HTML Element elements (read stage)


HTML Button elements (read stage)
HTML Check Box elements (read stage)
HTML Radio Button elements (read stage)
HTML Edit elements (read stage)
HTML Combo Box elements (read stage)
HTML Table elements (read stage)

Get Path
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:

HTML Element elements (read stage)


HTML Button elements (read stage)
HTML Check Box elements (read stage)
HTML Radio Button elements (read stage)
HTML Edit elements (read stage)
HTML Combo Box elements (read stage)
HTML Table elements (read stage)

Snapshot
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:

Application elements (read stage)

Snapshot
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:

Click Link
Clicks a .Net Link Label

This action takes no parameters

The internal ID for this action is 'ClickLink'

Works with the following element types:

Link Label (.NET) elements

Read Text (DDE)


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:

DDE Element elements (read stage)

Execute Command (DDE)


Executes the command represented by the current DDE element.

Parameters
Data
Name Description
Type
Value text The value (if any) to supply to the DDE command.
No 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,
Check 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:

DDE Element elements

Verify
Verifies that an element exists, and optionally highlights the element

Parameters
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:

Edit elements
Password elements
List Box elements
Radio button elements
Check box elements
Check box (.NET) elements
Button elements
Combo Box elements
List View elements
List View elements
Tree View elements
Tree View elements
Status Bar elements
Tab Control elements
Track Bar elements
Up-Down Box elements
DateTime Picker elements
Month Calendar Picker elements
Scroll Bar elements
Label elements
Link Label (.NET) elements
Toolbar elements
.NET DataGrid elements
.NET DataGridView elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Field elements
Active Accessibility elements
Button (AA) elements
Check Box (AA) elements
Combo Box (AA) elements
List Box (AA) elements
Radio Button (AA) elements
Edit (AA) elements
HTML Element elements
HTML Button elements
HTML Check Box elements
HTML Radio Button elements
HTML Edit elements
HTML Combo Box elements
HTML Table elements
Edit (Java) elements
Password Edit (Java) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Scrollbar (Java) elements
ComboBox (Java) elements
Dialog Window (Java) elements
Tab Page Selector (Java) elements
Progess Bar (Java) elements
Track Bar (Java) elements
Up-Down Box (Java) elements
Table (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
List Box (Java) elements
Tab Control (Java) elements
Tool Bar (Java) elements
Popup Menu (Java) elements
Java elements

Verify
Verifies that an element exists, and optionally highlights the element
Parameters
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:

Region elements

'''Global action''' - the target application must have focus.

Verify
Verifies that an element exists, and optionally highlights the element

Parameters
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:

List Region elements

'''Global action''' - the target application must have focus.

Verify
Verifies that an element exists, and optionally highlights the element

Parameters
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:

Grid Region elements

'''Global action''' - the target application must have focus.

Select Date
Set the date range for a control

Parameters
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:

SAP Calendar elements

Get Date
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:

SAP Calendar elements (read stage)

Get Horizontal Minimum


Get the minimum horizontal value

This action takes no parameters

The internal ID for this action is 'GetHorizontalMin'

Works with the following element types:

SAP Scroll Container elements (read stage)

Get Horizontal Maximum


Get the maximum horizontal value

This action takes no parameters

The internal ID for this action is 'GetHorizontalMax'

Works with the following element types:

SAP Scroll Container elements (read stage)

Get Horizontal Value


Get the current horizontal value

This action takes no parameters


The internal ID for this action is 'GetHorizontalValue'

Works with the following element types:

SAP Scroll Container elements (read stage)

Set Horizontal Value


Set the horizontal value

Parameters
Name Data Type Description
Value number The new value
The internal ID for this action is 'SetHorizontalValue'

Works with the following element types:

SAP Scroll Container elements

Get Vertical Minimum


Get the minimum vertical value

This action takes no parameters

The internal ID for this action is 'GetVerticalMin'

Works with the following element types:

SAP Scroll Container elements (read stage)

Get Vertical Maximum


Get the maximum vertical value

This action takes no parameters

The internal ID for this action is 'GetVerticalMax'

Works with the following element types:

SAP Scroll Container elements (read stage)

Get Vertical Value


Get the current vertical value

This action takes no parameters

The internal ID for this action is 'GetVerticalValue'

Works with the following element types:


SAP Scroll Container elements (read stage)

Set Vertical Value


Set the vertical value

Parameters
Name Data Type Description
Value number The new value
The internal ID for this action is 'SetVerticalValue'

Works with the following element types:

SAP Scroll Container elements

Get Selected Node Key


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:

SAP Treeview elements (read stage)

Get Node Text


Get the text of the node with the specified key

Parameters
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:

SAP Treeview elements (read stage)

Double Click Node


Simulate double clicking the tree node

Parameters
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:

SAP Treeview elements

Select
Selects an item

This action takes no parameters

The internal ID for this action is 'Select'

Works with the following element types:

SAP Radio Button elements


SAP Tab elements

Select Item
Selects an item identified by its position.

Parameters
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:

SAP GridView elements

Get Cell Value


Returns the text value of the currently selected cell in a Grid.

Parameters
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:

SAP GridView elements (read stage)

Set Focus
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:

SAP TextBox elements

Conditions
Get Text
Compares against drawn text retrieved from a rectangular region

Works with the following element types:

Get Text
Compares against drawn text retrieved from a list element in a rectangular region

Works with the following element types:

Get Text
Compares against drawn text retrieved from a grid cell in a rectangular region

Works with the following element types:

Matches Image
Compares against an image retrieved from a rectangular region

Works with the following element types:

Region elements

Matches Image
Compares against an image retrieved from a list element in a rectangular region

Works with the following element types:

List Region elements

Matches Image
Compares against an image retrieved from a grid element in a rectangular region

Works with the following element types:


Grid Region elements

Contains Image
Determines if the region contains a particular image.

Works with the following element types:

Region elements

Contains Image
Determines if the specified element in the list region contains a particular image.

Works with the following element types:

List Region elements

Contains Image
Determines if the specified element in the grid region contains a particular image.

Works with the following element types:

Grid Region elements

Contains Colour
Determines if the region contains a particular colour.

Works with the following element types:

Region elements

Contains Colour
Determines if the specified element in the list region contains a particular colour.

Works with the following element types:

List Region elements

Contains Colour
Determines if the specified element in the grid region contains a particular colour.

Works with the following element types:

Grid Region elements


Uniform Colour
Determines if the region consists of a uniform colour.

Works with the following element types:

Region elements

Uniform Colour
Determines if the specified element in the list region consists of a uniform colour.

Works with the following element types:

List Region elements

Uniform Colour
Determines if the specified element in the grid region consists of a uniform colour.

Works with the following element types:

Grid Region elements

Recognise Text
Compares text using character matching from a rectangular area on a window

Works with the following element types:

Region elements

Recognise Text
Compares text using character matching from a list element in a rectangular area on a window

Works with the following element types:

List Region elements

Recognise Text
Compares text using character matching from a grid cell in a rectangular area on a window

Works with the following element types:

Grid Region elements

Get Text
Compares against text retrieved from a java element

Works with the following element types:

Edit (Java) elements


Password Edit (Java) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Scrollbar (Java) elements
ComboBox (Java) elements
Dialog Window (Java) elements
Tab Page Selector (Java) elements
Progess Bar (Java) elements
Track Bar (Java) elements
Up-Down Box (Java) elements
Table (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
Java elements

Count Items
Counts and returns the number of items contained in a listview or Treeview.

Works with the following element types:

List Box elements


List View elements
List View elements
Tree View elements
Tree View elements
Tab Control elements

IsFocused
Determines whether a java element is focused

Works with the following element types:

Edit (Java) elements


Password Edit (Java) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Scrollbar (Java) elements
ComboBox (Java) elements
Dialog Window (Java) elements
Tab Page Selector (Java) elements
Progess Bar (Java) elements
Track Bar (Java) elements
Up-Down Box (Java) elements
Table (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
Java elements

Get Field
Compares contents of a terminal field

Works with the following element types:

Field elements

Get Window Text


Compares main text of a window or control

Works with the following element types:

Edit elements
Password elements
List Box elements
Radio button elements
Check box elements
Button elements
Combo Box elements
List View elements
List View elements
Tree View elements
Tree View elements
Status Bar elements
Tab Control elements
Track Bar elements
Up-Down Box elements
DateTime Picker elements
Month Calendar Picker elements
Scroll Bar elements
Label elements
Toolbar elements
.NET DataGrid elements
.NET DataGridView elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Region elements
List Region elements
Grid Region elements

Check Exists
Check the element exists - True or False

Works with the following element types:

Edit elements
Password elements
List Box elements
Radio button elements
Check box elements
Check box (.NET) elements
Button elements
Combo Box elements
List View elements
List View elements
Tree View elements
Tree View elements
Tab Control elements
DateTime Picker elements
Label elements
Link Label (.NET) elements
Toolbar elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Region elements
Active Accessibility elements
Button (AA) elements
Check Box (AA) elements
Combo Box (AA) elements
List Box (AA) elements
Radio Button (AA) elements
Edit (AA) elements
HTML Element elements
HTML Button elements
HTML Check Box elements
HTML Radio Button elements
HTML Edit elements
HTML Combo Box elements
HTML Table elements
Edit (Java) elements
Password Edit (Java) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Scrollbar (Java) elements
ComboBox (Java) elements
Dialog Window (Java) elements
Tab Page Selector (Java) elements
Progess Bar (Java) elements
Track Bar (Java) elements
Up-Down Box (Java) elements
Table (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
List Box (Java) elements
Tab Control (Java) elements
Tool Bar (Java) elements
Popup Menu (Java) elements
Java elements
SAP Status Bar elements
SAP Title Bar elements
SAP Main Window elements
SAP Calendar elements
SAP GridView elements
SAP Password Field elements
SAP TextBox elements
SAP ComboBox elements
SAP OK Code elements
SAP Button elements
SAP Check Box elements
SAP Radio Button elements
SAP Tab Strip elements
SAP Tab elements
SAP Treeview elements
SAP User Area elements
SAP Splitter Shell elements
SAP Gui Container Shell elements
SAP Toolbar elements
SAP Menubar elements
SAP Label elements
SAP Table elements
SAP Scrollbar elements
SAP Scroll Container elements
SAP HTML Viewer elements
Generic SAP Component elements

Check Exists
Check that the Active Accessibility element exists - True or False

Works with the following element types:

Check Exists
Check that the Java element exists - True or False

Works with the following element types:

Check Exists
Check if the terminal field exists, with the text contained when spied - True or False

Works with the following element types:

Field elements

Checked
Check if the item (e.g a checkbox) is checked - True or False

Works with the following element types:

Radio button elements


Check box elements

Checked
Check if the item (e.g a checkbox) is checked - True or False

Works with the following element types:

Check box (.NET) elements

Document Loaded
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:

Application elements
HTML Element elements

Parent Document Loaded


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:

HTML Element elements


HTML Button elements
HTML Check Box elements
HTML Radio Button elements
HTML Edit elements
HTML Combo Box elements
HTML Table elements

Check URL
Check if the URL of the currently loaded document equals a particular value. Relevant only for browser applications

Works with the following element types:

Application elements
HTML Element elements

Check URL Domain


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:

Application elements
HTML Element elements

Check Value
Check if the HTML element is a specific value

Works with the following element types:

HTML Edit elements

Check DDE Element Readable


Checks whether the supplied DDE element can be located and its value can be read.

Works with the following element types:

DDE Element elements

Check DDE Topic Available


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:

DDE Element elements

Pressed
Check if the button has been pressed
Works with the following element types:

Button elements

MouseLeftDown
Check if the left mouse button has been pressed

Works with the following element types:

Button elements

Is Connected
Checks whether the business object is currently connected to the application (be it through launching or attaching).

Works with the following element types:

Check Window Active


Checks whether a window is the current active window - the window which receives user input.

Works with the following element types:

Window elements

Check Window Attribute


Check the current value of a window attribute.

Works with the following element types:

Edit elements
Password elements
List Box elements
Radio button elements
Check box elements
Button elements
Combo Box elements
List View elements
List View elements
Tree View elements
Tree View elements
Status Bar elements
Tab Control elements
Track Bar elements
Up-Down Box elements
DateTime Picker elements
Month Calendar Picker elements
Scroll Bar elements
Label elements
Toolbar elements
.NET DataGrid elements
.NET DataGridView elements
Window elements
MSFlexGrid elements
ApexGrid elements
DTPicker elements
Region elements
List Region elements
Grid Region elements
Active Accessibility elements
Button (AA) elements
Check Box (AA) elements
Combo Box (AA) elements
List Box (AA) elements
Radio Button (AA) elements
Edit (AA) elements

Check AA Attribute
Get the current value of an Active Accessibility attribute.

Works with the following element types:

Active Accessibility elements


Button (AA) elements
Check Box (AA) elements
Combo Box (AA) elements
List Box (AA) elements
Radio Button (AA) elements
Edit (AA) elements

Check HTML Attribute


Get the current value of an HTML attribute.

Works with the following element types:

HTML Element elements


HTML Button elements
HTML Check Box elements
HTML Radio Button elements
HTML Edit elements
HTML Combo Box elements
HTML Table elements

Check JAB Attribute


Get the current value of a Java Access Bridge attribute.

Works with the following element types:


Edit (Java) elements
Password Edit (Java) elements
Check Box (Java) elements
Radio Button (Java) elements
Toggle Button (Java) elements
Menu Item (Java) elements
Menu (Java) elements
Button (Java) elements
Scrollbar (Java) elements
ComboBox (Java) elements
Dialog Window (Java) elements
Tab Page Selector (Java) elements
Progess Bar (Java) elements
Track Bar (Java) elements
Up-Down Box (Java) elements
Table (Java) elements
Tree View (Java) elements
Tree Node (Java) elements
List Box (Java) elements
Tab Control (Java) elements
Tool Bar (Java) elements
Popup Menu (Java) elements
Java elements

Element Types
Application
An element representing the target application as a whole.

Supports the following actions:

Launch
Attach
Detach
Terminate
Global Send Keys
Global Send Key Events
Navigate
Invoke Javascript Function
Insert Javascript Fragment
Update Cookie

Supports the following read actions:

Get Document URL


Get Document URL Domain
HTML Snapshot
Snapshot
Is Connected
Get Conflicting Font Characters
Get Bounds
Get Screen Bounds

Supports the following conditions:

Document Loaded
Check URL Domain
Check URL

Internal ID: Application

Edit
A standard Windows text edit field.

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Drag
Drop
Window Press Keys
Window Press Keys with Alt
Verify

Supports the following read actions:

Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Window Text
Check Window Attribute

The following alternate types can be selected:

Password

Internal ID: Edit

Password
A Windows password text box.
Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Drag
Drop
Window Press Keys
Window Press Keys with Alt
Verify

Supports the following read actions:

Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Window Text
Check Window Attribute

The following alternate types can be selected:

Edit

Internal ID: Password

List Box
A standard Windows List Box.

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Drag
Drop
Select Item
Window Press Keys
Verify

Supports the following read actions:


Count Items
Count Selected Items
Get All Items
Get Selected Items
Get Selected Item Text
Is Item Selected
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Count Items
Get Window Text
Check Window Attribute

Internal ID: ListBox

Radio button
A standard Windows Radio Button

Supports the following actions:

Press
Verify

Supports the following read actions:

Get Checked
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Checked
Get Window Text
Check Window Attribute

Internal ID: RadioButton

Check box
A standard Windows check box

Supports the following actions:


Press
Verify

Supports the following read actions:

Get Checked
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Checked
Get Window Text
Check Window Attribute

Internal ID: CheckBox

Check box (.NET)


A .NET check box

Supports the following actions:

Verify

Supports the following read actions:

Get Checked
Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Checked

Internal ID: NetCheckBox

Button
A standard Windows Button

Supports the following actions:

Press
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click Centre
Global Double Mouse Click
Click Window
Click Window Centre
Verify

Supports the following read actions:

Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Pressed
MouseLeftDown
Get Window Text
Check Window Attribute

The following alternate types can be selected:

Radio button
Check box
Check box (.NET)

Internal ID: Button

Combo Box
A standard Windows Combo Box

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Select Item
Show Dropdown
Hide Dropdown
Window Press Keys
Window Press Keys with Alt
Verify

Supports the following read actions:

Count Items
Get All Items
Get Selected Item Text
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Window Text
Check Window Attribute

Internal ID: ComboBox

List View
A standard Windows List View

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Drag
Drop
Drag Listview Item
Drop Onto Listview Item
Multi Select Item
Select Item
Click Item
Set Item Checked
Clear Selection
Window Press Keys
Ensure Item Visible
Verify

Supports the following read actions:

Count Items
Count Selected Items
Get All Items
Get Item
Get Selected Items
Get Selected Item Text
Get Page Capacity
Is Item Selected
Is Item Checked
Is Item Focused
Get Item Bounds
Get Item Screen Bounds
Get Item Image Index
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Count Items
Get Window Text
Check Window Attribute

Internal ID: ListView

List View
An ActiveX List View

Supports the following actions:

Verify

Supports the following read actions:

Count Items
Get Selected Item Text
Get All Items
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Count Items
Get Window Text
Check Window Attribute

Internal ID: ListViewAx

Tree View
A standard Windows Tree View

Supports the following actions:

Select Item
Set Item Checked
Ensure Item Visible
Expand Item
Collapse Item
Toggle Item Expansion
Verify

Supports the following read actions:

Count Items
Get Treenode Child Items
Get Treenode Sibling Items
Count Selected Items
Get Selected Item Text
Get Page Capacity
Is Item Checked
Is Item Selected
Is Item Expanded
Is Item Focused
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Count Items
Get Window Text
Check Window Attribute

Internal ID: Treeview

Tree View
An ActiveX Tree View

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Select Tree Node
Verify

Supports the following read actions:

Count Items
Get Treenode Child Items
Get Treenode Sibling Items
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Count Items
Get Window Text
Check Window Attribute

Internal ID: TreeviewAx

Status Bar
An ActiveX Status Bar

Supports the following actions:

Verify

Supports the following read actions:

Get All Items


Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Get Window Text


Check Window Attribute

Internal ID: StatusBarAx

Tab Control
A standard Windows Tab Control

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Select Item
Click Tab
Global Mouse Click Tab
Verify

Supports the following read actions:

Get All Items


Get Selected Item Text
Count Items
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Count Items
Get Window Text
Check Window Attribute

Internal ID: TabControl

Track Bar
A standard Windows Track Bar Control

Supports the following actions:

Verify

Supports the following read actions:

Get Max Value


Get Value
Get Min Value
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Get Window Text


Check Window Attribute

Internal ID: TrackBar

Up-Down Box
A standard Windows Up-Down Control

Supports the following actions:


Verify

Supports the following read actions:

Get Max Value


Get Value
Get Min Value
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Get Window Text


Check Window Attribute

Internal ID: UpDown

DateTime Picker
A standard Windows DateTime-Picker Control

Supports the following actions:

Verify

Supports the following read actions:

Get Value
Get Max Value
Get Min Value
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Window Text
Check Window Attribute

Internal ID: DateTimePicker

Month Calendar Picker


A standard Windows Month Calendar Picker Control

Supports the following actions:


Get Value
Set Value
Get Max Value
Get Min Value
Get Max Selected Value
Get Min Selected Value
Verify

Supports the following read actions:

Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Get Window Text


Check Window Attribute

Internal ID: MonthCalPicker

Scroll Bar
A standard Windows Scroll Bar

Supports the following actions:

Scroll To Minimum
Scroll To Maximum
Scroll By Amount
Verify

Supports the following read actions:

Get Max Value


Get Value
Get Min Value
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Get Window Text


Check Window Attribute

Internal ID: ScrollBar

Label
A standard Windows Label

Supports the following actions:

Global Mouse Click


Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Drag
Drop
Verify

Supports the following read actions:

Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Window Text
Check Window Attribute

Internal ID: Label

Link Label (.NET)


A standard .NET Link Label

Supports the following actions:

Click Link
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Drag
Drop
Verify

Supports the following read actions:

Get Current Value


Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: NetLinkLabel


Toolbar
A standard Windows Toolbar

Supports the following actions:

Click Item
Verify

Supports the following read actions:

Count Items
Is Button Enabled
Is Button Checked
Is Button Pressed
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Window Text
Check Window Attribute

Internal ID: Toolbar

.NET DataGrid
A .NET DataGrid control

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Verify

Supports the following read actions:

Get All Items


Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:


Get Window Text
Check Window Attribute

Internal ID: DataGrid

.NET DataGridView
A .NET DataGridView control

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Verify

Supports the following read actions:

Get All Items


Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Get Window Text


Check Window Attribute

Internal ID: DataGridView

Window
A standard Windows Window.

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Drag
Drop
Window Press Keys
Window Press Keys with Alt
Activate Application
Close
Move
Resize
Maximise
Minimise
Restore
Hide Window
Unhide Window
Select Menu Item
Verify

Supports the following read actions:

Is Menu Item Checked


Is Menu Item Enabled
Is Window Active
Is Window Hidden
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check Window Active
Get Window Text
Check Window Attribute

The following alternate types can be selected:

.NET DataGrid
.NET DataGridView
Radio button
Check box
Button
Edit
List Box
Combo Box
List View
Tree View
Tab Control
Track Bar
Up-Down Box
DateTime Picker
Month Calendar Picker
Scroll Bar
Label
Toolbar

Internal ID: Window

MSFlexGrid
A Microsoft FlexGrid ActiveX Control

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Go To Cell
Select Range
Set Top Row
Verify

Supports the following read actions:

Get All Items


Get Row Offset
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Window Text
Check Window Attribute

Internal ID: MSFlexGrid

ApexGrid
An Apex Grid ActiveX Control

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Go To Cell
Verify

Supports the following read actions:

Get All Items


Get Row Offset
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Window Text
Check Window Attribute

Internal ID: ApexGrid

DTPicker
A VB6 Date Picker control

Supports the following actions:

Click Window
Click Window Centre
Global Mouse Click
Global Mouse Click Centre
Global Double Mouse Click
Global Double Mouse Click Centre
Verify

Supports the following read actions:

Get Value
Get Text
Get Window Attribute
Get Relative Bounds
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Window Text
Check Window Attribute

Internal ID: DTPicker

Region
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:

Global Mouse Click Centre


Global Mouse Click
Click Centre
Start Drag
Drop Onto
Verify

Supports the following read actions:

Read Text
Get Win32 Parent Text
Recognise Text
Read Image
Read Text with OCR
Get Window Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Matches Image
Contains Image
Contains Colour
Uniform Colour
Recognise Text
Check Exists
Get Window Text
Check Window Attribute

Internal ID: WindowRect

List Region
A list of contiguous regions within a window

Supports the following actions:

Global Mouse Click Centre


Global Mouse Click
Click Centre
Start Drag
Drop Onto
Verify

Supports the following read actions:

Read Text
Recognise Text
Read Image
Recognise Text In Range
Read Text with OCR
Get Text
Get Window Attribute
Get Bounds
Get Screen Bounds
Supports the following conditions:

Matches Image
Contains Image
Contains Colour
Uniform Colour
Recognise Text
Get Window Text
Check Window Attribute

Internal ID: Win32ListRegion

Grid Region
A table of regions within a window

Supports the following actions:

Global Mouse Click Centre


Global Mouse Click
Click Centre
Start Drag
Drop Onto
Verify

Supports the following read actions:

Read Text
Recognise Text
Read Image
Recognise Text In Table
Read Text with OCR
Get Text
Get Window Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Matches Image
Contains Image
Contains Colour
Uniform Colour
Recognise Text
Get Window Text
Check Window Attribute

Internal ID: Win32GridRegion

Field
A terminal emulator field
Supports the following actions:

Verify

Supports the following read actions:

Read Field

Supports the following conditions:

Check Exists
Get Field

Internal ID: TerminalField

Active Accessibility
An Active Accessibility element.

Supports the following actions:

Global Mouse Click Centre


Global Mouse Click
Default
Drag
Drop
Focus
Global Send Keys
Verify

Supports the following read actions:

Get Name
Get Current Value
Get Description
Get Table
Get Window Attribute
Get AA Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check Window Attribute
Check AA Attribute

The following alternate types can be selected:

Button (AA)
Check Box (AA)
Combo Box (AA)
List Box (AA)
Radio Button (AA)
Edit (AA)

Internal ID: AAElement

Button (AA)
An Active Accessibility Button element.

Supports the following actions:

Focus
Press
Global Mouse Click Centre
Global Mouse Click
Global Send Keys
Verify

Supports the following read actions:

Get Name
Get Current Value
Get Description
Get Table
Get Window Attribute
Get AA Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check Window Attribute
Check AA Attribute

The following alternate types can be selected:

Active Accessibility

Internal ID: AAButton

Check Box (AA)


An Active Accessibility Checkbox element.

Supports the following actions:

Verify

Supports the following read actions:

Get Name
Get Checked
Get Description
Get Window Attribute
Get AA Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check Window Attribute
Check AA Attribute

The following alternate types can be selected:

Active Accessibility

Internal ID: AACheckBox

Combo Box (AA)


An Active Accessibility Combo Box element.

Supports the following actions:

Global Mouse Click Centre


Focus
Global Mouse Click
Select Item
Show Dropdown
Global Send Keys
Hide Dropdown
Window Press Keys
Window Press Keys with Alt
Verify

Supports the following read actions:

Get All Items


Get Selected Items
Count Items
Get Selected Item Text
Get Current Value
Get Name
Get Description
Get Window Attribute
Get AA Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check Window Attribute
Check AA Attribute
The following alternate types can be selected:

Active Accessibility

Internal ID: AAComboBox

List Box (AA)


An Active Accessibility List Box element.

Supports the following actions:

Focus
Select Item
Global Mouse Click Centre
Global Mouse Click
Global Send Keys
Verify

Supports the following read actions:

Get All Items


Get Selected Items
Count Items
Get Selected Item Text
Get Current Value
Get Name
Get Description
Get Window Attribute
Get AA Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check Window Attribute
Check AA Attribute

The following alternate types can be selected:

Active Accessibility

Internal ID: AAListBox

Radio Button (AA)


An Active Accessibility Radio button element.

Supports the following actions:

Verify
Supports the following read actions:

Get Name
Get Checked
Get Description
Get Window Attribute
Get AA Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check Window Attribute
Check AA Attribute

The following alternate types can be selected:

Active Accessibility

Internal ID: AARadioButton

Edit (AA)
An Active Accessibility Edit box element.

Supports the following actions:

Global Mouse Click Centre


Focus
Global Mouse Click
Global Send Keys
Verify

Supports the following read actions:

Get Name
Get Current Value
Get Description
Get Table
Get Window Attribute
Get AA Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check Window Attribute
Check AA Attribute

The following alternate types can be selected:

Active Accessibility
Internal ID: AAEdit

HTML Element
An HTML DOM element.

Supports the following actions:

Drag
Drop
Select Item
Focus
Navigate
Invoke Javascript Function
Insert Javascript Fragment
Click Centre
Double Click Centre
Verify

Supports the following read actions:

Get Document URL


Get Document URL Domain
Get Current Value
Get HTML
Get Path
Get Table
Get HTML Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Parent Document Loaded
Document Loaded
Check URL Domain
Check URL
Check HTML Attribute

The following alternate types can be selected:

HTML Button
HTML Check Box
HTML Radio Button
HTML Edit
HTML Combo Box
HTML Table

Internal ID: HTML

HTML Button
An HTML Button element.

Supports the following actions:

Click Centre
Double Click Centre
Verify

Supports the following read actions:

Get HTML
Get Current Value
Get Path
Get Table
Get HTML Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Parent Document Loaded
Check HTML Attribute

The following alternate types can be selected:

HTML Element

Internal ID: HTMLButton

HTML Check Box


An HTML Checkbox element.

Supports the following actions:

Set Checked
Click Centre
Double Click Centre
Verify

Supports the following read actions:

Get HTML
Get Current Value
Get Path
Get Table
Get HTML Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Parent Document Loaded
Check HTML Attribute

The following alternate types can be selected:

HTML Element

Internal ID: HTMLCheckBox

HTML Radio Button


An HTML Radio button element.

Supports the following actions:

Set Checked
Click Centre
Double Click Centre
Verify

Supports the following read actions:

Get HTML
Get Current Value
Get Path
Get Table
Get HTML Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Parent Document Loaded
Check HTML Attribute

The following alternate types can be selected:

HTML Element

Internal ID: HTMLRadioButton

HTML Edit
An HTML Edit box element.

Supports the following actions:

Click Centre
Double Click Centre
Verify

Supports the following read actions:


Get HTML
Get Current Value
Get Path
Get Table
Get HTML Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Parent Document Loaded
Check Value
Check HTML Attribute

The following alternate types can be selected:

HTML Element

Internal ID: HTMLEdit

HTML Combo Box


An HTML Combo box element.

Supports the following actions:

Select Item
Click Centre
Double Click Centre
Verify

Supports the following read actions:

Count Items
Count Selected Items
Get All Items
Get Selected Items
Get Selected Item Text
Get HTML
Get Path
Get Table
Get HTML Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Parent Document Loaded
Check HTML Attribute

The following alternate types can be selected:


HTML Element

Internal ID: HTMLCombo

HTML Table
An HTML Table element.

Supports the following actions:

Click Centre
Double Click Centre
Verify

Supports the following read actions:

Get Table
Get HTML
Get Path
Get HTML Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Parent Document Loaded
Check HTML Attribute

The following alternate types can be selected:

HTML Element

Internal ID: HTMLTable

Edit (Java)
A Java edit box.

Supports the following actions:

Select Text
Select All Text
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click
Global Double Mouse Click Centre
Do
Focus
Verify

Supports the following read actions:


Get Text
Get Selected Text
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

The following alternate types can be selected:

Password Edit (Java)

Internal ID: JavaEdit

Password Edit (Java)


A Java password edit field.

Supports the following actions:

Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Current Value


Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

The following alternate types can be selected:

Edit (Java)

Internal ID: JavaPasswordEdit

Check Box (Java)


A Java check box.

Supports the following actions:

Press
Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Checked
Get Text
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaCheckBox

Radio Button (Java)


A Java radio button.

Supports the following actions:

Press
Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Checked
Get Text
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaRadioButton

Toggle Button (Java)


A toggle button - ie a button that retains its pressed state until it is pressed again.

Supports the following actions:

Press
Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Text
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaToggleButton

Menu Item (Java)


A Java menu item.

Supports the following actions:

Press
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click
Global Double Mouse Click Centre
Do
Focus
Verify

Supports the following read actions:

Get Current Value


Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaMenuItem

Menu (Java)
A Java menu, often found at the top of a main application window.

Supports the following actions:

Hide Drop Down


Show Drop Down
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click
Global Double Mouse Click Centre
Do
Focus
Verify

Supports the following read actions:

Is Expanded
Get Text
Count Items
Get All Items
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaMenu

Button (Java)
A Java button.

Supports the following actions:

Press
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click Centre
Global Double Mouse Click
Click Window
Click Window Centre
Do
Focus
Verify

Supports the following read actions:

Get Text
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

The following alternate types can be selected:

Radio Button (Java)


Check Box (Java)
Toggle Button (Java)
Menu Item (Java)
Menu (Java)

Internal ID: JavaButton

Scrollbar (Java)
A Java scrollbar.

Supports the following actions:

Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Max Value


Get Value
Get Min Value
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaScrollBar

ComboBox (Java)
A Java combobox.

Supports the following actions:

Show Drop Down


Hide Drop Down
Select Item
Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Text
Count Items
Get All Items
Get Selected Items
Is Expanded
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaComboBox

Dialog Window (Java)


A dialog window, as often used in pop-up forms.

Supports the following actions:

Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Current Value


Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaDialog

Tab Page Selector (Java)


A tab in a tab control, which when selected changes the currently viewed page.

Supports the following actions:

Select Tab
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click
Global Double Mouse Click Centre
Do
Focus
Verify

Supports the following read actions:

Get Text
Is Selected
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaTabSelector


Progess Bar (Java)
A Java progress bar.

Supports the following actions:

Get Value
Get Max Value
Get Min Value
Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Max Value


Get Value
Get Min Value
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaProgressBar

Track Bar (Java)


A track bar control, which consists of a pointer on a sliding scale to indicate a numeric value.

Supports the following actions:

Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Max Value


Get Value
Get Min Value
Get JAB Attribute
Get Bounds
Get Screen Bounds
Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaTrackBar

Up-Down Box (Java)


An up-down box, consisting of a textbox with some up/down buttons for adjusting the value in the box.

Supports the following actions:

Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Max Value


Get Value
Get Text
Get Min Value
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaUpDown

Table (Java)
A java table - an analogous control to the windows listview, when viewed in details mode.

Supports the following actions:

Select All Items


Clear Selection
Select Item
Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Count Items
Count Selected Items
Get All Items
Get Selected Items
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaTable

Tree View (Java)


A java tree view.

Supports the following actions:

Select Item
Ensure Item Visible
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click
Global Double Mouse Click Centre
Do
Focus
Verify

Supports the following read actions:

Count Items
Count Selected Items
Get Selected Text
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaTreeView


Tree Node (Java)
A java tree view node.

Supports the following actions:

Expand Item
Collapse Item
Toggle Item Expansion
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click
Global Double Mouse Click Centre
Do
Focus
Verify

Supports the following read actions:

Get Text
Is Expanded
Is Selected
Count Items
Count Selected Items
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

Internal ID: JavaTreeNode

List Box (Java)


A java list box.

Supports the following actions:

Select Item
Select All Items
Clear Selection
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click
Global Double Mouse Click Centre
Do
Focus
Verify
Supports the following read actions:

Count Selected Items


Count Items
Get All Items
Get Selected Items
Get Text
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check JAB Attribute

Internal ID: JavaListBox

Tab Control (Java)


A java tab control.

Supports the following actions:

Select Item
Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Current Value


Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check JAB Attribute

Internal ID: JavaTabControl

Tool Bar (Java)


A java tool bar.

Supports the following actions:

Select Item
Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Current Value


Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check JAB Attribute

Internal ID: JavaToolBar

Popup Menu (Java)


A Java popup menu.

Supports the following actions:

Select Item
Global Mouse Click Centre
Global Mouse Click
Global Double Mouse Click
Global Double Mouse Click Centre
Do
Focus
Verify

Supports the following read actions:

Count Items
Get All Items
Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Check JAB Attribute

Internal ID: JavaPopupMenu

Java
A Java element.
Supports the following actions:

Do
Focus
Global Mouse Click
Global Mouse Click Centre
Verify

Supports the following read actions:

Get Current Value


Get JAB Attribute
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists
Get Text
IsFocused
Check JAB Attribute

The following alternate types can be selected:

Edit (Java)
Password Edit (Java)
Check Box (Java)
Radio Button (Java)
Toggle Button (Java)
Menu Item (Java)
Menu (Java)
Button (Java)
Scrollbar (Java)
ComboBox (Java)
Dialog Window (Java)
Tab Page Selector (Java)
Progess Bar (Java)
Track Bar (Java)
Up-Down Box (Java)
Table (Java)
Tree View (Java)
Tree Node (Java)
List Box (Java)
Tab Control (Java)
Tool Bar (Java)
Popup Menu (Java)

Internal ID: Java

DDE Element
A Dynamic Data Exchange (DDE) field.
Supports the following actions:

Execute Command (DDE)

Supports the following read actions:

Read Text (DDE)

Supports the following conditions:

Check DDE Topic Available


Check DDE Element Readable

Internal ID: DDEElement

SAP Status Bar


A SAP Status Bar.

Supports the following read actions:

Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPStatusBar

SAP Title Bar


A SAP Title Bar.

Supports the following read actions:

Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPTitleBar

SAP Main Window


A SAP Main Window.

Supports the following actions:


Global Send Keys

Supports the following read actions:

Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPMainWindow

SAP Calendar
A SAP Calendar.

Supports the following actions:

Select Date

Supports the following read actions:

Get Date
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPCalendar

SAP GridView
A SAP grid view.

Supports the following actions:

Select Item

Supports the following read actions:

Get All Items


Get Cell Value
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPGridView


SAP Password Field
A SAP password field.

Supports the following read actions:

Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPPasswordField

SAP TextBox
A SAP textbox.

Supports the following actions:

Set Focus

Supports the following read actions:

Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPTextBox

SAP ComboBox
A SAP combobox.

Supports the following actions:

Select Item

Supports the following read actions:

Count Items
Get Selected Item Text
Get All Items
Get Bounds
Get Screen Bounds

Supports the following conditions:


Check Exists

Internal ID: SAPComboBox

SAP OK Code
A SAP OK Code Field.

Supports the following read actions:

Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPOkCodeField

SAP Button
A SAP button.

Supports the following actions:

Press

Supports the following read actions:

Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPButton

SAP Check Box


A SAP checkbox.

Supports the following read actions:

Get Text
Get Checked
Get Bounds
Get Screen Bounds

Supports the following conditions:


Check Exists

Internal ID: SAPCheckBox

SAP Radio Button


A SAP radio button.

Supports the following actions:

Select

Supports the following read actions:

Get Checked
Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPRadioButton

SAP Tab Strip


A SAP Tab Strip

Supports the following actions:

Select Item

Supports the following read actions:

Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPTabStrip

SAP Tab
A SAP Tab

Supports the following actions:

Select
Supports the following read actions:

Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPTab

SAP Treeview
A SAP Treeview

Supports the following actions:

Select Item
Expand Item
Collapse Item
Double Click Node

Supports the following read actions:

Get Selected Node Key


Get Node Text
Get Selected Item Text
Count Items
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPCtrlTree

SAP User Area


A user area - the main area of the application.

Supports the following read actions:

Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPUserArea


SAP Splitter Shell
A splitter shell - the child panes should contain useful elements.

Supports the following read actions:

Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPSplitter

SAP Gui Container Shell


A shell component.

Supports the following read actions:

Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPGuiContainerShell

SAP Toolbar
A toolbar - not useful directly, but should contain usable buttons.

Supports the following read actions:

Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPToolbar

SAP Menubar
A menu bar

Supports the following actions:

Select Menu Item


Supports the following read actions:

Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPMenubar

SAP Label
A label

Supports the following read actions:

Get Text
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPLabel

SAP Table
A table

Supports the following read actions:

Get All Items


Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPTable

SAP Scrollbar
A scrollbar

Supports the following actions:

Set Value

Supports the following read actions:


Get Min Value
Get Max Value
Get Value
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPScrollbar

SAP Scroll Container


A scroll container with (potentially) a horizontal and vertical scrollbar within.

Supports the following actions:

Set Horizontal Value


Set Vertical Value

Supports the following read actions:

Get Horizontal Minimum


Get Horizontal Maximum
Get Horizontal Value
Get Vertical Minimum
Get Vertical Maximum
Get Vertical Value
Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPScrollContainer

SAP HTML Viewer


An HTML viewer

Supports the following read actions:

Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

Internal ID: SAPHTMLViewer


Generic SAP Component
A generic SAP component

Supports the following read actions:

Get Bounds
Get Screen Bounds

Supports the following conditions:

Check Exists

The following alternate types can be selected:

SAP GridView
SAP Button
SAP TextBox

Internal ID: SAPComponent

Application Types
Windows Application
Windows Application

Internal ID: Win32

Subtypes

My application is launched from an executable file

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

My application will already be running - I want to attach to an existing instance

Internal ID: Win32Attach

Java-based Application
Java-based Application
Internal ID: Java

Subtypes

My application is launched from an executable file

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

My application will already be running - I want to attach to an existing instance

Internal ID: JavaAttach

Browser-based Application
Browser-based Application

Internal ID: HTML

Subtypes

A browser which is already running

A browser which is already running

Internal ID: HTMLAttach

A browser that is launched from an executable file

A browser that is launched from an executable file

Internal ID: HTMLLaunch

Mainframe Application
Mainframe Application

Internal ID: Mainframe

Subtypes

Generic HLLAPI
Generic HLLAPI

Internal ID: MainframeGEN

IBM iAccess (EHLLAPI)

IBM iAccess (EHLLAPI)

Internal ID: MainframeIAC

IBM Personal Communicator (COM API)

IBM Personal Communicator (COM API)

Internal ID: MainframeIBM

IBM Personal Communicator (HLLAPI)

IBM Personal Communicator (HLLAPI)

Internal ID: MainframePCH

Micro Focus Attachmate Extra! X-treme 9.3 (ATMAPI32)

Micro Focus Attachmate Extra! X-treme 9.3 (ATMAPI32)

Internal ID: MainframeATM

Micro Focus Infoconnect (WinHLLAPI)

Micro Focus Infoconnect (WinHLLAPI)

Internal ID: MainframeINF

Micro Focus Reflection 9.x and earlier (COM API)

Micro Focus Reflection 9.x and earlier (COM API)

Internal ID: MainframeART

Micro Focus Reflection for Desktop 16 (.NET API)

Micro Focus Reflection for Desktop 16 (.NET API)

Internal ID: MainframeARN

Micro Focus Rumba (EHLLAPI)

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)

OpenText HostExplorer (formerly Hummingbird) (COM API)

Internal ID: MainframeHUM

OpenText HostExplorer (formerly Hummingbird) (EHLLAPI)

OpenText HostExplorer (formerly Hummingbird) (EHLLAPI)

Internal ID: MainframeHEE

Ericom PowerTerm InterConnect (HLLAPI)

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

HP Teemtalk (EHLLAPI)

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)

NDL Active Conductor (HLLAPI)

Internal ID: MainframeCON

RMD (HTTP/XML)

RMD (HTTP/XML)

Internal ID: MainframeRMD

Rocket PASSPORT (COM API)

Rocket PASSPORT (COM API)

Internal ID: MainframePSS

You might also like