# Wijmo_Angular2_Input.Wjmultiselectlistbox ## Content

WjMultiSelectListBox Class

Angular 2 component for the wijmo.input.MultiSelectListBox control.

Use the wj-multi-select-list-box component to add MultiSelectListBox controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.

The WjMultiSelectListBox component is derived from the MultiSelectListBox control and inherits all its properties, events and methods.

Type parameters

Heirarchy

Properties

Methods

Events

Properties

ariaLabelledBy

ariaLabelledBy: string

Gets or sets the aria-labelledby attribute of MultiSelectListBox input element.

asyncBindings

asyncBindings: boolean

Allows you to override the global WjOptions.asyncBindings setting for this specific component. See the WjOptions.WjOptions.asyncBindings property description for details.

caseSensitiveSearch

caseSensitiveSearch: boolean

Gets or sets a value that determines whether searches performed while the user types should case-sensitive.

The default value for this property is false.

checkOnFilter

checkOnFilter: boolean

Gets or sets a value that determines whether the MultiSelectListBox should automatically check all filtered items when the filter text changes.

The default value for this property is true, which causes the control to behave like Excel and check all visible items when the filter is applied.

For example, in a control with three items "Alice", "Bob", and "Mary", typing "a" into the filter would cause the control to show items "Alice" and "Mary", and both would be checked.

Setting this property to false prevents the control from automatically checking filtered items, and to keep checked items visible regardless of the filter value.

For example, in a control with three items "Alice", "Bob", and "Mary", typing "a" into the filter would cause the control to show items "Alice" and "Mary", but neither would be checked. If the user then checked "Mary", and typed "b" into the filter, the list would show items "Mary" (still checked) and "Bob" (unchecked).

checkedItems

checkedItems: any[]

Gets or sets an array containing the items that are currently checked.

checkedItemsChangePC

checkedItemsChangePC: EventEmitter<any>

This event is used to implement two-way binding to the checkedItems property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the checkedItemsChange event name.

checkedItemsChangedNg

checkedItemsChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo checkedItemsChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional checkedItemsChanged Wijmo event name.

checkedMemberPath

checkedMemberPath: string

Gets or sets the name of the property used to control the checkboxes placed next to each item.

collectionView

collectionView: ICollectionView<T>

Gets the ICollectionView object used as the item source.

customFilter

customFilter: CustomFilterCallback

Gets or sets a custom filter function for filtering items.

When set, this function is used instead of the default regex-based filtering.

param

The data item to test.

param

The current filter text.

param

The display text (after displayMemberPath processing).

returns

true to include the item, false to exclude it.

Setting to null restores default filtering. Requires showFilterInput to be true.

delay

delay: number

Gets or sets the delay, in milliseconds, between when a keystroke occurs and when the search is performed to update the filter.

This property is relevant only when the showFilterInput property is set to true.

The default value for this property is 500 milliseconds.

displayMemberPath

displayMemberPath: string

Gets or sets the name of the property to use as the visual representation of the items.

filterInputPlaceholder

filterInputPlaceholder: string

Gets or sets the string used as a placeholder for the filter input element.

The default value for this property is null, which causes the control to show a localized version of the string "Filter".

gotFocusNg

gotFocusNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo gotFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional gotFocus Wijmo event name.

hostElement

hostElement: HTMLElement

Gets the DOM element that is hosting the control.

initialized

initialized: EventEmitter<any>

This event is triggered after the component has been initialized by Angular, that is all bound properties have been assigned and child components (if any) have been initialized.

invalidInputNg

invalidInputNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo invalidInput event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional invalidInput Wijmo event name.

isContentHtml

isContentHtml: boolean

Gets or sets a value indicating whether items contain plain text or HTML.

The default value for this property is false.

isDisabled

isDisabled: boolean

Gets or sets a value that determines whether the control is disabled.

Disabled controls cannot get mouse or keyboard events.

isInitialized

isInitialized: boolean

Indicates whether the component has been initialized by Angular. Changes its value from false to true right before triggering the initialized event.

isTouching

isTouching: boolean

Gets a value that indicates whether the control is currently handling a touch event.

isUpdating

isUpdating: boolean

Gets a value that indicates whether the control is currently being updated.

itemsSource

itemsSource: any

Gets or sets the array or ICollectionView object that contains the list items.

listBox

listBox: ListBox

Gets a reference to the ListBox control hosted by this MultiSelectListBox.

lostFocusNg

lostFocusNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo lostFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional lostFocus Wijmo event name.

refreshedNg

refreshedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo refreshed event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshed Wijmo event name.

refreshingNg

refreshingNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo refreshing event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshing Wijmo event name.

rightToLeft

rightToLeft: boolean

Gets a value indicating whether the control is hosted in an element with right-to-left layout.

selectAllLabel

selectAllLabel: string

Gets or sets the string to be used as a label for the "Select All" checkbox that is displayed when the showSelectAllCheckbox property is set to true.

The default value for this property is null, which causes the control to show a localized version of the string "Select All".

selectedIndex

selectedIndex: number

Gets or sets the index of the currently selected item.

selectedIndexChangePC

selectedIndexChangePC: EventEmitter<any>

This event is used to implement two-way binding to the selectedIndex property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the selectedIndexChange event name.

selectedIndexChangedNg

selectedIndexChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo selectedIndexChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional selectedIndexChanged Wijmo event name.

showFilterInput

showFilterInput: boolean

Gets or sets whether the control should display a "filter" input above the items to filter the items displayed.

The default value for this property is false.

showGroups

showGroups: boolean

Gets or sets a value that determines whether the MultiSelectListBox should include group header items to delimit data groups.

Data groups are created by modifying the ICollectionView.groupDescriptions property of the ICollectionView object used as an itemsSource.

The MultiSelectListBox only shows the first level of grouping.

The default value for this property is false.

showSelectAllCheckbox

showSelectAllCheckbox: boolean

Gets or sets whether the control should display a "Select All" checkbox above the items to select or de-select all items.

The default value for this property is false.

tabOrder

tabOrder: number

Gets or sets a value of the tabindex attribute associated with the control.

tabindex attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.

Because of this, to read or change control's tabindex dynamically, you should do it using this property.

virtualizationThreshold

virtualizationThreshold: number

Gets or sets the minimum number of rows and/or columns required to enable virtualization in the drop-down ListBox.

The default value for this property is a very big number, meaning virtualization is disabled. To enable virtualization, set its value to 0 or a positive number.

For more detals, please see the ListBox.virtualizationThreshold property.

wjModelProperty

wjModelProperty: string

Defines a name of a property represented by [(ngModel)] directive (if specified). Default value is 'checkedItems'.

Static controlTemplate

controlTemplate: string

Gets or sets the template used to instantiate MultiSelectListBox controls.

Methods

applyTemplate

  • applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement

  • Applies the template to a new instance of a control, and returns the root element.

    This method should be called by constructors of templated controls. Therefore, this method is not available. It is responsible for binding the template parts to the corresponding control members.

    For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.

    this.applyTemplate('wj-control wj-inputnumber', templateString, {
  _tbx: 'input',
  _btnUp: 'btn-inc',
  _btnDn: 'btn-dec'
}, 'input');

    @param classNames Names of classes to add to the control's host element. @param template An HTML string that defines the control template. @param parts A dictionary of part variables and their names. @param namePart Name of the part to be named after the host element. This determines how the control submits data when used in forms.

    Parameters

    • classNames: string
    • template: string
    • parts: Object
    • Optional namePart: string

    Returns HTMLElement

beginUpdate

  • beginUpdate(): void

containsFocus

  • containsFocus(): boolean

  • Checks whether this control contains the focused element.

    Returns boolean

created

  • created(): void

  • If you create a custom component inherited from a Wijmo component, you can override this method and perform necessary initializations that you usually do in a class constructor. This method is called in the last line of a Wijmo component constructor and allows you to not declare your custom component's constructor at all, thus preventing you from a necessity to maintain constructor parameters and keep them in synch with Wijmo component's constructor parameters.

    Returns void

deferUpdate

  • deferUpdate(fn: Function): void

  • Executes a function within a beginUpdate/endUpdate block.

    The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.

    Parameters

    • fn: Function

      Function to be executed.

    Returns void

