Attach Application By Id

Attaches a running application by process id.

Arguments

Argument Type Default value Description
sut_id
timeout0

sut_id is the application process id. timeout is the maximum time to wait as a Robot time string. (Optional)

Examples

Attach Application By Id 12188

Attach Application By Name

Attaches a running application by name.

Arguments

Argument Type Default value Description
sut_name
timeout0

sut_name is the name of the process. timeout is the maximum time to wait as a Robot time string. (Optional)

Examples

Attach Application By Name UIAutomationTest

Attach Window

Attaches WhiteLibrary to a window.

Arguments

Argument Type Default value Description
locator

locator is the locator of the window or a window object.

Window locator syntax

Syntax for a window locator is prefix:value.

When the locator syntax is used, the window is searched from the currently attached application. See Attach Application By Id, Attach Application By Name or Launch application for more details about attaching an application.

The following window locators are available:

Prefix Description
title (or no prefix) Search by the exact window title. If no prefix is given, the window is searched by title by default.
id Search by AutomationID.
class_name Search by class name.

Examples:

Attach Window Main Window # attach window with title
Attach Window id:mainWindow # attach window with Automation ID
Attach Window class_name:NavigationWindow # attach window with ClassName

Window objects

A window can also be attached by directly passing the window object as the locator parameter value. This may be useful if the correct window cannot be found by using the window locator syntax.

Examples

@{windows} Get Application Windows
Attach Window ${windows[1]} # attach window at index 1 in window list

When using a window object as the locator parameter value, the window is attached even if it does not belong to the currently attached application. Note that when attaching a window that belongs to a different application than the currently attached one, attaching the window does not affect what application is attached to the library.

Button Text Should Be

Verifies exact text in a button.

Arguments

Argument Type Default value Description
locator
expected_text
case_sensitiveTrue

locator is the locator of the button or Button item object. Locator syntax is explained in Item locators.

expected_text is the expected button text.

case_sensitive defines if the text comparison is case sensitive (True/False). Defaults to True. Boolean values are evaluated in the same way as the Robot Framework BuiltIn library does, see the documentation of BuiltIn for details.

Button Text Should Contain

Verifies expected text is found in a button.

Arguments

Argument Type Default value Description
locator
expected_text
case_sensitiveTrue

locator is the locator of the button or Button item object. Locator syntax is explained in Item locators.

expected_text is the expected button text.

case_sensitive defines if the text comparison is case sensitive (True/False). Defaults to True. Boolean values are evaluated in the same way as the Robot Framework BuiltIn library does, see the documentation of BuiltIn for details.

Click Button

Clicks a button.

Arguments

Argument Type Default value Description
locator
x_offset0
y_offset0

locator is the locator of the button or Button item object. Locator syntax is explained in Item locators.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Click Item

Clicks an item.

Arguments

Argument Type Default value Description
locator
x_offset0
y_offset0

locator is the locator of the item or object of an item. Locator syntax is explained in Item locators.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Click Item In Popup Menu

Clicks an item in the currently open popup/context menu.

Arguments

Argument Type Default value Description
*text_path

text_path is the path to the item to click.

Examples:

Click Popup Menu Item Paste # click an item in the root level
Click Popup Menu Item Refactor Rename # click a sub item

Click Menu Button

Clicks a menu button.

Arguments

Argument Type Default value Description
locator
x_offset0
y_offset0

locator is the locator of the menu button or Menu item object. Locator syntax is explained in Item locators.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Click Toolstrip Button By Index

Clicks a button in a toolstrip (toolbar).

Arguments

Argument Type Default value Description
locator
index

locator is the locator of the toolstrip.

index is the zero-based index of the toolstrip button to click.

Close Application

Closes the attached application.

Close Window

Closes a window.

Arguments

Argument Type Default value Description
locatorNone

locator is the locator of the window or a window object (optional).

If no locator value is given, the currently attached window is closed. See Attach Window for details about window locators and attaching a window.

Combobox Should Contain

Verifies that a combobox contains an item with text ``expected``.

