Input Dialog
Asks the signed-in user for a value, typed or picked from a list. Windows only, attended runs.
Behaviour
Risk: Low · Idempotent: No · Safe to retry: No · Recovery: Not replayed after a crash
Package System activities VeloPhex.System.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.system.inputDialog
Needs an interactive desktop session
Properties#
Input#
Title#
Title · String · Optional · Default: Not specified in package metadata
The dialog's title.
Label#
Label · String · Required · Default: Not specified in package metadata
The question, shown above the field.
Options#
Options · IEnumerable<String> · Optional · Default: Not specified in package metadata
Values to pick from; the field becomes a drop-down. Empty: free text.
Default Value#
DefaultValue · String · Optional · Default: Not specified in package metadata
The value the field starts with.
Is Password#
IsPassword · Boolean · Optional · Default: False
Mask what the user types; the answer goes to Secure Result, not Result.
Timeout (ms)#
TimeoutMS · Int32? · Optional · Default: Not specified in package metadata
How many milliseconds to wait for an answer before the step fails. Empty: no limit.
Fields#
Fields · IEnumerable<String> · Optional · Default: Not specified in package metadata
Field labels for a form with one text box each (Custom Input); Options is then ignored. Empty: one field.
Output#
Result#
Result · String · Output
The value entered or picked (the first field's, with Fields); null when the user cancelled or with Is Password.
Cancelled#
Cancelled · Boolean · Output
Whether the user closed the dialog without answering.
Results#
Results · IDictionary<String, Object> · Output · Sensitive
Each field's value by its label, with Fields: a string, or a SecureString with Is Password. Null when the user cancelled.
Secure Result#
SecureResult · SecureString · Output · Sensitive
With Is Password: the value as a SecureString, masked everywhere. Null otherwise or when the user cancelled.
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.
Related activities#
Generated from VeloPhex.System.Activities 0.7.1-rc.12. Category: Dialogs. Keywords: input, dialog, ask, prompt, question, form, attended, user.
Properties
Input
Output
Retry and risk
Related activities