endUpdate

  • endUpdate(shouldInvalidate?: boolean): void

  • Resumes notifications suspended by calls to beginUpdate.

    Parameters

    • Optional shouldInvalidate: boolean

      should invalidate the control. Default value for this parameter is true.

    Returns void

focus

  • focus(): void

  • Sets the focus to this control.

    Returns void

getTemplate

  • getTemplate(): string

  • Gets the HTML template used to create instances of the control.

    This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).

    Returns string

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean

  • Determines whether an object has a property with the specified name.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

initialize

  • initialize(options: any): void

  • Initializes the control by copying the properties from a given object.

    This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.

    For example:

    grid.initialize({
  itemsSource: myList,
  autoGenerateColumns: false,
  columns: [
    { binding: 'id', header: 'Code', width: 130 },
    { binding: 'name', header: 'Name', width: 60 }
  ]
});

// is equivalent to
grid.itemsSource = myList;
grid.autoGenerateColumns = false;
// etc.

    The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.

    Parameters

    • options: any

      Object that contains the initialization data.

    Returns void

invalidate

  • invalidate(fullUpdate?: boolean): void

  • Invalidates the control causing an asynchronous refresh.

    Parameters

    • Optional fullUpdate: boolean

      Whether to update the control layout as well as the content.

    Returns void

isPrototypeOf

  • isPrototypeOf(v: Object): boolean

  • Determines whether an object exists in another object's prototype chain.

    Parameters

    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean

onCheckedItemsChanged

  • onCheckedItemsChanged(e?: any): void

onGotFocus

onInvalidInput

onRefreshed

onRefreshing

onSelectedIndexChanged

  • onSelectedIndexChanged(e?: EventArgs): void

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean

  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

removeEventListener

  • removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

  • Removes one or more event listeners attached to elements owned by this Control.

    Parameters

    • Optional target: EventTarget

      Target element for the event. If null, removes listeners attached to all targets.

    • Optional type: string

      String that specifies the event. If null, removes listeners attached to all events.

    • Optional fn: any

      Handler to remove. If null, removes all handlers.

    • Optional capture: boolean

      Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

    Returns number

    The number of listeners removed.

toLocaleString

  • toLocaleString(): string

  • Returns a date converted to a string using the current locale.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): Object

  • Returns the primitive value of the specified object.

    Returns Object

Static disposeAll

  • disposeAll(e?: HTMLElement): void

  • Disposes of all Wijmo controls contained in an HTML element.

    Parameters

    • Optional e: HTMLElement

      Container element.

    Returns void

Static getControl

  • getControl(element: any): Control

  • Gets the control that is hosted in a given DOM element.

    Parameters

    • element: any

      The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

    Returns Control

Static invalidateAll

  • invalidateAll(e?: HTMLElement): void

  • Invalidates all Wijmo controls contained in an HTML element.

    Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.

    If this happens, you must handle the appropriate event in the dynamic container and call the Control.invalidateAll method so the contained Wijmo controls will update their layout information properly.

    Parameters

    • Optional e: HTMLElement

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Returns void

Static refreshAll

  • refreshAll(e?: HTMLElement): void

  • Refreshes all Wijmo controls contained in an HTML element.

    This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.

    Parameters

    • Optional e: HTMLElement

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Returns void

Events

checkedItemsChanged

checkedItemsChanged: Event<MultiSelectListBox<any>, EventArgs>

Occurs when the value of the checkedItems property changes.

gotFocus

gotFocus: Event<Control, EventArgs>

Occurs when the control gets the focus.

invalidInput

invalidInput: Event<Control, CancelEventArgs>

Occurs when invalid input is detected.

Invalid input may occur when the user types or pastes a value that cannot be converted to the proper type, or a value that is outside the valid range.

If the event handler cancels the event, the control will retain the invalid content and the focus, so users can correct the error.

If the event is not canceled, the control will ignore the invalid input and will retain the original content.

lostFocus

lostFocus: Event<Control, EventArgs>

Occurs when the control loses the focus.

refreshed

refreshed: Event<Control, EventArgs>

Occurs after the control has refreshed its contents.

refreshing

refreshing: Event<Control, EventArgs>

Occurs when the control is about to refresh its contents.

selectedIndexChanged

selectedIndexChanged: Event<MultiSelectListBox<any>, EventArgs>

Occurs when the value of the selectedIndex property changes.