SAS logoSAS® Mobile Investigator API
    Preparing search index...

    Interface ControlStateApi

    APIs for the methods and properties affecting the state of a control.

    interface ControlStateApi {
        allowInput: boolean;
        couldBeHidden: boolean;
        couldBeReadOnly: boolean;
        couldBeRequired: boolean;
        disabled: boolean;
        hidden: boolean;
        readOnly: boolean;
        required: boolean;
        onChange(handler: (change: StateChange) => void): void;
    }

    Hierarchy

    Index

    Properties

    allowInput couldBeHidden couldBeReadOnly couldBeRequired disabled hidden readOnly required

    Methods

    onChange

    Properties

    allowInput: boolean

    Checks if the current controls should allow input. Returns true if the control allows input, otherwise false.

    couldBeHidden: boolean

    Returns whether the control can be hidden, based on a condition.

    couldBeReadOnly: boolean

    Returns if this control could be read-only based on a condition. True if the control could be read-only, otherwise false.

    couldBeRequired: boolean

    Returns if this control could be required based on a condition. True if the control could be required, otherwise false.

    disabled: boolean

    Returns the disabled state of the calling control. True if the control is disabled, otherwise false.

    hidden: boolean

    Returns the hidden state of the calling control. True if the control is hidden, otherwise false.

    readOnly: boolean

    Returns the read-only state of the calling control. True if the control is read-only, otherwise false.

    required: boolean

    Returns the required state of the calling control. True if control is required, otherwise false.

    Methods

    • Registers a function to be invoked whenever a state change event occurs. This function receives an object that contains information about the change event.

      Parameters

      • handler: (change: StateChange) => void

        {function} Function to be invoked when a state is changed. Parameter (change: StateChange). Returns void.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods