Clear Anchor
Clears control anchor set by Set Anchor
This means that all following keywords accessing elements will use active window or desktop as root element.
Click
Mouse click on element matching given locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
wait_time | float, None | None | time to wait after click, default is a library wait_time, see keyword Set Wait Time |
timeout | float, None | None | float value in seconds, see keyword Set Global Timeout |
Exception ActionNotPossible is raised if element does not allow Click action.
param locator: | string locator or Control element |
---|---|
param wait_time: | |
time to wait after click, default is a library wait_time, see keyword Set Wait Time | |
param timeout: | float value in seconds, see keyword Set Global Timeout |
return: | WindowsElement object |
Examples
Click id:button1
Click id:button2 offset:10,10
${element}= Click name:SendButton wait_time=5.0
Close Current Window
Closes current active window or logs a warning message.
return: | True if close was successful, False if not |
---|
Examples
${status}= Close Current Window
Close Window
Closes identified windows or logs the problems.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | String locator or Control element. |
timeout | float, None | None | float value in seconds, see keyword Set Global Timeout |
param locator: | String locator or Control element. |
---|---|
param timeout: | float value in seconds, see keyword Set Global Timeout |
return: | How many windows were found and closed. |
Examples
${closed_count} = Close Window Calculator
Control Child Window
Get control of child window of the active window by locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | string locator or Control element |
foreground | bool | True | True to bring window to foreground |
wait_time | float, None | None | time to wait after activeting a window |
timeout | float, None | None | float value in seconds, see keyword Set Global Timeout |
param locator: | string locator or Control element |
---|---|
param foreground: | |
True to bring window to foreground | |
param wait_time: | |
time to wait after activeting a window | |
param timeout: | float value in seconds, see keyword Set Global Timeout |
return: | WindowsElement object |
Examples
Control Window subname:"Sage 50" type:Window
# actions on the main application window
# ...
# get control of child window of Sage application
Control Child Window subname:"Test Company" depth:1
Control Window
Controls the window defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | string locator or Control element |
foreground | bool | True | True to bring window to foreground |
wait_time | float, None | None | time to wait after activating a window |
timeout | float, None | None | float value in seconds, see keyword Set Global Timeout |
main | bool | True | on True (default) starts search from desktop level, on False will continue search on child elements of current active window |
This means that this window is used as a root element for all the following keywords using locators.
Returns WindowsElement.
param locator: | string locator or Control element |
---|---|
param foreground: | |
True to bring window to foreground | |
param wait_time: | |
time to wait after activating a window | |
param timeout: | float value in seconds, see keyword Set Global Timeout |
param main: | on True (default) starts search from desktop level, on False will continue search on child elements of current active window |
return: | WindowsElement object |
Examples
Control Window Calculator
Control Window name:Calculator
Control Window subname:Notepad
Control Window regex:.*Notepad
${window}= Control Window executable:Spotify.exe
Double Click
Double mouse click on element matching given locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
wait_time | float, None | None | time to wait after click, default is a library wait_time, see keyword Set Wait Time |
timeout | float, None | None | float value in seconds, see keyword Set Global Timeout |
Exception ActionNotPossible is raised if element does not allow Click action.
param locator: | string locator or Control element |
---|---|
param wait_time: | |
time to wait after click, default is a library wait_time, see keyword Set Wait Time | |
param timeout: | float value in seconds, see keyword Set Global Timeout |
return: | WindowsElement object |
Examples
${element}= Double Click name:ResetButton
Foreground Window
Bring the current active window or the window defined by the locator to the foreground.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | string locator or Control element |
param locator: | string locator or Control element |
---|---|
return: | WindowsElement object |
Examples
${window}= Foreground Window Calculator
Get Attribute
Get attribute value of the element defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
attribute | str | null | name of the attribute to get |
param locator: | string locator or Control element |
---|---|
param attribute: | |
name of the attribute to get | |
return: | value of attribute |
Examples
${id}= Get Attribute type:Edit name:firstname AutomationId
Get Element
Get Control element defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | locator as a string or as an element |
search_depth | int | 8 | how deep the element search will traverse (default 8) |
root_element | WindowsElement, None | None | can be used to set search root element |
timeout | float, None | None | float value in seconds, see keyword Set Global Timeout |
Returned element can be used instead of a locator string for keywords accepting locator.
Keyword Get Attribute can be used to read element attribute values.
If locator is None then returned element will be in order of preference:
- anchor element if that has been set with Set Anchor
- current active window if that has been set with Control Window
- final option is the Desktop
param locator: | locator as a string or as an element |
---|---|
param search_depth: | |
how deep the element search will traverse (default 8) | |
param root_element: | |
can be used to set search root element | |
param timeout: | float value in seconds, see keyword Set Global Timeout |
return: | WindowsElement object |
Examples
${element} = Get Element name:"RichEdit Control"
Set Value ${element} note to myself
Get Elements
Get list of elements matching locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | locator as a string or as an element |
search_depth | int | 8 | how deep the element search will traverse (default 8) |
root_element | WindowsElement, None | None | can be used to set search root element |
timeout | float, None | None | float value in seconds, see keyword Set Global Timeout |
param locator: | locator as a string or as an element |
---|---|
param search_depth: | |
how deep the element search will traverse (default 8) | |
param root_element: | |
can be used to set search root element | |
param timeout: | float value in seconds, see keyword Set Global Timeout |
return: | list of WindowsElement objects |
Examples
Set Anchor id:DataGrid
${elements}= Get Elements type:HeaderItem
FOR ${el} IN @{elements}
Log To Console ${el.Name}
END
Get Os Version
Returns the current Windows major version as string.
Examples
${ver} = Get OS Version
Log ${ver} # 10
Get Text
Get text from Control element defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
Exception ActionNotPossible is raised if element does not allow GetWindowText action.
param locator: | string locator or Control element |
---|---|
return: | value of WindowText attribute of an element |
Examples
${date} = Get Text type:Edit name:"Date of birth"
Get Value
Get value of the element defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
Exception ActionNotPossible is raised if element does not allow GetValuePattern action.
param locator: | string locator or Control element |
---|---|
return: | value of ValuePattern attribute of an element |
Examples
${value}= Get Value type:DataItem name:column1
List Attributes
List all element attributes.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
param locator: | string locator or Control element |
---|---|
return: | list of element attributes (strings) |
List Windows
List all window element on the system.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
icons | bool | False | on True dictionary will contain Base64 string of the icon, default False |
icon_save_directory | str, None | None | if set will save retrieved icons into this filepath, by default icon files are not saved |
param icons: | on True dictionary will contain Base64 string of the icon, default False |
---|---|
param icon_save_directory: | |
if set will save retrieved icons into this filepath, by default icon files are not saved | |
return: | list of dictionaries containing information about Window elements |
Examples
${windows}= List Windows
FOR ${window} IN @{windows}
Log Window title:${window}[title]
Log Window process name:${window}[name]
Log Window process id:${window}[pid]
Log Window process handle:${window}[handle]
END
Maximize Window
Maximize the current active window or the window defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | string locator or element |
param locator: | string locator or element |
---|---|
return: | WindowsElement object |
Examples
${window} = Maximize Window # Current active window
Maximize Window executable:Spotify.exe
Middle Click
Right mouse click on element matching given locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
wait_time | float, None | None | time to wait after click, default is a library wait_time, see keyword Set Wait Time |
timeout | float, None | None | float value in seconds, see keyword Set Global Timeout |
Exception ActionNotPossible is raised if element does not allow Click action.
param locator: | string locator or Control element |
---|---|
param wait_time: | |
time to wait after click, default is a library wait_time, see keyword Set Wait Time | |
param timeout: | float value in seconds, see keyword Set Global Timeout |
return: | WindowsElement object |
Examples
${element}= Middle Click name:button2
Minimize Window
Minimize the current active window or the window defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | string locator or element |
param locator: | string locator or element |
---|---|
return: | WindowsElement object |
Examples
${window} = Minimize Window # Current active window
Minimize Window executable:Spotify.exe
Print Tree
Print Control element tree.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | string locator or Control element |
max_depth | int | 8 | maximum depth level (defaults to 8) |
capture_image_folder | str, None | None | if None images are not captured |
log_as_warnings | bool | False | if set log messages are visible on the console |
Windows application structure can contain multilevel element structure. Understanding this structure is important for creating locators.
This keyword can be used to output application element structure starting with the element defined by the locator.
param locator: | string locator or Control element |
---|---|
param max_depth: | |
maximum depth level (defaults to 8) | |
param encoding: | defaults to "utf-8" |
param capture_image_folder: | |
if None images are not captured | |
param log_as_warnings: | |
if set log messages are visible on the console |
Restore Window
Window restore the current active window or the window defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | string locator or element |
param locator: | string locator or element |
---|---|
return: | WindowsElement object |
Examples
${window} = Restore Window # Current active window
Restore Window executable:Spotify.exe
Right Click
Right mouse click on element matching given locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
wait_time | float, None | None | time to wait after click, default is a library wait_time, see keyword Set Wait Time |
timeout | float, None | None | float value in seconds, see keyword Set Global Timeout |
Exception ActionNotPossible is raised if element does not allow Click action.
param locator: | string locator or Control element |
---|---|
param wait_time: | |
time to wait after click, default is a library wait_time, see keyword Set Wait Time | |
param timeout: | float value in seconds, see keyword Set Global Timeout |
return: | WindowsElement object |
Examples
${element}= Right Click name:MenuButton
Screenshot
Take a screenshot of the element defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
filename | str | null | image filename |
Exception ActionNotPossible is raised if element does not allow CaptureToImage action.
param locator: | string locator or Control element |
---|---|
param filename: | image filename |
return: | absolute path to the screenshot file |
Examples
Screenshot desktop desktop.png
Screenshot subname:Notepad notepad.png
Select
Select value on Control element if action is supported.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
value | str | null | string value to select on Control element |
Exception ActionNotPossible is raised if element does not allow Select action.
param locator: | string locator or Control element |
---|---|
param value: | string value to select on Control element |
return: | WindowsElement object |
Examples
Select type:SelectControl option2
Send Keys
Send keys to desktop, current window or to Control element defined by given locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | string locator or Control element (default None means desktop) |
keys | str, None | None | the keys to send |
interval | float | 0.01 | time between sending keys, default 0.01 seconds |
wait_time | float, None | None | time to wait after sending keys, default is a library wait_time, see keyword Set Wait Time |
send_enter | bool | False | if True then {Enter} is sent at the end of the keys |
If locator is None then keys are sent to desktop.
Exception ActionNotPossible is raised if element does not allow SendKeys action.
param locator: | string locator or Control element (default None means desktop) |
---|---|
param keys: | the keys to send |
param interval: | time between sending keys, default 0.01 seconds |
param wait_time: | |
time to wait after sending keys, default is a library wait_time, see keyword Set Wait Time | |
param send_enter: | |
if True then {Enter} is sent at the end of the keys | |
return: | WindowsElement object |
Examples
Send Keys desktop {Ctrl}{F4}
Send Keys keys={Ctrl}{F4} # locator will be NONE, keys send to desktop
${element}= Send Keys id:input5 username send_enter=True
${element}= Get Element id:pass
Send Keys ${element} password send_enter=True
Set Anchor
Set anchor to an element specified by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str | null | string locator or Control element |
timeout | float, None | None | timeout in seconds for element lookup (default 10.0) |
All following keywords using locators will use this element as an root element. Specific use case could be setting anchor to TableControl element and then getting column data belonging to that TableControl element.
To release anchor call Clear Anchor keyword.
param locator: | string locator or Control element |
---|---|
param timeout: | timeout in seconds for element lookup (default 10.0) |
Examples
Set Anchor type:Table name:Orders depth:16
FOR ${row} IN RANGE 200
${number}= Get Value name:number row ${row}
Exit For Loop If $number == ${EMPTY}
${sum}= Get Value name:sum row ${row}
Log Order number:${number} has sum:{sum}
END
Clear Anchor
Set Global Timeout
Set global timeout for element search. Applies also to Control Window keyword.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
timeout | float | null | float value in seconds |
By default library has timeout of 10 seconds.
param timeout: | float value in seconds |
---|---|
return: | previous timeout value |
Examples
${old_timeout}= Set Global Timeout 20
${old_timeout}= Set Global Timeout 9.5
Set Value
Set value of the element defined by the locator.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
locator | WindowsElement, str, None | None | string locator or Control element |
value | str, None | None | string value to set |
append | bool | False | False for setting value, True for appending value |
enter | bool | False | set True to press enter key at the end of the line |
newline | bool | False | set True to add newline to the end of value |
Note. Anchor works only on element structures where it can be relied on that root/child element tree will remain the same. Usually these kind of structures are tables.
Exception ActionNotPossible is raised if element does not allow SetValue action.
param locator: | string locator or Control element |
---|---|
param value: | string value to set |
param append: | False for setting value, True for appending value |
param enter: | set True to press enter key at the end of the line |
param newline: | set True to add newline to the end of value |
return: | WindowsElement object |
Note. It is important to set append=True if you want keep text in the element. Other option is to read current text into a variable and modify that value to pass for Set Value keyword.
Examples
Set Value type:DataItem name:column1 ab c # Set value to "ab c"
# Press ENTER after setting the value
Set Value type:Edit name:"File name:" console.txt enter=True
# Add newline (manually) at the end of the string (Notepad example)
Set Value name:"Text Editor" abc\n
# Add newline with parameter
Set Value name:"Text Editor" abc newline=${True}
# Clear Notepad window and start appending text
Set Anchor name:"Text Editor"
# all following keyword calls will use anchor element as locator
# UNLESS they specify locator specifically or Clear Anchor is used
${time}= Get Time
# Clears when append=False (default)
Set Value value=time now is ${time}
# Append text and add newline to the end
Set Value value= and it's task run time append=True newline=True
# Continue appending
Set Value value=this will appear on the 2nd line append=True
Set Wait Time
Set library wait time for action keywords.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
wait_time | float | null | float value (in seconds), e.g. 0.1 |
The wait_time is spent after each keyword performing mouse or keyboard action.
Library default wait_time is 0.5
Returns value of the previous wait_time value.
param wait_time: | |
---|---|
float value (in seconds), e.g. 0.1 | |
return: | previous wait value |
Examples
${old_wait_time}= Set Wait Time 0.2
Windows Run
Use Windows run window to launch application.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
text | str | null | text to enter into run input field |
wait_time | float | 3.0 | sleep time after search has been entered (default 3.0 seconds) |
Activated by pressing win + r.
param text: | text to enter into run input field |
---|---|
param wait_time: | |
sleep time after search has been entered (default 3.0 seconds) |
Examples
Windows Run explorer.exe
Windows Search
Use Windows search window to launch application.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
text | str | null | text to enter into search input field |
wait_time | float | 3.0 | sleep time after search has been entered (default 3.0 seconds) |
Activated by pressing win + s.
param text: | text to enter into search input field |
---|---|
param wait_time: | |
sleep time after search has been entered (default 3.0 seconds) |
Examples
Windows Search Outlook