@grapecity/wijmo.input 5.20261.48 → 5.20261.52

package/index.d.ts

@@ -1,6 +1,6 @@
 /*!
     *
-    * Wijmo Library 5.20261.48
+    * Wijmo Library 5.20261.52
     * https://developer.mescius.com/wijmo
     *
     * Copyright(c) MESCIUS inc. All rights reserved.
@@ -158,6 +158,7 @@ export declare class InputNumber extends Control {
     _min: number;
     _max: number;
     _format: string;
+    _truncate: boolean;
     _step: number;
     _showBtn: boolean;
     _readOnly: boolean;
@@ -178,7 +179,6 @@ export declare class InputNumber extends Control {
     _delKey: boolean;
     _rptUp: _ClickRepeater;
     _rptDn: _ClickRepeater;
-    _fromKb: boolean;
     static _ctrlTemplate: string;
     _inputElementAriaLabel: string;
     _ariaLabelledby: string;
@@ -271,6 +271,16 @@ export declare class InputNumber extends Control {
      * standard numeric format string</a>.
      */
     format: string;
+    /**
+     * Gets or sets whether the control truncates numeric values that exceed
+     * the decimal precision defined by {@link format}, instead of applying rounding.
+     *
+     * For example, if {@link format} = 'n2' and the value is 99.999,
+     * setting {@link truncate} to true will store 99.99 rather than rounding to 100.
+     *
+     * Default is **false**, which preserves the standard rounding behavior.
+     */
+    truncate: boolean;
     /**
      * Gets or sets the text shown in the control.
      */
@@ -1246,204 +1256,6 @@ export declare class FormatItemEventArgs extends EventArgs {
      */
     readonly item: HTMLElement;
 }
