Send Keys

Sends key chords to a browser session's page, or to a window session's window, brought to the front first.

Behaviour

Risk: Medium · 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.sendKeys

Windows · Needs an interactive desktop session

Properties#

Input#

Keys#

Keys · String · Required · Default: Not specified in package metadata · Sensitive

The key chords to send, e.g. {Ctrl}{S}, {Alt}{F4} or Hello{Enter}.

Allow foreground input#

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

With no session open, press the keys in whatever window is in the foreground. Off by default, and then Send Keys without a session fails instead.

Verify execution#

VerifyExecution · String · Optional · Default: None

Check that the keys worked: the Verify target Appears, Disappears or its text changes (TextChanges), within the timeout. Send Keys has no element of its own, so any check needs a Verify target. None skips the check.

Allowed values: None, Appears, Disappears, TextChanges.

Verify target#

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

The element Verify execution watches; required for any check, since Send Keys has no element of its own.

Retry until verified#

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

When the check fails, repeat the action (up to 3 attempts in all, inside the timeout). Off by default, because repeating a click or key press is not always safe.

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.

Rules#

  • Must be inside Use Application/Browser.

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

Rules

Retry and risk

Related activities