Arguments

Argument Type Default value Description
locator
expected

Verifies that a combobox contains an item with text expected.

Fails if the combobox does not contain an item with the given text.

locator is the locator of the combobox or ComboBox item object. Locator syntax is explained in Item locators.

expected is the expected item text.

Combobox Should Not Contain

Verifies that a combobox does not contain an item with text ``expected``.

Arguments

Argument Type Default value Description
locator
expected

Verifies that a combobox does not contain an item with text expected.

Fails if the combobox contains an item with the given text.

locator is the locator of the combobox or ComboBox item object. Locator syntax is explained in Item locators.

expected is the expected item text.

Double Click Item

Double clicks an item.

Arguments

Argument Type Default value Description
locator
x_offset0
y_offset0

locator is the locator of the item or object of an item. Locator syntax is explained in Item locators.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Double Click Listview Cell

Double clicks a listview cell.

Arguments

Argument Type Default value Description
locator
column_name
row_index
x_offset0
y_offset0

locator is the locator of the listview or ListView item object. Locator syntax is explained in Item locators.

column_name is the name of the column.

row_index is the zero-based row index.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Examples

Double Click Listview Cell id:addressList Street 0 # double click cell in the column "Street" of the first row

Double Click Listview Cell By Index

Double clicks a listview cell at index.

Arguments

Argument Type Default value Description
locator
row_index
column_index
x_offset0
y_offset0

locator is the locator of the listview or ListView item object. Locator syntax is explained in Item locators.

row_index is the zero-based row index.

column_index is the zero-based column index.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Examples

Double Click Listview Cell By Index id:addressList 0 0

Double Click Listview Row

Double clicks a listview row.

Arguments

Argument Type Default value Description
locator
column_name
cell_text
x_offset0
y_offset0

locator is the locator of the listview or ListView item object. Locator syntax is explained in Item locators.

column_name and cell_text define the row. Row is the first matching row where text in column column_name is cell_text.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Examples

Double Click Listview Row id:addressList City Helsinki # double click row that has the text "Helsinki" in the column "City"

Double Click Listview Row By Index

Double clicks a listview row at index.

Arguments

Argument Type Default value Description
locator
row_index
x_offset0
y_offset0

locator is the locator of the listview or ListView item object. Locator syntax is explained in Item locators.

row_index is the zero-based row index.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Examples

Double Click Listview Row By Index id:addressList 4

Double Click Listview Row By Text

Double clicks a listview row with matching text.

Arguments

Argument Type Default value Description
locator
text
x_offset0
y_offset0

locator is the locator of the listview or the ListView item object. Locator syntax is explained in Item locators.

text is the exact text of the row. If there are multiple cells on the row, the text will be matched against the first cell.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Examples

Double Click Listview Row By Text id:cities Berlin

Double Click Tree Node

Double-clicks a tree node.

Arguments

Argument Type Default value Description
locator
*node_path

locator is the locator of the tree or Tree item object. Locator syntax is explained in Item locators.

node_path is the path the to node to double-click.

See examples of the node path in Select Tree Node documentation.

Drag And Drop

Drags item with locator ``locator1`` to item with locator ``locator2``.

Arguments

Argument Type Default value Description
locator1
locator2

Drags item with locator locator1 to item with locator locator2.

locator1 is the locator of the draggable object or draggable item.

locator2 is the locator of the target for the draggable object or target item itself.

Locator syntax is explained in Item locators.

Expand Tree Node

Expands a tree node.

Arguments

Argument Type Default value Description
locator
*node_path

locator is the locator of the tree or Tree item object. Locator syntax is explained in Item locators.

node_path is the path the to node to expand.

See examples of the node path in Select Tree Node documentation.

Get Application Windows

Returns a list of windows belonging to the currently attached application.

Assumes that an application is attached. See Attach Application By Name and Attach Application By Id for details.

Get Check Box State

Returns the state of a check box.

Arguments

Argument Type Default value Description
locator

Returns True if the check box is selected, False if not.

locator is the locator of the check box or CheckBox item object. Locator syntax is explained in Item locators.

Get Combobox Selected Text

Returns the text of the selected combobox item.

Arguments

Argument Type Default value Description
locator

locator is the locator of the combobox or ComboBox item object. Locator syntax is explained in Item locators.

Get Desktop Windows

Returns a list of windows on the desktop.

Get Item

Returns the first item that matches the given locator.

Arguments

Argument Type Default value Description
locator

locator is the locator of the item. Locator syntax is explained in Item locators.

Get Items

Returns a list of items that match the given ``locator``.

Arguments

Argument Type Default value Description
locator

Returns a list of items that match the given locator.

Locator syntax is explained in Item locators.

Get Listbox Selected Text

Returns the text of the selected listbox item.

Arguments

Argument Type Default value Description
locator

locator is the locator of the listbox or ListBox item object. Locator syntax is explained in Item locators.

Get Listview Cell Text

Returns text of a listview cell.

Arguments

Argument Type Default value Description
locator
column_name
row_index

See Double Click Listview Cell for details about arguments locator, column_name, and row_index.

Get Listview Cell Text By Index

Returns text of a listview cell at index.

Arguments

Argument Type Default value Description
locator
row_index
column_index

See Double Click Listview Cell By Index for details about arguments locator, row_index, and column_index.

Get Listview Row Text

Returns a list containing text of each cell in a listview row.

Arguments

Argument Type Default value Description
locator
column_name
cell_text

See Double Click Listview Row for details about the arguments locator, column_name, and cell_text.

Get Listview Row Text By Index

Returns text of a listview row as a list.

Arguments

Argument Type Default value Description
locator
row_index

See Double Click Listview Row By Index for details about arguments locator and row_index.

Get Mouse Location

Returns mouse position as tuple (x, y).

Position is relative to application window top left. If mouse is outside the application window the return values is either negative or bigger than window dimensions.

Examples

${x} ${y} Get Mouse Location

Get Progressbar Value

Returns the value of a progress bar.

Arguments

Argument Type Default value Description
locator

locator is the locator of the progress bar or ProgressBar item object. Locator syntax is explained in Item locators.

Get Radio Button State

Returns the state of a radio button.

Arguments

Argument Type Default value Description
locator

Returns True if the radio button is selected, False if not.

locator is the locator of the radio button or RadioButton item object. Locator syntax is explained in Item locators.

Get Slider Value

Returns the value of a slider.

Arguments

Argument Type Default value Description
locator

locator is the locator of the slider or Slider item object. Locator syntax is explained in Item locators.

Get Tab Pages

Gets all tab pages and returns them as a list.

Arguments

Argument Type Default value Description
locator

locator is the locator of the tab control item or Tab item object. Locator syntax is explained in Item locators.

Get Text From Label

Returns the text of a label.

Arguments

Argument Type Default value Description
locator

locator is the locator of the label or Label item object. Locator syntax is explained in Item locators.

Get Text From Textbox

Returns the text of a text box.

Arguments

Argument Type Default value Description
locator

locator is the locator of the text box or Textbox item object. Locator syntax is explained in Item locators.

Get White Busy Timeout

Returns BusyTimeout value of White.

See also Set White Busy Timeout.

Get White Double Click Interval

Returns DoubleClickInterval value of White.

See also Set White Double Click Interval.

Get White Drag Step Count

Returns DragStepCount value of White.

See also Set White Drag Step Count.

Get White Find Window Timeout

Returns FindWindowTimeout value of White.

See also Set White Find Window Timeout.

Get Window Title

Returns title of the currently attached window.

Assumes that a window is attached. See Attach Window for details.

Hold Special Key

Hold down a special key.

Arguments

Argument Type Default value Description
key

key must be one of the accepted special keys, see documentation of Press Special Key

Input Text To Textbox

Writes text to a textbox.

Arguments

Argument Type Default value Description
locator
input_value

locator is the locator of the text box or Textbox item object. Locator syntax is explained in Item locators.

input_value is the text to write.

Item Should Be Disabled

Verifies that an item is disabled.

Arguments

Argument Type Default value Description
locator

locator is the locator of the item. Locator syntax is explained in Item locators.

Item Should Be Enabled

Verifies that an item is enabled.

Arguments

Argument Type Default value Description
locator

locator is the locator of the item. Locator syntax is explained in Item locators.

Launch Application

Launches an application.

Arguments

Argument Type Default value Description
sut_path
argsNone

sut_path is the absolute path to the application to launch.

args is a string of arguments to use when starting the application (optional).

Examples:

Launch Application C:/path/to/MyApp.exe # Launch without arguments
Launch Application C:/path/to/MyApp.exe /o log.txt # Launch with arguments

Leave Special Key

Leave a special key that was previously held down.

Arguments

Argument Type Default value Description
key

key must be one of the accepted special keys, see documentation of Press Special Key

Listbox Selection Should Be

Checks the listbox selection.

Arguments

Argument Type Default value Description
locator
expected

Fails if the selection was not as expected.

locator is the locator of the listbox or ListBox item object. Locator syntax is explained in Item locators.

expected is the expected selection value.

Listbox Should Contain

Checks that listbox contains an item with text ``expected``.

Arguments

Argument Type Default value Description
locator
expected

Checks that listbox contains an item with text expected.

Fails if the listbox does not contain an item with the given text.

locator is the locator of the listbox or ListBox item object. Locator syntax is explained in Item locators.

expected is the expected item text.

Listbox Should Not Contain

Verifies that a listbox does not contain an item with text ``expected``.

Arguments

Argument Type Default value Description
locator
expected

Verifies that a listbox does not contain an item with text expected.

Fails if the listbox contains an item with the given text.

locator is the locator of the listbox or ListBox item object. Locator syntax is explained in Item locators.

expected is the expected item text.

Listview Cell At Index Should Contain

Verifies that the given listview cell contains text ``expected``.

Arguments

Argument Type Default value Description
locator
row_index
column_index
expected

Verifies that the given listview cell contains text expected.

See Double Click Listview Cell By Index for details about arguments locator, row_index, and column_index.

Listview Cell At Index Should Not Contain

Verifies that the given listview cell does not contain text ``expected``.

Arguments

Argument Type Default value Description
locator
row_index
column_index
expected

Verifies that the given listview cell does not contain text expected.

See Double Click Listview Cell By Index for details about arguments locator, row_index, and column_index.

Listview Cell Should Contain

Verifies that the given listview cell contains text ``expected``.

Arguments

Argument Type Default value Description
locator
column_name
row_index
expected

Verifies that the given listview cell contains text expected.

See Double Click Listview Cell for details about arguments locator, column_name, and row_index.

Listview Cell Should Not Contain

Verifies that the given listview cell does not contain text ``expected``.

Arguments

Argument Type Default value Description
locator
column_name
row_index
expected

Verifies that the given listview cell does not contain text expected.

See Double Click Listview Cell for details about arguments locator, column_name, and row_index.

Listview Cell Text At Index Should Be

Verifies that listview cell text is ``expected``.

Arguments

Argument Type Default value Description
locator
row_index
column_index
expected

Verifies that listview cell text is expected.

See Double Click Listview Cell By Index for details about arguments locator, row_index, and column_index.

Listview Cell Text At Index Should Not Be

Verifies that listview cell text is not ``expected``.

Arguments

Argument Type Default value Description
locator
row_index
column_index
expected

Verifies that listview cell text is not expected.

See Double Click Listview Cell By Index for details about arguments locator, row_index, and column_index.

Listview Cell Text Should Be

Verifies that listview cell text is ``expected``.

Arguments

Argument Type Default value Description
locator
column_name
row_index
expected

Verifies that listview cell text is expected.

See Double Click Listview Cell for details about arguments locator, column_name, and row_index.

Listview Cell Text Should Not Be

Verifies that listview cell text is not ``expected``.

