Clear Clipboard

Clear the system clipboard.

Click

Click at the element indicated by locator.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator, NoneType] NoneLocator for click position
action Action { click | left_click | double_click | ... } Action.clickClick action, e.g. right click
param locator:Locator for click position
param action:Click action, e.g. right click

Examples

*** Tasks ***
Click
Click    LoginForm.Button
Click    coordinates:500,200    triple click

Click With Offset

Click at a given pixel offset from the given locator.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator, NoneType] NoneLocator for click start position
x int 0Click horizontal offset in pixels
y int 0Click vertical offset in pixels
action Action { click | left_click | double_click | ... } Action.clickClick action, e.g. right click
param locator:Locator for click start position
param x:Click horizontal offset in pixels
param y:Click vertical offset in pixels
param action:Click action, e.g. right click

Examples

*** Tasks ***
Click with offset    Robocorp.Logo    y=400

Close All Applications

Close all opened applications.

Examples

*** Tasks ***
Open file    order1.docx
Open file    order2.docx
Open file    order3.docx
# Do something with Word
Close all applications

Close Application

Close given application. Needs to be started with this library.

Arguments

Argument Type Default value Description
app ApplicationApp instance

Close given application. Needs to be started with this library.

param app:App instance

Examples

*** Tasks ***
${word}=    Open file    template.docx
# Do something with Word
Close application    ${word}

Copy To Clipboard

Read value to system clipboard from given input element.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator]Locator for element
param locator:Locator for element
returns:Current clipboard value

Examples

*** Tasks ***
${value}=    Copy to clipboard    ResultPage.Counter
Log    Copied text: ${value}

Define Region

Return a new Region with the given dimensions.

Arguments

Argument Type Default value Description
left intLeft edge coordinate.
top intTop edge coordinate.
right intRight edge coordinate.
bottom intBottom edge coordinate.
param left:Left edge coordinate.
param top:Top edge coordinate.
param right:Right edge coordinate.
param bottom:Bottom edge coordinate.

Usage examples:

*** Tasks ***
${region}=  Define Region  10  10  50  30
*** Tasks ***
region = desktop.define_region(10, 10, 50, 30)

Drag And Drop

Drag mouse from source to destination while holding the left mouse button.

Arguments

Argument Type Default value Description
source typing.Union[str, RPA.core.locators.containers.Locator]Locator for start position
destination typing.Union[str, RPA.core.locators.containers.Locator]Locator for destination position
start_delay float 2.0Delay in seconds after pressing down mouse button
end_delay float 0.5Delay in seconds before releasing mouse button
param source:Locator for start position
param destination:
 Locator for destination position
param start_delay:
 Delay in seconds after pressing down mouse button
param end_delay:
 Delay in seconds before releasing mouse button

Find Element

Find an element defined by locator, and return its position. Raises ElementNotFound if` no matches were found, or MultipleElementsFound if there were multiple matches.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator]Locator string

Find an element defined by locator, and return its position. Raises ElementNotFound if` no matches were found, or MultipleElementsFound if there were multiple matches.

param locator:Locator string

Examples

*** Tasks ***
${match}=    Find element    image:logo.png
Log    Found logo at ${match.x}, ${match.y}

Find Elements

Find all elements defined by locator, and return their positions.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator]Locator string
param locator:Locator string

Examples

*** Tasks ***
${matches}=    Find elements    image:icon.png
FOR    ${match}  IN  @{matches}
    Log    Found icon at ${match.x}, ${match.y}
END

Get Clipboard Value

Read current value from system clipboard.

Examples

*** Tasks ***
Copy to clipboard       coordinates:401,198
${text}=    Get clipboard value
Log    We just copied '${text}'

Get Display Dimensions

Returns the dimensions of the current virtual display, which is the combined size of all physical monitors.

Returns the dimensions of the current virtual display, which is the combined size of all physical monitors.

Get Mouse Position

Get current mouse position in pixel coordinates.

Examples

*** Tasks ***
${position}=    Get mouse position
Log    Current mouse position is ${position.x}, ${position.y}

Highlight Elements

Draw an outline around all matching elements.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator]

Move Mouse

Move mouse to given coordinates.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator]Locator for mouse position
param locator:Locator for mouse position

Examples

*** Tasks ***
Move mouse    Robocorp.Logo
Move mouse    offset:0,400

Move Region

Return a new Region with an offset from the given region.

Arguments

Argument Type Default value Description
region RegionThe region to move.
left intAmount of pixels to move left/right.
top intAmount of pixels to move up/down.
param region:The region to move.
param left:Amount of pixels to move left/right.
param top:Amount of pixels to move up/down.

Usage examples:

*** Tasks ***
${region}=          Find Element  ocr:"Net Assets"
${moved_region}=    Move Region  ${region}  500  0
*** Tasks ***
region = desktop.find_element('ocr:"Net Assets"')
moved_region = desktop.move_region(region, 500, 0)

Open Application

Start a given application by name (if in PATH), or by path to executable.

Arguments

Argument Type Default value Description
name_or_path strName or path of application
*args

Start a given application by name (if in PATH), or by path to executable.

param name_or_path:
 Name or path of application
param args:Command line arguments for application
returns:Application instance

Examples

