Skip to main content

 

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

Checkbox

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • Check box field where the user can enable or disable an option. The value must be stored in a Boolean variable.

    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
    Variable Holds the value entered by the user. Yes
    Enabled Boolean literal or expression that defines if the widget is editable. True
    Style Classes Specifies one or more style classes to apply to the widget. Separate multiple values with spaces. "checkbox"
    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 created is property="property". For example, the nowrap property doesn't require a value, therefore it's nowrap="nowrap".

    Events

    Name Description Mandatory Observations
    On Change Screen action to execute, or screen to navigate to when the value of the element changes.
    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
    Valid False when required inputs aren't present or the input value doesn't comply with the defined data type. You can override this property value when performing custom validations. Boolean
    ValidationMessage Message describing the built-in validation constraints not satisfied when 'Valid' is False. You can override this property value when performing custom validations. Text
    • Was this article helpful?