constructor(element: any, options?: any): MultiSelectListBox
Initializes a new instance of the MultiSelectListBox class.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
The JavaScript object containing initialization data for the control.
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**.
Gets or sets the name of the property used to control the checkboxes placed next to each item.
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).
Gets or sets the template used to instantiate MultiSelectListBox controls.
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.
Gets or sets the name of the property to use as the visual representation of the items.
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".
Gets the DOM element that is hosting the control.
Gets or sets a value indicating whether items contain plain text or HTML.
The default value for this property is **false**.
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
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".
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**.
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 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**.
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**.
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.
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.virtializationThreshold property.
addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
Adds an event listener to an element owned by this Control.
The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).
Failing to remove event listeners may cause memory leaks.
The passive parameter is set to false by default, which means the event handler may call event.preventDefault(). If you are adding passive handlers to touch or wheel events, setting this parameter to true will improve application performance.
For details on passive event listeners, please see Improving scrolling performance with passive listeners.
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener should be handled by the control before it is handled by the target element.
Indicates that the handler will never call preventDefault().
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');
```
Names of classes to add to the control's host element.
An HTML string that defines the control template.
A dictionary of part variables and their names.
Name of the part to be named after the host element. This determines how the control submits data when used in forms.
beginUpdate(): void
Suspends notifications until the next call to endUpdate.
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.
Function to be executed.
dispose(): void
Disposes of the control by removing its association with the host element.
The dispose method automatically removes any event listeners added with the addEventListener method.
Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.
disposeAll(e?: HTMLElement): void
Disposes of all Wijmo controls contained in an HTML element.
Container element.
endUpdate(shouldInvalidate?: boolean): void
Resumes notifications suspended by calls to beginUpdate.
should invalidate the control. Default value for this parameter is true.
getControl(element: any): Control
Gets the control that is hosted in a given DOM element.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
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).
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.
Object that contains the initialization data.
invalidate(fullUpdate?: boolean): void
Invalidates the control causing an asynchronous refresh.
Whether to update the control layout as well as the content.
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 invalidateAll method so the contained Wijmo controls will update their layout information properly.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
onCheckedItemsChanged(e?: any): void
Raises the checkedItemsChanged event.
onGotFocus(e?: EventArgs): void
Raises the gotFocus event.
onInvalidInput(e: CancelEventArgs): void
Raises the invalidInput event.
If the event handler cancels the event, the control will keep the invalid input and the focus.
onLostFocus(e?: EventArgs): void
Raises the lostFocus event.
onRefreshed(e?: EventArgs): void
Raises the refreshed event.
onRefreshing(e?: EventArgs): void
Raises the refreshing event.
onSelectedIndexChanged(e?: EventArgs): void
Raises the selectedIndexChanged event.
refresh(fullUpdate?: boolean): void
Refreshes the control.
Whether to update the control layout as well as the content.
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.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
Removes one or more event listeners attached to elements owned by this Control.
Target element for the event. If null, removes listeners attached to all targets.
String that specifies the event. If null, removes listeners attached to all events.
Handler to remove. If null, removes all handlers.
Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
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.
Occurs when the value of the selectedIndex property changes.
The MultiSelectListBox control contains a ListBox with a "Select All" button and a "Filter" input.
The "Select All" and "Filter" elements can be shown or hidden using the showSelectAllCheckbox and showFilterInput properties.
The MultiSelectListBox control is used as a drop-down by the MultiSelect control.