*** Tasks ***
Open application    notepad.exe
Open application    c:\path\to\program.exe    --example-argument

Open File

Open a file with the default application.

Arguments

Argument Type Default value Description
path strPath to file
param path:Path to file

Examples

*** Tasks ***
Open file    orders.xlsx

Paste From Clipboard

Paste value from system clipboard into given element.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator]Locator for element
param locator:Locator for element

Examples

*** Tasks ***
Copy to clipboard       coordinates:401,198
Paste from clipboard    coordinates:822,710

Press Keys

Press multiple keys down simultaneously.

Arguments

Argument Type Default value Description
*keys str
param keys:Keys to press

Examples

*** Tasks ***
Press keys    ctrl  alt  delete

Press keys    ctrl  a
Press keys    ctrl  c
${all_text}=  Get clipboard value
Log    Text box content was: ${all_text}

Press Mouse Button

Press down mouse button and keep it pressed.

Arguments

Argument Type Default value Description
button typing.Any left

Read Text

Read text using OCR from the screen, or an area of the screen defined by the given locator.

Arguments

Argument Type Default value Description
locator str NoneLocation of element to read text from
invert bool FalseInvert image colors, useful for reading white text on dark background

Read text using OCR from the screen, or an area of the screen defined by the given locator.

param locator:Location of element to read text from
param invert:Invert image colors, useful for reading white text on dark background

Usage examples:

*** Tasks ***
${label_region}=  Find Element  image:label.png
${value_region}=  Move Region   ${label_region}  100  0
${text}=          Read Text     ${value_region}
*** Tasks ***
label_region = desktop.find_element("image:label.png")
value_region = desktop.move_region(label_region, 100, 0)
text = desktop.read_text(value_region)

Release Mouse Button

Release mouse button that was previously pressed.

Arguments

Argument Type Default value Description
button typing.Any left

Resize Region

Return a resized new Region from a given region.

Arguments

Argument Type Default value Description
region RegionThe region to resize.
left int 0Amount of pixels to resize left edge.
top int 0Amount of pixels to resize top edge.
right int 0Amount of pixels to resize right edge.
bottom int 0Amount of pixels to resize bottom edge.

Extends edges the given amount outward from the center, i.e. positive left values move the left edge to the left.

param region:The region to resize.
param left:Amount of pixels to resize left edge.
param top:Amount of pixels to resize top edge.
param right:Amount of pixels to resize right edge.
param bottom:Amount of pixels to resize bottom edge.

Usage examples:

*** Tasks ***
${region}=          Find Element  ocr:"Net Assets"
${resized_region}=  Resize Region  ${region}  bottom=10
*** Tasks ***
region = desktop.find_element('ocr:"Net Assets"')
resized_region = desktop.resize_region(region, bottom=10)

Set Clipboard Value

Write given value to system clipboard.

Arguments

Argument Type Default value Description
text str

Examples

*** Tasks ***
Set clipboard value     This is some text.
Paste from clipboard    coordinates:822,710

Set Default Confidence

Set the default template matching confidence.

Arguments

Argument Type Default value Description
confidence float NoneValue from 1 to 100
param confidence:
 Value from 1 to 100

Set Default Timeout

Set the default time to wait for elements.

Arguments

Argument Type Default value Description
timeout float 3.0Time in seconds
param timeout:Time in seconds

Take Screenshot

Take a screenshot of the whole screen, or an element identified by the given locator.

Arguments

Argument Type Default value Description
path str NonePath to screenshot. The string {index} will be replaced with an index number to avoid overwriting previous screenshots.
locator typing.Union[str, RPA.core.locators.containers.Locator, NoneType] NoneElement to crop screenshot to
embed bool TrueEmbed screenshot into Robot Framework log

Take a screenshot of the whole screen, or an element identified by the given locator.

param path:Path to screenshot. The string {index} will be replaced with an index number to avoid overwriting previous screenshots.
param locator:Element to crop screenshot to
param embed:Embed screenshot into Robot Framework log

Type Text

Type text one letter at a time.

Arguments

Argument Type Default value Description
text strText to write
*modifiers str
enter bool FalsePress Enter / Return key after typing text
param text:Text to write
param modifiers:
 Modifier or functions keys held during typing
param enter:Press Enter / Return key after typing text

Examples

*** Tasks ***
Type text    this text will be uppercase    shift

Type Text Into

Type text at the position indicated by given locator.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator]Locator of input element
text strText to write
clear bool FalseClear element before writing
enter bool FalsePress Enter / Return key after typing text
param locator:Locator of input element
param text:Text to write
param clear:Clear element before writing
param enter:Press Enter / Return key after typing text

Examples

*** Tasks ***
Type text into    LoginForm.Name      Marky Mark
Type text into    LoginForm.Password  ${PASSWORD}

Wait For Element

Wait for an element defined by locator to exist, or raise a TimeoutException if none were found within timeout.

Arguments

Argument Type Default value Description
locator typing.Union[str, RPA.core.locators.containers.Locator]Locator string
timeout float None
interval float 0.5

Wait for an element defined by locator to exist, or raise a TimeoutException if none were found within timeout.

param locator:Locator string

Examples

*** Tasks ***
Wait for element    alias:CookieConsent    timeout=30
Click    image:%{ROBOT_ROOT}/accept.png