Class ComboBox

The HybridForms Combobox. Inherits from KendoBase.

Hierarchy (View Summary)

Constructors

constructor

Properties

defaultValue disposed element enabled label labelEl onChanged options required tooltip visiting

Accessors

_ctrl currentInputCtrl initialized inputCtrl

Methods

deleteFields disable dispose enable get getAllValues getDataItem getDataSource getDefault getPostfixFieldId getWithId hide isLoaded isRepeatingUnit set setDataSource setKendoOptions setLabel setWithId show val

Constructors

constructor

Properties

defaultValue

defaultValue: any

Protecteddisposed

disposed: boolean

element

element: HTMLElement

enabled

enabled: any

label

label: string

labelEl

labelEl: JQuery<HTMLElement>

onChanged

onChanged: Function

Protectedoptions

options: any

required

required: boolean

tooltip

tooltip: string

visiting

visiting: boolean = false

Accessors

_ctrl

  • get _ctrl(): ComboBox

  • Returns ComboBox

    Deprecated

    For compatibility to old win10 formdefinition javascript implementation this member must be named '_ctrl'

currentInputCtrl

  • get currentInputCtrl(): ComboBox

  • On mobile or small devices a dialog opens when the user clicks on the control. If this dialog is open, the dialog control is returned; Otherwise the main control is returned. For the API of the kendo ui control see https://docs.telerik.com/kendo-ui/api/javascript/ui/

    Returns ComboBox

initialized

  • get initialized(): void

  • Returns void

    Deprecated

    for compatibility to old win10 formdefinition javascript implementation.

inputCtrl

Methods

deleteFields

  • deleteFields(name: string): Promise<any>

  • Deletes the all fields related to the form control.

    Parameters

    • name: string

      The field id.

    Returns Promise<any>

disable

  • disable(): void

  • Disables the form control.

    Returns void

dispose

  • dispose(): void

  • Disposes the form control.

    Returns void

enable

  • enable(): void

  • Enables the form control.

    Returns void

get

getAllValues

  • getAllValues(): any

  • Returns any

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

getDataItem

  • getDataItem(itemId: string): any

  • Parameters

    • itemId: string

      provide the name of the property that is defined as the id of the data source value field.

    Returns any

    the dataItem of the provided id of the data source.

getDataSource

  • getDataSource(): any[]

  • Gets the data source of the comboBox

    Returns any[]

getDefault

  • getDefault(): any

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

    Returns any

getPostfixFieldId

  • getPostfixFieldId(): string

  • 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(animate?: boolean, lock?: boolean): void

  • 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

isLoaded

  • isLoaded(): Promise<void>

  • Returns a Promise which is resolved when the control is fully initialized.

    Returns Promise<void>

isRepeatingUnit

  • isRepeatingUnit(): boolean

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

    Returns boolean

set

  • set(value: any): number

  • 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

setDataSource

  • setDataSource(dataSource: any[]): void

  • Set the data source of a ComboBox control.

    Parameters

    • dataSource: any[]

      Expects a key/value object. The key name is defined in the data-hf-options ('dataTextField') of the formcontrol.

    Returns void

setKendoOptions

  • setKendoOptions(options: any): void

  • Set additional options to kendo controls.

    Parameters

    • options: any

      New options to set.

    Returns void

setLabel

  • setLabel(value: string): void

  • Sets a new label value.

    Parameters

    • value: string

      The value to set.

    Returns void

setWithId

  • setWithId(id: string, val: any): number

  • 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(animate?: boolean, unlock?: boolean): void

  • 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

  • val(value?: string, disableOnChanged?: boolean): { text: string; value: string }

  • Gets or sets the value of the ComboBox control. The ComboBox control sets to fields:

      1. the field with the "id" as key and the dataValueField (defined in the formdefinition) as value.
      1. the field with the "id" plus the addition '_HFComboText' as key and the dataTextField (defined in the formdefinition) as value.

    Parameters

    • Optionalvalue: string

      [optional] If provided, the value (and the corresponding fields) of the ComboBox control gets set.

    • disableOnChanged: boolean = false

      [optional] Disables the onChanged callback if set to true. Necessary if an onChanged-Handler wants to change itself.

    Returns { text: string; value: string }

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods