RPA.Desktop

Clear the system clipboard.

Click at the element indicated by locator.

Arguments

ArgumentTypeDefault value
locatorstr, Locator, NoneNone
actionActionclick
param locator:Locator for click position
param action:Click action, e.g. right click

Usage

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

Click at a given pixel offset from the given locator.

Arguments

ArgumentTypeDefault value
locatorstr, Locator, NoneNone
xint0
yint0
actionActionclick
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

Usage

Click with offset Robocorp.Logo y=400

Close all opened applications.

Usage

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

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

Arguments

ArgumentTypeDefault value
appApplicationnull
param app:App instance

Usage

# Open a file with a default application ${word}= Open file template.docx # Do something with Word Close application ${word} # Open a an application with a specific executable ${ie}= Open application iexplore.exe # Do something with IE Close application ${ie}

Read value to system clipboard from given input element.

Arguments

ArgumentTypeDefault value
locatorstr, Locatornull
param locator:Locator for element
returns:Current clipboard value

Usage

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

Return a new Region with the given dimensions.

Arguments

ArgumentTypeDefault value
leftintnull
topintnull
rightintnull
bottomintnull
param left:Left edge coordinate.
param top:Top edge coordinate.
param right:Right edge coordinate.
param bottom:Bottom edge coordinate.

Usage examples:

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

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

Arguments

ArgumentTypeDefault value
sourcestr, Locatornull
destinationstr, Locatornull
start_delayfloat2.0
end_delayfloat0.5
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 an element defined by locator, and return its position. Raises ElementNotFound if` no matches were found, or MultipleElementsFound if there were multiple matches.

Arguments

ArgumentTypeDefault value
locatorstr, Locatornull
param locator:Locator string

Usage

${match}= Find element image:logo.png Log Found logo at ${match.right}, ${match.top}

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

Arguments

ArgumentTypeDefault value
locatorstr, Locatornull
param locator:Locator string

Usage

${matches}= Find elements image:icon.png FOR ${match} IN @{matches} Log Found icon at ${match.right}, ${match.top} END

Read current value from system clipboard.

Usage

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

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

Get current mouse position in pixel coordinates.

Usage

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

Draw an outline around all matching elements.

Arguments

ArgumentTypeDefault value
locatorstr, Locatornull

Move mouse to given coordinates.

Arguments

ArgumentTypeDefault value
locatorstr, Locatornull
param locator:Locator for mouse position

Usage

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

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

Arguments

ArgumentTypeDefault value
regionRegionnull
leftintnull
topintnull
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:

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

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

Arguments

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

Usage

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

Open a file with the default application.

Arguments

ArgumentTypeDefault value
pathstrnull
param path:Path to file

Usage

Open file orders.xlsx

Paste value from system clipboard into given element.

Arguments

ArgumentTypeDefault value
locatorstr, Locatornull
param locator:Locator for element

Usage

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

Press multiple keys down simultaneously.

Arguments

ArgumentTypeDefault value
keysstrnull
param keys:Keys to press

Usage

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 down mouse button and keep it pressed.

Arguments

ArgumentTypeDefault value
buttonAnyleft

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

Arguments

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

Usage examples:

${label_region}= Find Element image:label.png ${value_region}= Move Region ${label_region} 100 0 ${text}= Read Text ${value_region}
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 that was previously pressed.

Arguments

ArgumentTypeDefault value
buttonAnyleft

Return a resized new Region from a given region.

Arguments

ArgumentTypeDefault value
regionRegionnull
leftint0
topint0
rightint0
bottomint0

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:

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

Write given value to system clipboard.

Arguments

ArgumentTypeDefault value
textstrnull

Usage

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

Set the default template matching confidence.

Arguments

ArgumentTypeDefault value
confidencefloat, NoneNone
param confidence:Value from 1 to 100

Set the default time to wait for elements.

Arguments

ArgumentTypeDefault value
timeoutfloat3.0
param timeout:Time in seconds

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

Arguments

ArgumentTypeDefault value
pathstr, NoneNone
locatorstr, Locator, NoneNone
embedboolTrue
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 one letter at a time.

Arguments

ArgumentTypeDefault value
textstrnull
modifiersstrnull
enterboolFalse
param text:Text to write
param modifiers:Modifier or functions keys held during typing
param enter:Press Enter / Return key after typing text

Usage

Type text this text will be uppercase shift

Type text at the position indicated by given locator.

Arguments

ArgumentTypeDefault value
locatorstr, Locatornull
textstrnull
clearboolFalse
enterboolFalse
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

Usage

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

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

Arguments

ArgumentTypeDefault value
locatorstr, Locatornull
timeoutfloat, NoneNone
intervalfloat0.5
param locator:Locator string

Usage

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