Skip to main content

Capture Webpage

Command description

Take a screenshot of the specified web page or web page element and save it to a file.

Command Input Parameters

input parametersInput parameter typeDescription
Webpage ObjectWebPage
Screenshot AreaenumWeb Element, Visible Webpage Area, Entire Webpage
Web ElementWebElement or str (captured element UID, not element name, not ms-rpa-id)Element to capture; required only when Screenshot Area is Web Element. Select a captured element or one returned by Get Web Element, Get Similar Web Elements, or Get Related Web Elements
Folder LocationstrFolder to save screenshots
File Name PatternenumRandom File Name, Custom File Name
Custom File NamestrRequired only when File Name Pattern is Custom File Name
Element Wait DurationnumberMaximum time to wait for the element, in seconds; required only when Screenshot Area is Web Element

Command Output Parameters

Output parametersOutput parameter typeDescription
Screenshot Save Pathstr

Type definition reference

tip

Example

FAQ

See Web Automation FAQ