-/**
- * The {@link MultiSelectListBox} control contains a {@link ListBox} with
- * a "Select All" button and a "Filter" input.
- *
- * The "Select All" and "Filter" elements can be shown or hidden using
- * the {@link showSelectAllCheckbox} and {@link showFilterInput} properties.
- *
- * The {@link MultiSelectListBox} control is used as a drop-down by the
- * {@link MultiSelect} control.
- */
-export declare class MultiSelectListBox<T = any> extends Control {
-    _selectAll: HTMLElement;
-    _filter: HTMLInputElement;
-    _lbHost: HTMLElement;
-    _lbx: ListBox;
-    _cbSelectAll: HTMLInputElement;
-    _spSelectAll: HTMLSpanElement;
-    _ariaLabel: string;
-    _selectAllLabel: string;
-    _filterPlaceholder: string;
-    _filterText: string;
-    _checkOnFilter: boolean;
-    _delay: number;
-    _toSearch: any;
-    static _DEF_CHECKED_PATH: string;
-    static _ctrlTemplate: string;
-    /**
-     * Gets or sets the template used to instantiate {@link MultiSelectListBox} controls.
-     */
-    static controlTemplate: string;
-    /**
-     * Initializes a new instance of the {@link MultiSelectListBox} class.
-     *
-     * @param element The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
-     * @param options The JavaScript object containing initialization data for the control.
-     */
-    constructor(element: any, options?: any);
-    /**
-     * Gets or sets the array or {@link ICollectionView} object that contains
-     * the list items.
-     */
-    itemsSource: any;
-    /**
-     * Gets the {@link ICollectionView} object used as the item source.
-     */
-    readonly collectionView: ICollectionView<T>;
-    /**
-     * Gets or sets the minimum number of rows and/or columns required to enable
-     * virtualization in the drop-down {@link 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 {@link ListBox.virtualizationThreshold}
-     * property.
-     */
-    virtualizationThreshold: number;
-    /**
-     * Gets or sets the name of the property to use as the visual
-     * representation of the items.
-     */
-    displayMemberPath: string;
-    /**
-     * Gets or sets a value indicating whether items contain plain
-     * text or HTML.
-     *
-     * The default value for this property is **false**.
-     */
-    isContentHtml: 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**.
-     */
-    caseSensitiveSearch: boolean;
-    /**
-     * 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 {@link showFilterInput}
-     * property is set to **true**.
-     *
-     * The default value for this property is **500** milliseconds.
-     */
-    delay: number;
-    /**
-     * Gets or sets a value that determines whether the {@link MultiSelectListBox} should
-     * include group header items to delimit data groups.
-     *
-     * Data groups are created by modifying the {@link ICollectionView.groupDescriptions}
-     * property of the {@link ICollectionView} object used as an {@link itemsSource}.
-     *
-     * The {@link MultiSelectListBox} only shows the first level of grouping.
-     *
-     * The default value for this property is **false**.
-     */
-    showGroups: boolean;
-    /**
-     * Gets or sets a value that determines whether the {@link 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).
-     */
-    checkOnFilter: boolean;
-    /**
-     * Gets or sets the index of the currently selected item.
-     */
-    selectedIndex: number;
-    /**
-     * Gets a reference to the {@link ListBox} control hosted by this
-     * {@link MultiSelectListBox}.
-     */
-    readonly listBox: ListBox;
-    /**
-     * 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**.
-     */
-    showFilterInput: boolean;
-    /**
-     * 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".
-     */
-    filterInputPlaceholder: string;
-    /**
-     * 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**.
-     */
-    showSelectAllCheckbox: boolean;
-    /**
-     * Gets or sets the string to be used as a label for the "Select All"
-     * checkbox that is displayed when the {@link 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".
-     */
-    selectAllLabel: string;
-    /**
-     * Gets or sets the name of the property used to control the checkboxes
-     * placed next to each item.
-     */
-    checkedMemberPath: string;
-    /**
-     * Gets or sets an array containing the items that are currently checked.
-     */
-    checkedItems: any[];
-    /**
-     * Gets or sets the aria-labelledby attribute of {@link MultiSelectListBox} input element.
-     */
-    ariaLabelledBy: string;
-    _updateAriaLabel(): void;
-    /**
-     * Occurs when the value of the {@link checkedItems} property changes.
-     */
-    readonly checkedItemsChanged: Event<MultiSelectListBox<any>, EventArgs>;
-    /**
-     * Raises the {@link checkedItemsChanged} event.
-     */
-    onCheckedItemsChanged(e?: any): void;
-    /**
-     * Occurs when the value of the {@link selectedIndex} property changes.
-     */
-    readonly selectedIndexChanged: Event<MultiSelectListBox<any>, EventArgs>;
-    /**
-     * Raises the {@link selectedIndexChanged} event.
-     */
-    onSelectedIndexChanged(e?: EventArgs): void;
-    refresh(fullUpdate?: boolean): void;
-    dispose(): void;
-    _applyFilter(): void;
-    _updateCheckAllCheckbox(): void;
-    _setIsDisabled(value: boolean): void;
-    _setTabOrder(value: number): void;
-    tryForceClearDelayAndFilter(): void;
-    onLostFocus(): void;
-}
 export interface _IDateRange {
     from: Date | null;
     to: Date | null;
@@ -3896,12 +3708,14 @@ export declare class ComboBox<T = any> extends DropDown {
     _findNextWhenIsEditableFalse(search: string, step: number, start?: number): number;
     protected _keydown(e: KeyboardEvent): void;
     _afterOpenDropdownByDownArrow(): void;
-    _input(_e: Event): void;
+    _input(e: Event): void;
     _handleDragTextState(): void;
     _shouldOpenDropdown(): boolean;
     _handleIsEditableFalseInput(): void;
     _updateSelection(index: number, editStart: number): void;
-    _updateComponentText(): void;
+    _updateComponentText(e?: Event): void;
+    private _getInputTextForUpdate;
+    private _shouldUseCurrentTextAfterComposition;
     _updateEmptyValueFlag(): void;
     _controlDropdownVisibility(): void;
     _resetDragState(): void;
@@ -3913,235 +3727,50 @@ export declare class ComboBox<T = any> extends DropDown {
     _updateDropDownWhenInput(): void;
 }
 /**
- * Represents a method that returns a string used as a header for a
- * {@link MultiSelect} control.
+ * Interface implemented by command objects.
+ *
+ * For details, please see the {@link Menu.command} property.
  */
-export interface IHeaderFormatter {
+export interface ICommand {
     /**
-     * @param sender {@link MultiSelect} whose header is being formatted.
-     * @returns The text to show in the control's header element.
+     * Executes the command with a given parameter.
+     *
+     * The parameter passed to the command is defined by the value of the
+     * {@link Menu.commandParameterPath} property of the current item.
+     * If the {@link Menu.commandParameterPath} property is not specified,
+     * the parameter passed is the item itself.
      */
-    (sender: MultiSelect): string;
+    executeCommand(parameter: any): void;
+    /**
+     * Returns true if the command can be executed in the current app state.
+     *
+     * If this method returns false, the corresponding menu option is
+     * disabled.
+     */
+    canExecuteCommand?(parameter: any): boolean;
 }
 /**
- * The {@link MultiSelect} control allows users to select multiple items from
- * drop-down lists that contain custom objects or simple strings.
+ * The {@link Menu} control shows a text element with a drop-down list of commands that
+ * the user can invoke by click or touch.
  *
- * The {@link MultiSelect} control extends {@link ComboBox}, with all the usual
- * properties, including {@link MultiSelect.itemsSource} and
- * {@link MultiSelect.displayMemberPath}.
+ * The {@link Menu} control inherits from {@link ComboBox}, so you populate and style it
+ * in the same way that you do the {@link ComboBox} (see the {@link Menu.itemsSource}
+ * property).
  *
- * Like the {@link ListBox} control, it has a {@link MultiSelect.checkedMemberPath}
- * property that defines the name of the property that determines whether an
- * item is checked or not.
+ * The {@link Menu} control adds an {@link Menu.itemClicked} event that fires when the user
+ * selects an item from the menu. The event handler can inspect the {@link Menu} control
+ * to determine which item was clicked. For example:
  *
- * The items currently checked (selected) can be obtained using the
- * {@link MultiSelect.checkedItems} property.
- *
- * The control header is fully customizable. By default, it shows up to two items
- * selected and the item count after that. You can change the maximum number of
- * items to display ({@link MultiSelect.maxHeaderItems}), the message shown when no
- * items are selected ({@link MultiSelect.placeholder}), and the format string used to
- * show the item count ({@link MultiSelect.headerFormat}).
- *
- * Alternatively, you can provide a function to generate the header content based
- * on whatever criteria your application requires ({@link MultiSelect.headerFormatter}).
- *
- * The example below shows how you can use a {@link MultiSelect} control to select
- * multiple items from a drop-down list:
- *
- * {@sample Input/MultiSelect/Overview Example}
- */
-export declare class MultiSelect extends ComboBox {
-    private _maxHdrItems;
-    private _readOnly;
-    private _hdrFmt;
-    private _hdrFormatter;
-    private _msLbx;
-    static _DEF_CHECKED_PATH: string;
-    static _ctrlTemplate: string;
-    _inputElementAriaLabel: string;
-    /**
-     * Gets or sets the template used to instantiate {@link MultiSelect} control.
-     */
-    static controlTemplate: string;
-    /**
-     * Initializes a new instance of the {@link MultiSelect} class.
-     *
-     * @param element The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
-     * @param options The JavaScript object containing initialization data for the control.
-     */
-    constructor(element: any, options?: any);
-    /**
-     * 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**.
-     */
-    showSelectAllCheckbox: 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**.
-     */
-    showFilterInput: boolean;
-    /**
-     * 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 {@link showFilterInput}
-     * property is set to **true**.
-     *
-     * The default value for this property is **500** milliseconds.
-     */
-    delay: number;
-    /**
-     * 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**.
-     */
-    caseSensitiveSearch: boolean;
-    /**
-     * Gets or sets the string used as a placeholder for the filter input
-     * element on the {@link MultiSelectListBox} drop-down.
-     *
-     * The default value for this property is **null**, which causes the
-     * control to use a localized version of the string "Filter".
-     */
-    filterInputPlaceholder: string | null;
-    /**
-     * Gets or sets a value that determines whether the {@link MultiSelectListBox}
-     * in the drop-down should automatically select all the filtered items when the
-     * filter text changes.
-     *
-     * The default value for this property is **true**.
-     */
-    checkOnFilter: boolean;
-    /**
-     * Gets or sets the string to be used as a label for the "Select All"
-     * checkbox that is displayed when the {@link showSelectAllCheckbox}
-     * property is set to true.
-     *
-     * The default value for this property is **null**, which causes the
-     * control to use a localized version of the string "Select All".
-     */
-    selectAllLabel: string | null;
-    /**
-     * Gets or sets the name of the property used to control the checkboxes
-     * placed next to each item.
-     */
-    checkedMemberPath: string;
-    /**
-     * Gets or sets the maximum number of items to display on the control header.
-     *
-     * If no items are selected, the header displays the text specified by the
-     * {@link placeholder} property.
-     *
-     * If the number of selected items is smaller than or equal to the value of the
-     * {@link maxHeaderItems} property, the selected items are shown in the header.
-     *
-     * If the number of selected items is greater than {@link maxHeaderItems}, the
-     * header displays the selected item count instead.
-     *
-     * The default value for this property is **2**.
-     */
-    maxHeaderItems: number;
-    /**
-     * Gets or sets the format string used to create the header content
-     * when the control has more than {@link maxHeaderItems} items checked.
-     *
-     * The format string may contain the '{count}' replacement string
-     * which gets replaced with the number of items currently checked.
-     *
-     * The default value for this property is **null**, which causes the
-     * control to use a localized version of the string "{count:n0} items selected".
-     */
-    headerFormat: string | null;
-    /**
-     * Gets or sets a function that gets the text displayed in the control
-     * header.
-     *
-     * By default, the control header content is determined based on the
-     * {@link placeholder}, {@link maxHeaderItems}, and on the current selection.
-     *
-     * You may customize the header content by specifying a function that
-     * returns a custom string based on whatever criteria your application
-     * requires.
-     */
-    headerFormatter: IHeaderFormatter | null;
-    /**
-     * Gets or sets an array containing the items that are currently checked.
-     */
-    checkedItems: any[];
-    /**
-     * Occurs when the value of the {@link checkedItems} property changes.
-     */
-    readonly checkedItemsChanged: Event<MultiSelect, EventArgs>;
-    /**
-     * Raises the {@link checkedItemsChanged} event.
-     */
-    onCheckedItemsChanged(e?: EventArgs): void;
-    dispose(): void;
-    onIsDroppedDownChanged(e?: EventArgs): void;
-    onLostFocus(): void;
-    protected _createDropDown(): void;
-    _updateBtnAria(): void;
-    _updateTbxAria(): void;
-    isReadOnly: boolean;
-    refresh(fullUpdate?: boolean): void;
-    protected _setText(_text: string, _fullMatch: boolean): void;
-    protected _keydown(e: KeyboardEvent): void;
-    protected _hasItems(): boolean;
-    private _updateHeader;
-    getAriaLabelForScreenReader(): any;
-}
-/**
- * Interface implemented by command objects.
- *
- * For details, please see the {@link Menu.command} property.
- */
-export interface ICommand {
-    /**
-     * Executes the command with a given parameter.
-     *
-     * The parameter passed to the command is defined by the value of the
-     * {@link Menu.commandParameterPath} property of the current item.
-     * If the {@link Menu.commandParameterPath} property is not specified,
-     * the parameter passed is the item itself.
-     */
-    executeCommand(parameter: any): void;
-    /**
-     * Returns true if the command can be executed in the current app state.
-     *
-     * If this method returns false, the corresponding menu option is
-     * disabled.
-     */
-    canExecuteCommand?(parameter: any): boolean;
-}
-/**
- * The {@link Menu} control shows a text element with a drop-down list of commands that
- * the user can invoke by click or touch.
- *
- * The {@link Menu} control inherits from {@link ComboBox}, so you populate and style it
- * in the same way that you do the {@link ComboBox} (see the {@link Menu.itemsSource}
- * property).
- *
- * The {@link Menu} control adds an {@link Menu.itemClicked} event that fires when the user
- * selects an item from the menu. The event handler can inspect the {@link Menu} control
- * to determine which item was clicked. For example:
- *
- * ```typescript
- * import { Menu } from '@grapecity/wijmo.input';
- * let menu = new Menu('#theMenu', {
- *     header: 'Main Menu',
- *     itemsSource: ['option 1', 'option 2', 'option 3'],
- *     itemClicked: s => {
- *         alert('Thanks for selecting item ' + s.selectedIndex + ' from menu ' + s.header + '!');
- *     }
- * });
- * ```
+ * ```typescript
+ * import { Menu } from '@grapecity/wijmo.input';
+ * let menu = new Menu('#theMenu', {
+ *     header: 'Main Menu',
+ *     itemsSource: ['option 1', 'option 2', 'option 3'],
+ *     itemClicked: s => {
+ *         alert('Thanks for selecting item ' + s.selectedIndex + ' from menu ' + s.header + '!');
+ *     }
+ * });
+ * ```
  *
  * The example below shows how you can create menus that handle the
  * {@link itemClicked} event.
@@ -4722,6 +4351,26 @@ export interface IGetItemsCallback {
      * */
     (items: any[]): void;
 }
+/**
+ * Represents a custom filter function used by {@link AutoComplete} and {@link MultiSelectListBox}.
+ *
+ * @param item The data item to test.
+ * @param query The current search query string.
+ * @param text The display text (after displayMemberPath processing).
+ * @returns **true** to include the item in the filtered results, **false** to exclude it.
+ */
+export declare type CustomFilterCallback = (item: any, query: string, text: string) => boolean;
+/**
+ * Represents a custom highlight function used by {@link AutoComplete}.
+ *
+ * @param item The data item being displayed.
+ * @param query The current search query string.
+ * @param text The display text (after displayMemberPath processing).
+ * @returns An HTML string with highlighted portions wrapped in highlight spans.
+ *
+ * **Security Note**: Escape user input with {@link escapeHtml} to prevent XSS attacks.
+ */
+export declare type CustomHighlightCallback = (item: any, query: string, text: string) => string;
 /**
  * The {@link AutoComplete} control is an input control that allows callers
  * to customize the item list as the user types.
@@ -4746,6 +4395,9 @@ export declare class AutoComplete extends ComboBox {
     private _itemCount;
     private _beginsWith;
     private _delay;
+    private _searchDuringComposition;
+    private _customFilter;
+    private _customHighlight;
     _selItems: any;
     private _toSearch;
     private _query;
@@ -4796,6 +4448,18 @@ export declare class AutoComplete extends ComboBox {
      * The default value for this property is **500** milliseconds.
      */
     delay: number;
+    /**
+     * Gets or sets whether AutoComplete should search while IME composition is active.
+     *
+     * The default value for this property is **false**.
+     *
+     * When set to **false**, search timing stays unchanged and filtering starts
+     * only after the composition is committed.
+     *
+     * When set to **true**, the control may filter immediately from the current
+     * composing text while composition is still active.
+     */
+    searchDuringComposition: boolean;
     /**
      * Gets or sets a string containing a comma-separated list of properties to use
      * when searching for items.
@@ -4858,6 +4522,43 @@ export declare class AutoComplete extends ComboBox {
      * The default value for this property is **wj-state-match**.
      */
     cssMatch: string;
+    /**
+     * Gets or sets a custom filter function for filtering items.
+     *
+     * When set, this function is used instead of the default filtering logic.
+     * The function receives the item, the current query string, and the display text,
+     * and should return true to include the item or false to exclude it.
+     *
+     * Set to null to restore default filtering behavior.
+     *
+     * @remarks
+     * When customFilter is set, these properties are ignored:
+     * - {@link caseSensitiveSearch}, {@link beginsWithSearch}, {@link isContentHtml}
+     *
+     * These properties are still honored:
+     * - {@link maxItems}, {@link minLength}
+     */
+    customFilter: CustomFilterCallback;
+    /**
+     * Gets or sets a custom highlight function for highlighting matched text.
+     *
+     * When set, this function is called for each filtered item to generate
+     * the HTML to display in the drop-down list. The function receives the
+     * item, query, and display text, and should return HTML with highlighted
+     * portions wrapped in &lt;span class="wj-state-match"&gt;.
+     *
+     * Set to null to restore default highlighting behavior.
+     *
+     * @remarks
+     * **Security**: Always use {@link escapeHtml} on user content to prevent XSS.
+     *
+     * The highlight function is called before formatItem event handlers,
+     * allowing handlers to override the result.
+     *
+     * If the function throws an exception, the error is logged and the
+     * original text is displayed without highlighting.
+     */
+    customHighlight: CustomHighlightCallback;
     /**
      * Raises the {@link selectedIndexChanged} event.
      */
@@ -4865,6 +4566,13 @@ export declare class AutoComplete extends ComboBox {
     _updateTbxAria(): void;
     _keydown(e: KeyboardEvent): void;
     _input(_e: Event): void;
+    /**
+     * Sets the focus to the control and selects all its content.
+     */
+    selectAll(): void;
+    private _canSearchWhileComposing;
+    private _hasExternalCompositionFocus;
+    private _isLegacyImeGuardBrowser;
     private _isBlurInput;
     protected _commitText(noFocus?: boolean): void;
     _setText(text: string | null): void;
@@ -4978,4 +4686,416 @@ export declare class MultiAutoComplete extends AutoComplete {
     _setTabOrder(value: number): void;
     _updateTabIndex(): void;
 }
+/**
+ * The {@link MultiSelectListBox} control contains a {@link ListBox} with
+ * a "Select All" button and a "Filter" input.
+ *
+ * The "Select All" and "Filter" elements can be shown or hidden using
+ * the {@link showSelectAllCheckbox} and {@link showFilterInput} properties.
+ *
+ * The {@link MultiSelectListBox} control is used as a drop-down by the
+ * {@link MultiSelect} control.
+ */
+export declare class MultiSelectListBox<T = any> extends Control {
+    _selectAll: HTMLElement;
+    _filter: HTMLInputElement;
+    _lbHost: HTMLElement;
+    _lbx: ListBox;
+    _cbSelectAll: HTMLInputElement;
+    _spSelectAll: HTMLSpanElement;
+    _ariaLabel: string;
+    _selectAllLabel: string;
+    _filterPlaceholder: string;
+    _filterText: string;
+    _checkOnFilter: boolean;
+    _delay: number;
+    _toSearch: any;
+    _customFilter: CustomFilterCallback;
+    static _DEF_CHECKED_PATH: string;
+    static _ctrlTemplate: string;
+    /**
+     * Gets or sets the template used to instantiate {@link MultiSelectListBox} controls.
+     */
+    static controlTemplate: string;
+    /**
+     * Initializes a new instance of the {@link MultiSelectListBox} class.
+     *
+     * @param element The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
+     * @param options The JavaScript object containing initialization data for the control.
+     */
+    constructor(element: any, options?: any);
+    /**
+     * Gets or sets the array or {@link ICollectionView} object that contains
+     * the list items.
+     */
+    itemsSource: any;
+    /**
+     * Gets the {@link ICollectionView} object used as the item source.
+     */
+    readonly collectionView: ICollectionView<T>;
+    /**
+     * Gets or sets the minimum number of rows and/or columns required to enable
+     * virtualization in the drop-down {@link 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 {@link ListBox.virtualizationThreshold}
+     * property.
+     */
+    virtualizationThreshold: number;
+    /**
+     * Gets or sets the name of the property to use as the visual
+     * representation of the items.
+     */
+    displayMemberPath: string;
+    /**
+     * Gets or sets a value indicating whether items contain plain
+     * text or HTML.
+     *
+     * The default value for this property is **false**.
+     */
+    isContentHtml: 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**.
+     */
+    caseSensitiveSearch: boolean;
+    /**
+     * 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 {@link showFilterInput}
+     * property is set to **true**.
+     *
+     * The default value for this property is **500** milliseconds.
+     */
+    delay: number;
+    /**
+     * Gets or sets a custom filter function for filtering items.
+     *
+     * When set, this function is used instead of the default regex-based filtering.
+     *
+     * @param item The data item to test.
+     * @param query The current filter text.
+     * @param text The display text (after displayMemberPath processing).
+     * @returns **true** to include the item, **false** to exclude it.
+     *
+     * Setting to null restores default filtering. Requires {@link showFilterInput} to be true.
+     */
+    customFilter: CustomFilterCallback;
+    /**
+     * Gets or sets a value that determines whether the {@link MultiSelectListBox} should
+     * include group header items to delimit data groups.
+     *
+     * Data groups are created by modifying the {@link ICollectionView.groupDescriptions}
+     * property of the {@link ICollectionView} object used as an {@link itemsSource}.
+     *
+     * The {@link MultiSelectListBox} only shows the first level of grouping.
+     *
+     * The default value for this property is **false**.
+     */
+    showGroups: boolean;
+    /**
+     * Gets or sets a value that determines whether the {@link 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).
+     */
+    checkOnFilter: boolean;
+    /**
+     * Gets or sets the index of the currently selected item.
+     */
+    selectedIndex: number;
+    /**
+     * Gets a reference to the {@link ListBox} control hosted by this
+     * {@link MultiSelectListBox}.
+     */
+    readonly listBox: ListBox;
+    /**
+     * 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**.
+     */
+    showFilterInput: boolean;
+    /**
+     * 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".
+     */
+    filterInputPlaceholder: string;
+    /**
+     * 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**.
+     */
+    showSelectAllCheckbox: boolean;
+    /**
+     * Gets or sets the string to be used as a label for the "Select All"
+     * checkbox that is displayed when the {@link 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".
+     */
+    selectAllLabel: string;
+    /**
+     * Gets or sets the name of the property used to control the checkboxes
+     * placed next to each item.
+     */
+    checkedMemberPath: string;
+    /**
+     * Gets or sets an array containing the items that are currently checked.
+     */
+    checkedItems: any[];
+    /**
+     * Gets or sets the aria-labelledby attribute of {@link MultiSelectListBox} input element.
+     */
+    ariaLabelledBy: string;
+    _updateAriaLabel(): void;
+    /**
+     * Occurs when the value of the {@link checkedItems} property changes.
+     */
+    readonly checkedItemsChanged: Event<MultiSelectListBox<any>, EventArgs>;
+    /**
+     * Raises the {@link checkedItemsChanged} event.
+     */
+    onCheckedItemsChanged(e?: any): void;
+    /**
+     * Occurs when the value of the {@link selectedIndex} property changes.
+     */
+    readonly selectedIndexChanged: Event<MultiSelectListBox<any>, EventArgs>;
+    /**
+     * Raises the {@link selectedIndexChanged} event.
+     */
+    onSelectedIndexChanged(e?: EventArgs): void;
+    refresh(fullUpdate?: boolean): void;
+    dispose(): void;
+    _applyFilter(): void;
+    protected _getItemText(item: any, binding?: Binding): string;
+    _updateCheckAllCheckbox(): void;
+    _setIsDisabled(value: boolean): void;
+    _setTabOrder(value: number): void;
+    tryForceClearDelayAndFilter(): void;
+    onLostFocus(): void;
+}
+/**
+ * Represents a method that returns a string used as a header for a
+ * {@link MultiSelect} control.
+ */
+export interface IHeaderFormatter {
+    /**
+     * @param sender {@link MultiSelect} whose header is being formatted.
+     * @returns The text to show in the control's header element.
+     */
+    (sender: MultiSelect): string;
+}
+/**
+ * The {@link MultiSelect} control allows users to select multiple items from
+ * drop-down lists that contain custom objects or simple strings.
+ *
+ * The {@link MultiSelect} control extends {@link ComboBox}, with all the usual
+ * properties, including {@link MultiSelect.itemsSource} and
+ * {@link MultiSelect.displayMemberPath}.
+ *
+ * Like the {@link ListBox} control, it has a {@link MultiSelect.checkedMemberPath}
+ * property that defines the name of the property that determines whether an
+ * item is checked or not.
+ *
+ * The items currently checked (selected) can be obtained using the
+ * {@link MultiSelect.checkedItems} property.
+ *
+ * The control header is fully customizable. By default, it shows up to two items
+ * selected and the item count after that. You can change the maximum number of
+ * items to display ({@link MultiSelect.maxHeaderItems}), the message shown when no
+ * items are selected ({@link MultiSelect.placeholder}), and the format string used to
+ * show the item count ({@link MultiSelect.headerFormat}).
+ *
+ * Alternatively, you can provide a function to generate the header content based
+ * on whatever criteria your application requires ({@link MultiSelect.headerFormatter}).
+ *
+ * The example below shows how you can use a {@link MultiSelect} control to select
+ * multiple items from a drop-down list:
+ *
+ * {@sample Input/MultiSelect/Overview Example}
+ */
+export declare class MultiSelect extends ComboBox {
+    private _maxHdrItems;
+    private _readOnly;
+    private _hdrFmt;
+    private _hdrFormatter;
+    private _msLbx;
+    static _DEF_CHECKED_PATH: string;
+    static _ctrlTemplate: string;
+    _inputElementAriaLabel: string;
+    /**
+     * Gets or sets the template used to instantiate {@link MultiSelect} control.
+     */
+    static controlTemplate: string;
+    /**
+     * Initializes a new instance of the {@link MultiSelect} class.
+     *
+     * @param element The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
+     * @param options The JavaScript object containing initialization data for the control.
+     */
+    constructor(element: any, options?: any);
+    /**
+     * 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**.
+     */
+    showSelectAllCheckbox: 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**.
+     */
+    showFilterInput: boolean;
+    /**
+     * 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 {@link showFilterInput}
+     * property is set to **true**.
+     *
+     * The default value for this property is **500** milliseconds.
+     */
+    delay: number;
+    /**
+     * 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**.
+     */
+    caseSensitiveSearch: boolean;
+    /**
+     * Gets or sets the string used as a placeholder for the filter input
+     * element on the {@link MultiSelectListBox} drop-down.
+     *
+     * The default value for this property is **null**, which causes the
+     * control to use a localized version of the string "Filter".
+     */
+    filterInputPlaceholder: string | null;
+    /**
+     * Gets or sets a value that determines whether the {@link MultiSelectListBox}
+     * in the drop-down should automatically select all the filtered items when the
+     * filter text changes.
+     *
+     * The default value for this property is **true**.
+     */
+    checkOnFilter: boolean;
+    /**
+     * Gets or sets a custom filter function for filtering items.
+     *
+     * When set, this function is used instead of the default regex-based filtering
+     * in the filter input. Requires {@link showFilterInput} to be true.
+     *
+     * @param item The data item to test.
+     * @param query The current filter text.
+     * @param text The display text (after displayMemberPath processing).
+     * @returns **true** to include the item, **false** to exclude it.
+     *
+     * Setting to null restores default filtering.
+     */
+    customFilter: CustomFilterCallback;
+    /**
+     * Gets or sets the string to be used as a label for the "Select All"
+     * checkbox that is displayed when the {@link showSelectAllCheckbox}
+     * property is set to true.
+     *
+     * The default value for this property is **null**, which causes the
+     * control to use a localized version of the string "Select All".
+     */
+    selectAllLabel: string | null;
+    /**
+     * Gets or sets the name of the property used to control the checkboxes
+     * placed next to each item.
+     */
+    checkedMemberPath: string;
+    /**
+     * Gets or sets the maximum number of items to display on the control header.
+     *
+     * If no items are selected, the header displays the text specified by the
+     * {@link placeholder} property.
+     *
+     * If the number of selected items is smaller than or equal to the value of the
+     * {@link maxHeaderItems} property, the selected items are shown in the header.
+     *
+     * If the number of selected items is greater than {@link maxHeaderItems}, the
+     * header displays the selected item count instead.
+     *
+     * The default value for this property is **2**.
+     */
+    maxHeaderItems: number;
+    /**
+     * Gets or sets the format string used to create the header content
+     * when the control has more than {@link maxHeaderItems} items checked.
+     *
+     * The format string may contain the '{count}' replacement string
+     * which gets replaced with the number of items currently checked.
+     *
+     * The default value for this property is **null**, which causes the
+     * control to use a localized version of the string "{count:n0} items selected".
+     */
+    headerFormat: string | null;
+    /**
+     * Gets or sets a function that gets the text displayed in the control
+     * header.
+     *
+     * By default, the control header content is determined based on the
+     * {@link placeholder}, {@link maxHeaderItems}, and on the current selection.
+     *
+     * You may customize the header content by specifying a function that
+     * returns a custom string based on whatever criteria your application
+     * requires.
+     */
+    headerFormatter: IHeaderFormatter | null;
+    /**
+     * Gets or sets an array containing the items that are currently checked.
+     */
+    checkedItems: any[];
+    /**
+     * Occurs when the value of the {@link checkedItems} property changes.
+     */
+    readonly checkedItemsChanged: Event<MultiSelect, EventArgs>;
+    /**
+     * Raises the {@link checkedItemsChanged} event.
+     */
+    onCheckedItemsChanged(e?: EventArgs): void;
+    dispose(): void;
+    onIsDroppedDownChanged(e?: EventArgs): void;
+    onLostFocus(): void;
+    protected _createDropDown(): void;
+    _updateBtnAria(): void;
+    _updateTbxAria(): void;
+    isReadOnly: boolean;
+    refresh(fullUpdate?: boolean): void;
+    protected _setText(_text: string, _fullMatch: boolean): void;
+    protected _keydown(e: KeyboardEvent): void;
+    protected _hasItems(): boolean;
+    private _updateHeader;
+    getAriaLabelForScreenReader(): any;
+}
 export {};