Set Checkbox

Checks, unchecks or toggles a check box, toggle or radio button.

Behaviour

Risk: Low · Idempotent: No · Safe to retry: No · 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.setCheckbox

Windows · Needs an interactive desktop session

Properties#

Input#

Target#

Target · String · Optional · Default: Not specified in package metadata

The element to act on: a repo: reference into the object repository, or the target captured with Pick element.

Required when InputElement=.

Action#

Action · String · Optional · Default: Not specified in package metadata

Check, Uncheck or Toggle. Empty keeps the older behaviour, where Checked decides (and an empty Checked unchecks).

Allowed values: Check, Uncheck, Toggle.

Input element#

InputElement · String · Optional · Default: Not specified in package metadata

An element an earlier activity found (its Output element, or an item of Find Elements' Elements), used instead of Target.

Wait for page load#

WaitForPageLoad · String · Optional · Default: Not specified in package metadata

What to wait for before looking for the element: None; Interactive (page parsed, window accepts input); Complete (page fully loaded, application not busy). Empty uses the enclosing scope's (Interactive by default).

Allowed values: None, Interactive, Complete.

Delay before (ms)#

DelayBefore · Int32 · Optional · Default: Not specified in package metadata

How long to wait before the activity starts, in milliseconds.

Delay after (ms)#

DelayAfter · Int32 · Optional · Default: Not specified in package metadata

How long to wait after the activity has finished, in milliseconds.

Alter disabled element#

AlterDisabledElement · Boolean · Optional · Default: Not specified in package metadata

Act on the element even when it is disabled. In a browser its disabled state is removed first; on the desktop the action is sent to it as it is.

Cursor motion#

CursorMotion · String · Optional · Default: Instant

With hardware input: Instant places the cursor on the element at once; Smooth moves it there in visible steps, as a person would.

Allowed values: Instant, Smooth.

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#

Checked#

Checked · Boolean · Optional · Default: Not specified in package metadata · Advanced

Used only when Action is empty: the wanted state, where empty means unchecked. Prefer Action.

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.

Fallback methods start after (s)#

FallbackAfterSeconds · Double? · Optional · Default: Not specified in package metadata · Advanced

How long the first enabled targeting method looks alone before the other methods join it. A fallback method wins only with a single match. 0 tries every method from the start. Empty keeps the target's setting (3 seconds by default).

Output#

Output element#

OutputElement · String · Output

The element this activity found, for later activities' Input element. Valid while its session is open.

Rules#

Must be inside Use Application/Browser.
Set only one of: Target, Input element.

Retry and risk#

This activity is not marked safe to retry: if it fails partway, check whether its work already happened before running it again. 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.

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