Validate Button

Defines an action that validates the screen.

Properties

PropertyDescription
CaptionString providing a caption for the component.
EnabledBoolean indicating whether or not the component is enabled.
HintSpecifies the user hint string that will appear in the component's interactive help bubble.
IconString indicating the image to use for an icon (Qubes 5.4).
IconSizeDimensions of your icon, can be written as one or two values, syntax detailed there (Qubes 9.0).
TabIndexInteger indicating the component's tab order (Qubes 5.6).
VisibleBoolean indicating whether or not the component will be visible.
ThemeString defining the appearance of the button, uses button styles (Qubes 9.0).
CaptchaEnabledBoolean defining if a captcha modal pops up on validation (Qubes 9.0).
CaptchaTextString defining the text of the captcha model when it is enabled (Qubes 9.0).

Value

Has a value of False before the button is clicked, then changes to True, once it has been clicked (triggering the screen to exit).

Remarks

When you click on this button, the following will happen:

  • synchronous evaluation of the validation formulas;
  • if any of the validations fail, the corresponding validation error message(s) will be displayed, and the validation action will be cancelled;
  • synchronous evaluation of the exit formulas;
  • closure of the screen.

To close a screen without validation, use the cancel button.

Note: Button captions are always single-line (so any line breaks are replaced by spaces).

More information on the evaluation of validation and exit formulas

Classification

Standards