Arguments

Argument Type Default value Description
locator
column_name
row_index
expected

Verifies that listview cell text is not expected.

See Double Click Listview Cell for details about arguments locator, column_name, and row_index.

Listview Row At Index Should Contain

Verifies that any cell in the given listview row contains text ``expected``.

Arguments

Argument Type Default value Description
locator
row_index
expected

Verifies that any cell in the given listview row contains text expected.

See Double Click Listview Row By Index for details about arguments locator and row_index.

Listview Row At Index Should Not Contain

Verifies that any cell in the given listview row does not contain text ``expected``.

Arguments

Argument Type Default value Description
locator
row_index
expected

Verifies that any cell in the given listview row does not contain text expected.

See Double Click Listview Row By Index for details about arguments locator and row_index.

Listview Row Should Contain

Verifies that the given listview row contains text ``expected``.

Arguments

Argument Type Default value Description
locator
column_name
cell_text
expected

Verifies that the given listview row contains text expected.

See Double Click Listview Row for details about the arguments locator, column_name, and cell_text.

Listview Row Should Not Contain

Verifies that the given listview row does not contain text ``expected``.

Arguments

Argument Type Default value Description
locator
column_name
cell_text
expected

Verifies that the given listview row does not contain text expected.

See Double Click Listview Row for details about the arguments locator, column_name, and cell_text.

Maximize Window

Maximizes a window.

Arguments

Argument Type Default value Description
locatorNone

locator is the locator of the window or a window object (optional).

If no locator value is given, the currently attached window is maximized. See Attach Window for details about attaching a window and window locator syntax.

Minimize Window

Minimizes a window.

Arguments

Argument Type Default value Description
locatorNone

locator is the locator of the window or a window object (optional).

If no locator value is given, the currently attached window is minimized. See Attach Window for details about attaching a window and window locator syntax.

Mouse Click

Clicks mouse at given position.

Arguments

Argument Type Default value Description
xNone
yNone

Position (x, y) is relative to application window top left. If no coordinates are given it uses current mouse position.

Mouse Double Click

Double clicks mouse at given position.

Arguments

Argument Type Default value Description
xNone
yNone

Position (x, y) is relative to application window top left. If no coordinates are given it uses current mouse position.

Mouse Left Button Down

Presses left mouse button down at given position.

Arguments

Argument Type Default value Description
xNone
yNone

Position (x, y) is relative to application window top left. If no coordinates are given it uses current mouse position.

Mouse Left Button Up

Releases left mouse button up at given position.

Arguments

Argument Type Default value Description
xNone
yNone

Position (x, y) is relative to application window top left. If no coordinates are given it uses current mouse position.

Mouse Right Click

Right clicks mouse at given position.

Arguments

Argument Type Default value Description
xNone
yNone

Position (x, y) is relative to application window top left. If no coordinates are given it uses current mouse position.

Mouse Right Double Click

Right double clicks mouse at given position.

Arguments

Argument Type Default value Description
xNone
yNone

Position (x, y) is relative to application window top left. If no coordinates are given it uses current mouse position.

Move Mouse

Add (``x``, ``y``) to current mouse location.

Arguments

Argument Type Default value Description
x
y

Add (x, y) to current mouse location.

Press Keys

Press a key or keys.

Arguments

Argument Type Default value Description
keys

keys is the key or keys to press.

Examples

Press Keys a
Press Keys Text with special characters!

Press Special Key

Press a special key (Ctrl, tab, alt for example).

Arguments

Argument Type Default value Description
key

key must be one of the following: SHIFT, CONTROL, ALT, LEFT_ALT, RIGHT_ALT, RETURN ,RIGHT, BACKSPACE, LEFT, ESCAPE, TAB, HOME, END, UP, DOWN, INSERT, DELETE, CAPS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F11, F12, F13, F14,F15, F16, F17, F18, F19, F20, F21, F22, F23,F24, PAGEUP, PAGEDOWN, PRINT, PRINTSCREEN, SPACE, NUMLOCK, SCROLL, LWIN, RWIN

