Fig. 1 - Button control
An on-screen button for the user to perform the action specified in the ButtonAction property (see below).
Properties that are common to this and many other controls are described in Common Properties.
Property | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Background | See Common Properties | |||||||||||||||||||||||||||||||||
BorderBrush | See Common Properties | |||||||||||||||||||||||||||||||||
BorderThickness | See Common Properties | |||||||||||||||||||||||||||||||||
ButtonAction | Determines what happens when the user clicks the button.![]() Fig. 2 shows the options available. Fig. 2 - Button Action Options The available options can be separated into the following categories: ![]()
![]()
![]()
![]()
|
|||||||||||||||||||||||||||||||||
ButtonOutcome | A user-defined outcome, which is then available as a screen step outcome in the script (flowchart) To enable, ButtonAction must be set to the value Outcome. |
|||||||||||||||||||||||||||||||||
ButtonShortcut | Assigns the button action to a keyboard F key (i.e. F1 to F12) | |||||||||||||||||||||||||||||||||
Content | Defines the text to display on the button | |||||||||||||||||||||||||||||||||
FontFamily | See Common Properties | |||||||||||||||||||||||||||||||||
FontSize | See Common Properties | |||||||||||||||||||||||||||||||||
FontStyle | See Common Properties | |||||||||||||||||||||||||||||||||
FontWeight | See Common Properties | |||||||||||||||||||||||||||||||||
Foreground | See Common Properties | |||||||||||||||||||||||||||||||||
Height | See Common Properties | |||||||||||||||||||||||||||||||||
IsEnabled | See Common Properties | |||||||||||||||||||||||||||||||||
Language | See Common Properties | |||||||||||||||||||||||||||||||||
Margin | See Common Properties | |||||||||||||||||||||||||||||||||
Name | See Common Properties | |||||||||||||||||||||||||||||||||
StepName | The target step if the ButtonAction is MoveToStep | |||||||||||||||||||||||||||||||||
TabIndex | See Common Properties | |||||||||||||||||||||||||||||||||
Validate | If checked, the button will be disabled until valid values are entered into all ValidationTextBox controls present on the page | |||||||||||||||||||||||||||||||||
Visibility | See Common Properties | |||||||||||||||||||||||||||||||||
Width | See Common Properties |
Fig. 6 - Toolbox button example
The example in Fig. 6 shows a button control (Next) being positioned on a screen. The function of the new button here is to move forward in the script to the next screen in the script.
To configure the button to do this, the ButtonAction property is set to Outcome. This means that when the user clicks this button, the script step ends with the outcome defined in the ButtonOutcome field.
The term 'Outcome' used in the ButtonAction field refers to the Screen Step Outcome, not the Call Outcome (see Call Outcome Presets below).
See also the ImageButton control.