Class Checkbox

constructor

• new Checkbox(id: string): Checkbox

  Parameters

  • id: string

  Returns Checkbox

Readonlyid

onCheckedChange

• onCheckedChange(
      callback: (checked: boolean) => void | Promise<void>,
  ): CallbackUnsubscribeOption

  Parameters

  • callback: (checked: boolean) => void | Promise<void>

  Returns CallbackUnsubscribeOption

onRendered

• onRendered(
      callback: OnRenderedCallback<HTMLLabelElement>,
  ): CallbackUnsubscribeOption

  See CustomControl.onRendered for detailed information on what you can do with this listener and what it is not meant for.

  Also see OnRenderedCallback for important information regarding the element which is passed to the callback.

  Parameters

  • callback: OnRenderedCallback<HTMLLabelElement>

  Returns CallbackUnsubscribeOption

setChecked

• setChecked(checked: boolean): void

  Parameters

  • checked: boolean

  Returns void

setProperty

• setProperty<
      T extends
          | "minWidth"
          | "minHeight"
          | "maxWidth"
          | "maxHeight"
          | "margin"
          | "padding"
          | "cssClasses"
          | "backgroundNormal"
          | "backgroundHover"
          | "backgroundPressed"
          | "borderRadius"
          | "font"
          | "color"
          | "enabled"
          | "tooltipText"
          | "tooltipPos"
          | "checked"
          | "captionPos"
          | "captionText",
  >(
      propertyName: T,
      value: SetCheckboxPropertyValue[T],
  ): void

  Set arbitrary properties of the checkbox control.
  Behavior is the same as when setting the respective property in the configurator editor.

  Some properties are not allowed to be set here because they have a dedicated method which should be used instead.
  E.g. setting visible is not allowed because CheckboxV1.setVisible should be used instead.

  Type Parameters

  • T extends
        | "minWidth"
        | "minHeight"
        | "maxWidth"
        | "maxHeight"
        | "margin"
        | "padding"
        | "cssClasses"
        | "backgroundNormal"
        | "backgroundHover"
        | "backgroundPressed"
        | "borderRadius"
        | "font"
        | "color"
        | "enabled"
        | "tooltipText"
        | "tooltipPos"
        | "checked"
        | "captionPos"
        | "captionText"

  Parameters

  • propertyName: T
  • value: SetCheckboxPropertyValue[T]

  Returns void

setVisible

• setVisible(visible: boolean): Promise<void>

  Parameters

  • visible: boolean

  Returns Promise<void>