The checkbox control is a fundamental UI element that allows users to select or deselect an option. It is typically used to represent Boolean data (true/false or yes/no). The state of the checkbox (checked or unchecked) reflects the underlying Boolean value it is associated with.

This control can function both as an input element, allowing users to change the value, and as a view element, displaying the current value. The visual representation of the checkbox in the browser (selected or not selected) corresponds to the Boolean value it represents.

Hierarchy

  • UpDataViewControl
    • Checkbox

Properties

Methods

Properties

checked: boolean

Methods

  • Get the value of the control. Without settings specified, the html value will be delivered, like jQuery does. That means, that for some controls, the settings parameter will be mandatory to retrieve an useful value.

    Returns string

  • Sets the text content of the associated HTML element.

    This method allows you to programmatically set the text content of the HTML element associated with the control. It replaces any existing text within the element.

    Parameters

    • value: string

      The text content to set.

    Returns void

    Note

    The value set by this method is temporary and will not persist across sessions. It will be lost once the user refreshes the page or navigates away from the current page. This feature is useful when you need to temporarily modify a value within a view control for display purposes only, such as masking an email address.

    Example

    // Get the control by its element GUID and obscure the email address "sample@intrexx.com"
    ix.api.dom.getControl("<ELEMENT-GUID>").setValue("s****e@intrexx.com");