Skip to main content

 

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

Button

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • Provides a button that users can click or tap to trigger an action, submit data or navigate to another screen.

    If the button belongs to a form with some input fields, the button submits the information if you set Is Form Default property to Yes in the Button Widget. This is useful when you have several buttons in your form.

    Properties

    Name Description Mandatory Default value Observations
    Name Identifies an element in the scope where it's defined, like a screen, action, or module. Yes
    Confirmation Message Text literal or expression to define the confirmation message displayed after clicking this widget.
    Enabled Boolean literal or expression that defines if the widget is editable. True
    Is Form Default Boolean to specify if the button should submit form that's enclosed in. No The entry redirects to the screen it points to.
    Visible Boolean literal or expression that defines to display the widget or not. Yes True
    Style Classes Specifies one or more style classes to apply to the widget. Separate multiple values with spaces. "btn" The first button dragged to the screen or to the form is going to have an additional style class 'btn-primary'.
    Attributes
    Property Name of an attribute to add to the HTML translation for this element. You can pick a property from the drop-down list or type a free text. The name of the property isn't validated by the platform.

    Duplicated properties aren't allowed. Spaces, " or ' are also not allowed.
    Value Value of the attribute. You can type the value directly or write expressions using the Expression Editor.

    If the Value is empty, the corresponding HTML tag is property="property". For example, the nowrap property doesn't require a value, therefore it's property is nowrap="nowrap".

    Events

    Name Description Mandatory Observations
    On Click When the user clicks the widget, you can add a screen action to run or a screen to navigate to. Yes
    Built-in Validations Set to Yes to enable built-in validations for widgets that share the same form or screen with this widget.
    Transition Transition effect applied when navigating to another screen. By default defined at module level.
    Event JavaScript or custom event to handle.
    Handler JavaScript event handler.

    Runtime properties

    Name Description Read Only Type Observations
    Id Identifies the widget instance at runtime (HTML 'id' attribute). You can use it in JavaScript and Extended Properties. Yes Text
    • Was this article helpful?