Restore Window

Restores a window.

Arguments

Argument Type Default value Description
window_titleNone

locator is the locator of the window or a window object (optional).

If no locator value is given, the currently attached window is restored. See Attach Window for details about attaching a window and window locator syntax.

Right Click Item

Right clicks an item.

Arguments

Argument Type Default value Description
locator
x_offset0
y_offset0

locator is the locator of the item or object of an item. Locator syntax is explained in Item locators.

Optional arguments x_offset and y_offset can be used to define the coordinates to click at, relative to the center of the item.

Right Click Listview Cell

Right clicks a listview cell using its column name and row index.

Arguments

Argument Type Default value Description
locator
column_name
row_index
x_offset0
y_offset0

See Double Click Listview Cell for details about arguments locator, column_name, and row_index.

Right Click Listview Cell By Index

Right clicks a listview cell at index.

Arguments

Argument Type Default value Description
locator
row_index
column_index
x_offset0
y_offset0

See Double Click Listview Cell By Index for details about arguments locator, row_index, and column_index.

Right Click Listview Row

Right clicks a listview row that has given text in given column.

Arguments

Argument Type Default value Description
locator
column_name
cell_text
x_offset0
y_offset0

See Double Click Listview Row for details about the arguments locator, column_name, and cell_text.

Right Click Listview Row By Index

Right clicks a listview row at index.

Arguments

Argument Type Default value Description
locator
row_index
x_offset0
y_offset0

See Double Click Listview Row By Index for details about arguments locator and row_index.

Right Click Listview Row By Text

Right clicks a listview row with matching text.

Arguments

Argument Type Default value Description
locator
text
x_offset0
y_offset0

See Double Click Listview Row By Text for details about arguments locator and text.

Right Click Tree Node

Right-clicks a tree node.

Arguments

Argument Type Default value Description
locator
*node_path

locator is the locator of the tree or Tree item object. Locator syntax is explained in Item locators.

node_path is the path the to node to right-click.

See examples of the node path in Select Tree Node documentation.

Select Combobox Index

Selects a value from combobox by using its index.

Arguments

Argument Type Default value Description
locator
item_index

locator is the locator of the combobox or ComboBox item object. Locator syntax is explained in Item locators.

item_index is the index to be selected.

Select Combobox Value

Selects a value from a combobox.

Arguments

Argument Type Default value Description
locator
value

locator is the locator of the combobox or ComboBox item object. Locator syntax is explained in Item locators.

value is the value to be selected.

Select Listbox Index

Selects an item by its index from a listbox.

Arguments

Argument Type Default value Description
locator
item_index

locator is the locator of the listbox or ListBox item object. Locator syntax is explained in Item locators.

item_index is the index of the item to select.

Select Listbox Value

Selects a value from a listbox.

Arguments

Argument Type Default value Description
locator
value

locator is the locator of the listbox or ListBox item object. Locator syntax is explained in Item locators.

value is the value to be selected.

Select Listview Cell

Selects a listview cell.

Arguments

Argument Type Default value Description
locator
column_name
row_index

See Double Click Listview Cell for details about arguments locator, column_name, and row_index.

Select Listview Cell By Index

Selects a listview cell at index.

Arguments

Argument Type Default value Description
locator
row_index
column_index

See Double Click Listview Cell By Index for details about arguments locator, row_index, and column_index.

Select Listview Row

Selects a listview row.

Arguments

Argument Type Default value Description
locator
column_name
cell_text

See Double Click Listview Row for details about the arguments locator, column_name, and cell_text.

Select Listview Row By Index

Selects a listview row at index.

Arguments

Argument Type Default value Description
locator
row_index

See Double Click Listview Row By Index for details about arguments locator and row_index.

Select Listview Row By Text

Selects a listview row with matching text.

Arguments

Argument Type Default value Description
locator
text

See Double Click Listview Row By Text for details about arguments locator and text.

Select Modal Window

Attaches a modal window.

Arguments

