WhiteLibrary

Attaches a running application by process id.

Arguments

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

Examples

Attaches a running application by name.

Arguments

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

Examples

Attaches WhiteLibrary to a window.

Arguments

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:

Examples:

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

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.

Verifies exact text in a button.

Arguments

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.

Verifies expected text is found in a button.

Arguments

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.

Clicks a button.

Arguments

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.

Clicks an item.

Arguments

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.

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

Arguments

text_path is the path to the item to click.

Examples:

Clicks a menu button.

Arguments

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.

Clicks a button in a toolstrip (toolbar).

Arguments

locator is the locator of the toolstrip.

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

Closes the attached application.

Closes a window.

Arguments

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.

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

Arguments

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.

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

Arguments

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 clicks an item.

Arguments

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 clicks a listview cell.

Arguments

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 clicks a listview cell at index.

Arguments

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 clicks a listview row.

Arguments

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 clicks a listview row at index.

Arguments

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 clicks a listview row with matching text.

Arguments

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-clicks a tree node.

Arguments

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.

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

Arguments

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.

Expands a tree node.

Arguments

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.

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.

Returns the state of a check box.

Arguments

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.

Returns the text of the selected combobox item.

Arguments

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

Returns a list of windows on the desktop.

Returns the first item that matches the given locator.

Arguments

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

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

Arguments

Returns a list of items that match the given locator.

Locator syntax is explained in Item locators.

Returns the text of the selected listbox item.

Arguments

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

Returns text of a listview cell.

Arguments

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

Returns text of a listview cell at index.

Arguments

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

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

Arguments

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

Returns text of a listview row as a list.

Arguments

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

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

Returns the value of a progress bar.

Arguments

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

Returns the state of a radio button.

Arguments

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.

Returns the value of a slider.

Arguments

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

Gets all tab pages and returns them as a list.

Arguments

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

Returns the text of a label.

Arguments

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

Returns the text of a text box.

Arguments

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

Returns BusyTimeout value of White.

See also Set White Busy Timeout.

Returns DoubleClickInterval value of White.

See also Set White Double Click Interval.

Returns DragStepCount value of White.

See also Set White Drag Step Count.

Returns FindWindowTimeout value of White.

See also Set White Find Window Timeout.

Returns title of the currently attached window.

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

Hold down a special key.

Arguments

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

Writes text to a textbox.

Arguments

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.

Verifies that an item is disabled.

Arguments

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

Verifies that an item is enabled.

Arguments

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

Launches an application.

Arguments

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:

Leave a special key that was previously held down.

Arguments

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

Checks the listbox selection.

Arguments

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.

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

Arguments

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.

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

Arguments

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.

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

Arguments

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.

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

Arguments

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.

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

Arguments

Verifies that the given listview cell contains text expected.

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

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

Arguments

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.

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

Arguments

Verifies that listview cell text is expected.

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

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

Arguments

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.

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

Arguments

Verifies that listview cell text is expected.

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

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

Arguments

Verifies that listview cell text is not expected.

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

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

Arguments

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.

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

Arguments

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.

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

Arguments

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.

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

Arguments

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.

Maximizes a window.

Arguments

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.

Minimizes a window.

Arguments

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.

Clicks mouse at given position.

Arguments

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

Double clicks mouse at given position.

Arguments

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

Presses left mouse button down at given position.

Arguments

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

Releases left mouse button up at given position.

Arguments

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

Right clicks mouse at given position.

Arguments

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

Right double clicks mouse at given position.

Arguments

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

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

Arguments

Add (x, y) to current mouse location.

Press a key or keys.

Arguments

keys is the key or keys to press.

Examples

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

Arguments

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

Restores a window.

Arguments

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 clicks an item.

Arguments

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 clicks a listview cell using its column name and row index.

Arguments

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

Right clicks a listview cell at index.

Arguments

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

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

Arguments

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

Right clicks a listview row at index.

Arguments

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

Right clicks a listview row with matching text.

Arguments

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

Right-clicks a tree node.

Arguments

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.

Selects a value from combobox by using its index.

Arguments

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.

Selects a value from a combobox.

Arguments

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.

Selects an item by its index from a listbox.

Arguments

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.

Selects a value from a listbox.

Arguments

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.

Selects a listview cell.

Arguments

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

Selects a listview cell at index.

Arguments

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

Selects a listview row.

Arguments

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

Selects a listview row at index.

Arguments

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

Selects a listview row with matching text.

Arguments

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

Attaches a modal window.

Arguments

window_title is the title of the window.

Selects a radio button.

Arguments

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

Selects a tab page.

Arguments

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.

Selects a tab page by index.

Arguments

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.

Selects a tree node.

Arguments

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:

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

Arguments

Sets mouse position to (x, y).

Position is relative to application window top left.

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

Arguments

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.

Sets a slider to the specified value.

Arguments

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

value is the value to set.

Sets BusyTimeout for White and returns original value.

Arguments

timeout is the timeout value as Robot time string.

Default timeout is 5 seconds.

Sets DoubleClickInterval for White and returns original value.

Arguments

DoubleClickInterval adds delay in double click action between clicks.

interval is the interval value as Robot time string.

Default interval is 0 milliseconds.

Sets DragStepCount for White.

Arguments

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.

Sets FindWindowTimeout for White and returns original value.

Arguments

timeout is the timeout value as Robot time string.

Default timeout is 30 seconds.

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

Returns path to the screenshot file.

Disables or enables automatic screenshot capturing on failure.

Arguments

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.

Toggles a check box.

Arguments

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

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

Arguments

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.

Verifies state of a check box.

Arguments

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

*DEPRECATED* Please use Verify Combobox Selection instead.

Arguments

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.

Verifies that the combobox value is selected.

Arguments

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

expected is the expected selection value.

Verifies text of a label.

Arguments

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

expected is the expected text.

Verifies the text of a menu item.

Arguments

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.

Verifies the value of a progress bar.

Arguments

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.

Verifies state of a radio button.

Arguments

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

Verifies a slider value.

Arguments

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.

Verifies text in a text box.

Arguments

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.

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

Arguments

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.

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

Arguments

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.

Verifies that a window is maximized.

Arguments

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.

Verifies that a window is minimized.

Arguments

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.

Verifies that a window is restored.

Arguments

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.

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

Arguments

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

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

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

Arguments

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

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