Capture Screenshot
Saves a PNG of an element or of the whole page or window.
Behaviour
Risk: None · Idempotent: No · Safe to retry: Yes · Recovery: Not replayed after a crash
Package UI Automation activities VeloPhex.UIAutomation.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.ui.captureScreenshot
Windows · Needs an interactive desktop session
Properties#
Input#
Target#
Target · String · Optional · Default: Not specified in package metadata
The element to capture. Empty captures the session's active page or first window.
File path#
FilePath · String · Optional · Default: Not specified in package metadata
Where to save the PNG. Empty writes screenshot-<timestamp>.png into the run's screenshots folder (the run's workspace on a Runner; %TEMP%\Velophex\Screenshots in Studio).
Session#
Session · String · Optional · Default: Not specified in package metadata
The session id from a Use Application/Browser scope. Empty uses the enclosing scope's session, or outside a scope the most recent matching session.
Timeout (seconds)#
TimeoutSeconds · Int32 · Optional · Default: Not specified in package metadata
How long to keep looking for the element or window. Empty or not positive means the same as the enclosing Use Application/Browser scope, or outside a scope the project default (30 seconds).
Highlight before action#
HighlightBeforeAction · Boolean · Optional · Default: Not specified in package metadata
Draw the highlight around the element before acting on it.
Options#
Target values#
TargetValues · IReadOnlyDictionary<String, String> · Optional · Default: Not specified in package metadata · Advanced
Values for the {{name}} slots in the target's attributes, e.g. a dictionary with "invoice" for {{invoice}}. Values are matched as literal text.
Output#
Saved path#
SavedPath · String · Output
The full path of the saved PNG.
Rules#
- Must be inside Use Application/Browser.
Retry and risk#
This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.
Every activity also has the engine's common properties: Timeout and Continue On Error.
Related activities#
- Check App State
- Choose Option
- Click
- Click Text
- Drag and Drop
- Element Exists
- Extract Table Data
- Find Elements
Generated from VeloPhex.UIAutomation.Activities 0.7.1-rc.12. Category: UI Automation › Element. Keywords: ui, automation, element.
Properties
Input
Options
Output
Rules
Retry and risk
Related activities