Argument Type Default value Description
window_title

window_title is the title of the window.

Select Radio Button

Selects a radio button.

Arguments

Argument Type Default value Description
locator

locator is the locator of the radio button or RadioButton item object. Locator syntax is explained in Item locators.

Select Tab Page

Selects a tab page.

Arguments

Argument Type Default value Description
locator
title

locator is the locator of the tab control item or Tab item object. Locator syntax is explained in Item locators.

title is the title of the tab page.

Select Tab Page By Index

Selects a tab page by index.

Arguments

Argument Type Default value Description
locator
index

locator is the locator of the tab control item or Tab item object. Locator syntax is explained in Item locators.

index is integer index the tab page. Indexing starts from 0.

Select Tree Node

Selects a tree node.

Arguments

Argument Type Default value Description
locator
*node_path

locator is the locator of the tree or Tree item object. Locator syntax is explained in Item locators.

node_path is the path the to node to select.

Example tree (tree locator is tree_id):

root
|
|---parent_node
|   |
|   |---child_node
|   |
|   |---sibling_node
|
|---other parent

Example usage to select sibling node:

Select Tree Node tree_id root parent_node sibling_node

Set Mouse Location

Sets mouse position to (``x``, ``y``).

Arguments

Argument Type Default value Description
x
y

Sets mouse position to (x, y).

Position is relative to application window top left.

Set Screenshot Directory

Sets the directory where WhiteLibrary stores screenshots and returns the previously set path.

Arguments

Argument Type Default value Description
path

If the given directory does not exist in the system, it will be created when the first screenshot is taken.

path is the directory path.

The directory can also be set when the library is imported, see Importing for details.

Set Slider Value

Sets a slider to the specified value.

Arguments

Argument Type Default value Description
locator
value

locator is the locator of the slider or Slider item object. Locator syntax is explained in Item locators.

value is the value to set.

Set White Busy Timeout

Sets BusyTimeout for White and returns original value.

Arguments

Argument Type Default value Description
timeout

timeout is the timeout value as Robot time string.

Default timeout is 5 seconds.

Set White Double Click Interval

Sets DoubleClickInterval for White and returns original value.

Arguments

Argument Type Default value Description
interval

DoubleClickInterval adds delay in double click action between clicks.

interval is the interval value as Robot time string.

Default interval is 0 milliseconds.

Set White Drag Step Count

Sets DragStepCount for White.

Arguments

Argument Type Default value Description
value

value is the DragStepCount value as integer.

DragStepCount defines how many steps White uses to move dragged object to the destination. With default value 1 the dragged object is moved instantly in a single step from start to destination.

Set White Find Window Timeout

Sets FindWindowTimeout for White and returns original value.

Arguments

Argument Type Default value Description
timeout

timeout is the timeout value as Robot time string.

Default timeout is 30 seconds.

Take Desktop Screenshot

Takes a screenshot of the whole desktop and inserts screenshot link to log file.

Returns path to the screenshot file.

Take Screenshots On Failure

Disables or enables automatic screenshot capturing on failure.

Arguments

Argument Type Default value Description
status

status is the desired state (True/False) of automatic screenshot on failure. Boolean values are evaluated in the same way as the Robot Framework BuiltIn library does, see the documentation of BuiltIn for details.

WhiteLibrary automatically takes a screenshot on failure unless it is disabled with this keyword.

Toggle Check Box

Toggles a check box.

Arguments

Argument Type Default value Description
locator

locator is the locator of the check box or CheckBox item object. Locator syntax is explained in Item locators.

Verify Button

*DEPRECATED.* Use `Button Text Should Be` or `Button Text Should Contain` instead.

Arguments

Argument Type Default value Description
locator
expected

DEPRECATED. Use Button Text Should Be or Button Text Should Contain instead.

Verifies text in a button.

locator is the locator of the button or Button item object.

expected is the expected button text.

Verify Check Box

Verifies state of a check box.

Arguments

Argument Type Default value Description
locator
expected

locator is the locator of the check box or CheckBox item object. Locator syntax is explained in Item locators.

expected is the expected state (True/False).

Verify Combobox Item

*DEPRECATED* Please use Verify Combobox Selection instead.

Arguments

Argument Type Default value Description
locator
expected

DEPRECATED Please use Verify Combobox Selection instead.

Verifies the selected value of a combobox.

locator is the locator of the combobox or ComboBox item object. Locator syntax is explained in Item locators.

expected is the expected selection value.

Verify Combobox Selection

Verifies that the combobox value is selected.

Arguments

Argument Type Default value Description
locator
expected

locator is the locator of the combobox or ComboBox item object. Locator syntax is explained in Item locators.

expected is the expected selection value.

Verify Label

Verifies text of a label.

Arguments

Argument Type Default value Description
locator
expected

locator is the locator of the label or Label item object. Locator syntax is explained in Item locators.

expected is the expected text.

Verify Menu

Verifies the text of a menu item.

Arguments

Argument Type Default value Description
locator
expected

locator is the locator of the menu item or Menu item object. Locator syntax is explained in Item locators.

expected is the expected text of the menu item.

Verify Progressbar Value

Verifies the value of a progress bar.

Arguments

Argument Type Default value Description
locator
expected

locator is the locator of the progress bar or ProgressBar item object. Locator syntax is explained in Item locators.

expected is the expected value of the progress bar.

Verify Radio Button

Verifies state of a radio button.

Arguments

Argument Type Default value Description
locator
expected

locator is the locator of the radio button or RadioButton item object. Locator syntax is explained in Item locators.

expected is the expected state (True/False).

Verify Slider Value

Verifies a slider value.

Arguments

Argument Type Default value Description
locator
expected

locator is the locator of the slider or Slider item object. Locator syntax is explained in Item locators.

expected is the expected value of the slider.

Verify Text In Textbox

Verifies text in a text box.

Arguments

Argument Type Default value Description
locator
expected

locator is the locator of the text box or Textbox item object. Locator syntax is explained in Item locators.

expected is the expected text of the text box.

Wait Until Item Does Not Exist

Waits until no items with given locator exist in the attached window.

Arguments

Argument Type Default value Description
locator
timeout

Fails if timeout is exceeded.

locator is the locator of the item. Locator syntax is explained in Item locators.

timeout is the maximum time to wait as a Robot time string.

See Waiting and timeouts for more information about waiting in WhiteLibrary.

Wait Until Item Exists

Waits until an item with given locator exists in the attached window.

Arguments

Argument Type Default value Description
locator
timeout

Fails if timeout is exceeded.

locator is the locator of the item. Locator syntax is explained in Item locators.

timeout is the maximum time to wait as a Robot time string.

See Waiting and timeouts for more information about waiting in WhiteLibrary.

Window Should Be Maximized

Verifies that a window is maximized.

Arguments

Argument Type Default value Description
locatorNone

locator is the locator of the window or a window object (optional).

If no locator value is given, the status of the currently attached window is verified. See Attach Window for details about attaching a window and window locator syntax.

Window Should Be Minimized

Verifies that a window is minimized.

Arguments

Argument Type Default value Description
locatorNone

locator is the locator of the window or a window object (optional).

If no locator value is given, the status of the currently attached window is verified. See Attach Window for details about attaching a window and window locator syntax.

Window Should Be Restored

Verifies that a window is restored.

Arguments

Argument Type Default value Description
locatorNone

locator is the locator of the window or a window object (optional).

If title is not given, currently attached window status is queried. See Attach Window for more details.

Window Title Should Be

Verifies that the title of the currently attached window is ``expected``.

Arguments

Argument Type Default value Description
expected

Verifies that the title of the currently attached window is expected.

Assumes that a window is attached. See Attach Window for details.

Window Title Should Contain

Verifies that the title of the currently attached window contains text ``expected``.

Arguments

Argument Type Default value Description
expected

Verifies that the title of the currently attached window contains text expected.

Assumes that a window is attached. See Attach Window for details.