RPA.Windows

Clears control anchor set by Set Anchor

This means that all following keywords accessing elements will use active window or desktop as root element.

Exception ActionNotPossible is raised if element does not allow Click action.

Examples

*** Tasks ***
Click  id:button1
Click  id:button2 offset:10,10
${element}=  Click  name:SendButton  wait_time=5.0

Examples

*** Tasks ***
${status}=  Close Current Window

Get control of child window of the active window by locator.

Examples

*** Tasks ***
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

This means that this window is used as a root element for all the following keywords using locators.

Returns WindowsElement.

Examples

*** Tasks ***
Control Window   Calculator
Control Window   name:Calculator
Control Window   subname:Notepad
Control Window   regex:.*Notepad
${window}=  Control Window   executable:Spotify.exe

Exception ActionNotPossible is raised if element does not allow Click action.

Examples

*** Tasks ***
${element}=  Double Click  name:ResetButton

Bring the current active window or the window defined by the locator to the foreground.

Examples

*** Tasks ***
${window}=  Foreground Window   Calculator

Examples

*** Tasks ***
${id}=   Get Attribute  type:Edit name:firstname   AutomationId

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:

1. anchor element if that has been set with Set Anchor
2. current active window if that has been set with Control Window
3. final option is the Desktop

Examples

*** Tasks ***
${element}=    Get Element    name:'Text Editor*
Set Value   ${element}  note to myself

Examples

*** Tasks ***
Set Anchor    id:DataGrid
${elements}=    Get Elements    type:HeaderItem
FOR    ${el}    IN    @{elements}
    Log To Console    ${el.Name}
END

Exception ActionNotPossible is raised if element does not allow GetWindowText action.

Examples

*** Tasks ***
${date}=  Get Text   type:Edit name:'Date of birth'

Exception ActionNotPossible is raised if element does not allow GetValuePattern action.

Examples

*** Tasks ***
${value}=   Get Value   type:DataItem name:column1

Examples

*** Tasks ***
${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

Minimize the current active window or the window defined by the locator.

Examples

*** Tasks ***
Maximize Window   # Current active window
${window}=  Maximize Window   executable:Spotify.exe

Exception ActionNotPossible is raised if element does not allow Click action.

Examples

*** Tasks ***
${element}=  Middle Click  name:button2

Minimize the current active window or the window defined by the locator.

Examples

*** Tasks ***
${window}=  Minimize Window   # Current active window
Minimize Window   executable:Spotify.exe

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.

Window restore the current active window or the window defined by the locator.

Examples

*** Tasks ***
${window}=  Restore Window   # Current active window
Restore Window   executable:Spotify.exe

Exception ActionNotPossible is raised if element does not allow Click action.

Examples

*** Tasks ***
${element}=  Right Click  name:MenuButton

Exception ActionNotPossible is raised if element does not allow CaptureToImage action.

Examples

*** Tasks ***
Screenshot  desktop   desktop.png
Screenshot  subname:Notepad   notepad.png

Exception ActionNotPossible is raised if element does not allow Select action.

Examples

*** Tasks ***
Select  type:SelectControl   option2

Send keys to desktop, current window or to Control element defined by given locator.

If locator is None then keys are sent to desktop.

Exception ActionNotPossible is raised if element does not allow SendKeys action.

Examples

*** Tasks ***
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

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.

Examples

*** Tasks ***
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 for element search. Applies also to Control Window keyword.

By default library has timeout of 10 seconds.

Examples

*** Tasks ***
${old_timeout}=  Set Global Timeout  20
${old_timeout}=  Set Global Timeout  9.5

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.

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

*** Tasks ***
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

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.

Examples

*** Tasks ***
${old_wait_time}=  Set Wait Time  0.2

Activated by pressing win + r.

Examples

*** Tasks ***
Windows Run   explorer.exe

Activated by pressing win + s.

Examples

*** Tasks ***
Windows Search   Outlook