constructor(element: any, options?): ListBox
Initializes a new instance of the ListBox class.
The DOM element that hosts the control, or a selector for the host element (e.g. '#theCtrl').
The JavaScript object containing initialization data for the control.
Gets or sets an array containing the items that are currently checked.
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.
Gets or sets the name of the property used to control the CheckBoxes placed next to each item.
Use this property to create multi-select LisBoxes. When an item is checked or unchecked, the control raises the itemChecked event. Use the selectedItem property to retrieve the item that was checked or unchecked, or use the checkedItems property to retrieve the list of items that are currently checked.
Gets the ICollectionView object used as the item source.
Gets or sets the name of the property to use as the visual representation of the items.
Angular (EventEmitter) version of the Wijmo formatItem 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 formatItem Wijmo event name.
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.
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.
Gets or sets a value indicating whether items contain plain text or HTML.
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
Indicates whether the component has been initialized by Angular. Changes its value from false to true right before triggering the initialized event.
Gets a value that indicates whether the control is currently handling a touch event.
Gets a value that indicates whether the control is currently being updated.
Angular (EventEmitter) version of the Wijmo itemChecked 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 itemChecked Wijmo event name.
Gets or sets a function used to customize the values shown on the list. The function takes two arguments, the item index and the default text or html, and returns the new text or html to display.
If the formatting function needs a scope (i.e. a meaningful 'this' value), then remember to set the filter using the 'bind' function to specify the 'this' object. For example:
listBox.itemFormatter = customItemFormatter.bind(this);
function customItemFormatter(index, content) {
if (this.makeItemBold(index)) {
content = '<b>' + content + '</b>';
}
return content;
}Angular (EventEmitter) version of the Wijmo itemsChanged 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 itemsChanged Wijmo event name.
Gets or sets the array or ICollectionView object that contains the list items.
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.
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
Gets or sets the index of the currently selected item.
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.
Gets or sets the value of the selectedItem obtained using the selectedValuePath.
Gets or sets the name of the property used to get the selectedValue from the selectedItem.
Defines a name of a property represented by [(ngModel)] directive (if specified). Default value is 'selectedValue'.
addEventListener(target: EventTarget, type: string, fn: any, capture?: 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 method).
Failing to remove event listeners may cause memory leaks.
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener is capturing.
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. 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', template, {
_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.
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.
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(): void
Resumes notifications suspended by calls to beginUpdate.
getControl(element: any): Control
Gets the control that is hosted in a given DOM element.
The DOM element that is hosting the control, or a selector for the host element (e.g. '#theCtrl').
getDisplayText(index: number): string
Gets the text displayed for the item at a given index (as plain text).
The index of the item.
getDisplayValue(index: number): string
Gets the string displayed for the item at a given index.
The string may be plain text or HTML, depending on the setting of the isContentHtml property.
The index of the item.
getItemChecked(index: number): boolean
Gets the checked state of an item on the list.
This method is applicable only on multi-select ListBoxes (see the checkedMemberPath property).
Item index.
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, it will override the template defined by the DropDown base class.
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?: EventArgs): void
Raises the checkedItemsChanged event.
onFormatItem(e: FormatItemEventArgs): void
Raises the formatItem event.
FormatItemEventArgs that contains the event data.
onGotFocus(e?: EventArgs): void
Raises the gotFocus event.
onItemChecked(e?: EventArgs): void
Raises the itemChecked event.
onItemsChanged(e?: EventArgs): void
Raises the itemsChanged event.
onLoadedItems(e?: EventArgs): void
Raises the loadedItems event.
onLoadingItems(e?: EventArgs): void
Raises the loadingItems event.
onLostFocus(e?: EventArgs): void
Raises the lostFocus event.
onSelectedIndexChanged(e?: EventArgs): void
Raises the selectedIndexChanged event.
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.
setItemChecked(index: number, checked: boolean): void
Sets the checked state of an item on the list.
This method is applicable only on multi-select ListBoxes (see the checkedMemberPath property).
showSelection(): void
Highlights the selected item and scrolls it into view.
toggleItemChecked(index: number): void
Toggles the checked state of an item on the list. This method is applicable only to multi-select ListBoxes (see the checkedMemberPath property).
Item index.
Occurs when the value of the checkedItems property changes.
Occurs when an element representing a list item has been created.
This event can be used to format list items for display. It is similar in purpose to the itemFormatter property, but has the advantage of allowing multiple independent handlers.
Occurs when the current item is checked or unchecked by the user.
This event is raised when the checkedMemberPath is set to the name of a property to add CheckBoxes to each item in the control.
Use the selectedItem property to retrieve the item that was checked or unchecked.
Occurs after the list items have been generated.
Occurs when the value of the selectedIndex property changes.
Angular 2 component for the ListBox control.
Use the wj-list-box component to add ListBox controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.
The WjListBox component is derived from the ListBox control and inherits all its properties, events and methods.
The wj-list-box component may contain a WjItemTemplate child directive.