Class CheckBox

The HybridForms CheckBox form control. For checkbox user inputs.

Hierarchy

Constructors

constructor

Properties

defaultValue disposed element enabled floatLeft label labelEl onChanged options required tooltip visiting

Methods

deleteFields disable dispose enable get getAllValues getDefault getPostfixFieldId getWithId hide isRepeatingUnit set setLabel setWithId show val

Constructors

constructor

Properties

defaultValue

defaultValue: any

Protected disposed

disposed: boolean

element

element: HTMLElement

enabled

enabled: any

floatLeft

floatLeft: Boolean

label

label: string

labelEl

labelEl: JQuery<HTMLElement>

onChanged

onChanged: any

Protected options

options: any

required

required: boolean

tooltip

tooltip: string

visiting

visiting: boolean = false

Methods

deleteFields

  • Deletes the all fields related to the form control.

    Parameters

    • name: string

      The field id.

    Returns Promise<any>

disable

  • Disables the form control.

    Returns void

dispose

  • Disposes the form control.

    Returns void

enable

  • Enables the form control.

    Returns void

get

getAllValues

  • Returns

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

    Returns any

getDefault

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

    Returns any

getPostfixFieldId

  • 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

getWithId

hide

  • 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

isRepeatingUnit

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

    Returns boolean

set

  • 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

setLabel

  • Sets a new label value.

    Parameters

    • value: string

      The value to set.

    Returns void

setWithId

  • 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

  • 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

val

  • Sets ui value and updates the field value.

    Parameters

    • value: any

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

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc