Skip to content

Button

The Button widget triggers actions when clicked.

XML Fields

  • XPath provides the data context available to the button label and script. It does not itself store a button value.
  • Label/Content is the visible label and can use a data template. HandleScript/Content is the script run after successful validation.
  • ValidationGroup limits validation to rules in that group. If validation fails, the click script is not run.
  • Icon selects the displayed icon and HtmlClass supplies an optional presentation class. Hints gives help text; Rules controls conditional visibility or editability.

Properties

  • Label: Specifies the text displayed on the button. This can be a static string or a data template.
  • HandleScript: Contains the JavaScript code to execute on click. This script can access client-side scripting objects like $Xml and supports async/await syntax.

Info

If script execution exceeds 50ms, a loading spinner is displayed until completion.

  • Icon: Specifies an icon to display on the button.
  • ValidationGroup: Specifies the validation group associated with the button. Clicking the button triggers validation only for rules within this group. If any rule fails, the click event is canceled, and the HandleScript is not executed.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<Button ValidationGroup="" Icon="" HtmlClass="" XPath="">
    <Label>
        <Content><![CDATA[Click Me]]></Content>
    </Label>
    <HandleScript>
        <Content><![CDATA[alert('Hi.');]]></Content>
    </HandleScript>
    <Hints><![CDATA[]]></Hints>
    <Rules />
</Button>