HybridForms API
    Preparing search index...

    Class FormControlAbstract

    Base class of all form controls.Writes values into the fields blob, sets ui classes and defines the structure of all form controls.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    defaultValue: any
    disposed: boolean
    element: HTMLElement
    enabled: any
    label: string
    labelEl: JQuery<HTMLElement>
    onChanged: (value: any) => void
    required: boolean
    tooltip: string
    visiting: boolean = false

    Methods

    • Deletes the all fields related to the form control.

      Parameters

      • name: string

        The field id.

      Returns Promise<any>

    • Disables the form control.

      Returns void

    • Disposes the form control.

      Returns void

    • Enables the form control.

      Returns void

    • Returns any

      all fields and values that are connected with the the form control.

    • Gets the default value auf the form control, if it is set.

      Returns any

    • Gets the PostfixFieldId. Relevant for operations in repeating units. Check first, if the form control is contained in a repeating unit, see: isRepeatingUnit.

      Returns string

    • Searches for a field by providing its id.

      Parameters

      • id: string

        The id of the field.

      Returns IFormField

    • Hide FormControl

      Parameters

      • animate: boolean = false

        En/Disable animation

      • lock: boolean = true

        Enable lock of hidden FormControl to not process control with condition

      Returns void

    • Checks if the form control is included in a repeating unit.

      Returns boolean

    • Sets the field value of the form control. Be careful: This does not update the UI. In most cases it is better to use the val() method, see: val

      Parameters

      • value: any

        The value of the field

      Returns number

    • Sets a new label value.

      Parameters

      • value: string

        The value to set.

      Returns void

    • Sets any field value by providing its id.

      Parameters

      • id: string

        The id of the field.

      • val: any

        The value of the field. Data type is an object. Its structure depends on the specific field type.

      Returns number

    • Show hidden FormControl

      Parameters

      • animate: boolean = false

        En/Disable animation

      • unlock: boolean = true

        Disable lock of hidden state to process control with condition

      Returns void

    • Sets ui value and updates the field value.

      Parameters

      • Optionalvalue: any

        The value of the field. Data type is an object. Its structure depends on the specific field type/form control.

      • OptionaldisableOnChanged: any

      Returns any