Class MultiSelect

Inheritance
System.Object
TagHelper
EJTagHelper
MultiSelect
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.DropDowns
Assembly: Syncfusion.EJ2.dll
Syntax
public class MultiSelect : EJTagHelper

Constructors

MultiSelect()

Declaration
public MultiSelect()

Properties

ActionBegin

Triggers before fetching data from the remote server.

Declaration
[HtmlAttributeName("actionBegin")]
public string ActionBegin { get; set; }
Property Value
Type Description
System.String

ActionComplete

Triggers after data is fetched successfully from the remote server.

Declaration
[HtmlAttributeName("actionComplete")]
public string ActionComplete { get; set; }
Property Value
Type Description
System.String

ActionFailure

Triggers when the data fetch request from the remote server fails.

Declaration
[HtmlAttributeName("actionFailure")]
public string ActionFailure { get; set; }
Property Value
Type Description
System.String

ActionFailureTemplate

Accepts the template and assigns it to the popup list content of the MultiSelect component when the data fetch request from the remote server fails.

Declaration
[HtmlAttributeName("actionFailureTemplate")]
public string ActionFailureTemplate { get; set; }
Property Value
Type Description
System.String

AddTagOnBlur

By default, the typed value is converting into chip or update as value of the component when you press the enter key or select from the popup. If you want to convert the typed value into chip or update as value of the component while focusing out the component, then enable this property. If custom value is enabled, both custom value and value present in the list are converted into tag while focusing out the component; Otherwise, value present in the list is converted into tag while focusing out the component.

Declaration
[HtmlAttributeName("addTagOnBlur")]
public bool AddTagOnBlur { get; set; }
Property Value
Type Description
System.Boolean

AllowCustomValue

Allows user to add a custom value, the value which is not present in the suggestion list.

Declaration
[HtmlAttributeName("allowCustomValue")]
public bool AllowCustomValue { get; set; }
Property Value
Type Description
System.Boolean

AllowFiltering

To enable the filtering option in this component. Filter action performs when type in search box and collect the matched item through filtering event. If searching character does not match, noRecordsTemplate property value will be shown.

Declaration
[HtmlAttributeName("allowFiltering")]
public bool AllowFiltering { get; set; }
Property Value
Type Description
System.Boolean

BeforeOpen

Fires when popup opens before animation.

Declaration
[HtmlAttributeName("beforeOpen")]
public string BeforeOpen { get; set; }
Property Value
Type Description
System.String

BeforeSelectAll

Fires before select all process.

Declaration
[HtmlAttributeName("beforeSelectAll")]
public string BeforeSelectAll { get; set; }
Property Value
Type Description
System.String

Blur

Event triggers when the input get focus-out.

Declaration
[HtmlAttributeName("blur")]
public string Blur { get; set; }
Property Value
Type Description
System.String

Change

Fires each time when selection changes happened in list items after model and input value get affected.

Declaration
[HtmlAttributeName("change")]
public string Change { get; set; }
Property Value
Type Description
System.String

ChangeOnBlur

By default, the multiselect component fires the change event while focus out the component. If you want to fires the change event on every value selection and remove, then disable the changeOnBlur property.

Declaration
[HtmlAttributeName("changeOnBlur")]
public bool ChangeOnBlur { get; set; }
Property Value
Type Description
System.Boolean

ChipSelection

Event triggers when the chip selection.

Declaration
[HtmlAttributeName("chipSelection")]
public string ChipSelection { get; set; }
Property Value
Type Description
System.String

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

Close

Fires when popup close after animation completion.

Declaration
[HtmlAttributeName("close")]
public string Close { get; set; }
Property Value
Type Description
System.String

ClosePopupOnSelect

Based on the property, when item get select popup visibility state will changed.

Declaration
[HtmlAttributeName("closePopupOnSelect")]
public bool ClosePopupOnSelect { get; set; }
Property Value
Type Description
System.Boolean

Created

Triggers when the component is created.

Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type Description
System.String

CssClass

Sets the CSS classes to root element of this component which helps to customize the complete styles.

Declaration
[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }
Property Value
Type Description
System.String

CustomValueSelection

Triggers when the customValue is selected.

Declaration
[HtmlAttributeName("customValueSelection")]
public string CustomValueSelection { get; set; }
Property Value
Type Description
System.String

DataBound

Triggers when data source is populated in the popup list..

Declaration
[HtmlAttributeName("dataBound")]
public string DataBound { get; set; }
Property Value
Type Description
System.String

DataSource

Accepts the list items either through local or remote service and binds it to the MultiSelect component. It can be an array of JSON Objects or an instance of DataManager.

Declaration
[HtmlAttributeName("dataSource")]
public object DataSource { get; set; }
Property Value
Type Description
System.Object

DelimiterChar

Sets the delimiter character for 'default' and 'delimiter' visibility modes.

Declaration
[HtmlAttributeName("delimiterChar")]
public string DelimiterChar { get; set; }
Property Value
Type Description
System.String

Destroyed

Triggers when the component is destroyed.

Declaration
[HtmlAttributeName("destroyed")]
public string Destroyed { get; set; }
Property Value
Type Description
System.String

Enabled

Specifies a value that indicates whether the MultiSelect component is enabled or not.

Declaration
[HtmlAttributeName("enabled")]
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

EnableGroupCheckBox

Specifies a Boolean value that indicates the whether the grouped list items are allowed to check by checking the group header in checkbox mode. By default, there is no checkbox provided for group headers. This property allows you to render checkbox for group headers and to select all the grouped items at once

Declaration
[HtmlAttributeName("enableGroupCheckBox")]
public bool EnableGroupCheckBox { get; set; }
Property Value
Type Description
System.Boolean

EnableHtmlSanitizer

Defines whether to allow the cross-scripting site or not.

Declaration
[HtmlAttributeName("enableHtmlSanitizer")]
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Enable or disable persisting MultiSelect component's state between page reloads. If enabled, following list of states will be persisted.

  1. value
Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

EnableSelectionOrder

Reorder the selected items in popup visibility state.

Declaration
[HtmlAttributeName("enableSelectionOrder")]
public bool EnableSelectionOrder { get; set; }
Property Value
Type Description
System.Boolean

Fields

The fields property maps the columns of the data table and binds the data to the component. text - Maps the text column from data table for each list item. value - Maps the value column from data table for each list item. iconCss - Maps the icon class column from data table for each list item. groupBy - Group the list items with it's related items by mapping groupBy field.

Declaration
[HtmlAttributeName("fields")]
public MultiSelectFieldSettings Fields { get; set; }
Property Value
Type Description
MultiSelectFieldSettings

FilterBarPlaceholder

Accepts the value to be displayed as a watermark text on the filter bar.

Declaration
[HtmlAttributeName("filterBarPlaceholder")]
public string FilterBarPlaceholder { get; set; }
Property Value
Type Description
System.String

Filtering

Triggers event,when user types a text in search box.

For more details about filtering, refer to Filtering documentation.

Declaration
[HtmlAttributeName("filtering")]
public string Filtering { get; set; }
Property Value
Type Description
System.String

FilterType

Determines on which filter type, the MultiSelect component needs to be considered on search action. The FilterType and its supported data types are

Declaration
[HtmlAttributeName("filterType")]
public FilterType FilterType { get; set; }
Property Value
Type Description
FilterType

FloatLabelType

Specifies whether to display the floating label above the input element. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.

Declaration
[HtmlAttributeName("floatLabelType")]
public FloatLabelType FloatLabelType { get; set; }
Property Value
Type Description
FloatLabelType

Focus

Event triggers when the input get focused.

Declaration
[HtmlAttributeName("focus")]
public string Focus { get; set; }
Property Value
Type Description
System.String

FooterTemplate

Accepts the template design and assigns it to the footer container of the popup list.

For more details about the available template options refer to Template documentation.

Declaration
[HtmlAttributeName("footerTemplate")]
public string FooterTemplate { get; set; }
Property Value
Type Description
System.String

GroupTemplate

Accepts the template design and assigns it to the group headers present in the MultiSelect popup list.

Declaration
[HtmlAttributeName("groupTemplate")]
public string GroupTemplate { get; set; }
Property Value
Type Description
System.String

HeaderTemplate

Accepts the template design and assigns it to the header container of the popup list.

For more details about the available template options refer to Template documentation.

Declaration
[HtmlAttributeName("headerTemplate")]
public string HeaderTemplate { get; set; }
Property Value
Type Description
System.String

HideSelectedItem

Hides the selected item from the list item.

Declaration
[HtmlAttributeName("hideSelectedItem")]
public bool HideSelectedItem { get; set; }
Property Value
Type Description
System.Boolean

HtmlAttributes

Gets or sets the additional attribute to HtmlAttributes property in MultiSelect, which helps to add attribute like title, name etc, input should be key value pair.

Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

IgnoreAccent

ignoreAccent set to true, then ignores the diacritic characters or accents when filtering.

Declaration
[HtmlAttributeName("ignoreAccent")]
public bool IgnoreAccent { get; set; }
Property Value
Type Description
System.Boolean

IgnoreCase

Sets case sensitive option for filter operation.

Declaration
[HtmlAttributeName("ignoreCase")]
public bool IgnoreCase { get; set; }
Property Value
Type Description
System.Boolean

IsFor

Declaration
protected override bool IsFor { get; }
Property Value
Type Description
System.Boolean
Overrides

ItemTemplate

Accepts the template design and assigns it to each list item present in the popup.

For more details about the available template options refer to Template documentation.

Declaration
[HtmlAttributeName("itemTemplate")]
public string ItemTemplate { get; set; }
Property Value
Type Description
System.String

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

MaximumSelectionLength

Sets limitation to the value selection. based on the limitation, list selection will be prevented.

Declaration
[HtmlAttributeName("maximumSelectionLength")]
public double MaximumSelectionLength { get; set; }
Property Value
Type Description
System.Double

Mode

configures visibility mode for component interaction.

Declaration
[HtmlAttributeName("mode")]
public VisualMode Mode { get; set; }
Property Value
Type Description
VisualMode

NameSpace

Declaration
protected override string NameSpace { get; }
Property Value
Type Description
System.String
Overrides

NoRecordsTemplate

Accepts the template design and assigns it to popup list of MultiSelect component when no data is available on the component.

Declaration
[HtmlAttributeName("noRecordsTemplate")]
public string NoRecordsTemplate { get; set; }
Property Value
Type Description
System.String

Open

Fires when popup opens after animation completion.

Declaration
[HtmlAttributeName("open")]
public string Open { get; set; }
Property Value
Type Description
System.String

OpenOnClick

Whether to automatically open the popup when the control is clicked.

Declaration
[HtmlAttributeName("openOnClick")]
public bool OpenOnClick { get; set; }
Property Value
Type Description
System.Boolean

Placeholder

Gets or sets the placeholder in the component to display the given information in input when no item selected.

Declaration
[HtmlAttributeName("placeholder")]
public string Placeholder { get; set; }
Property Value
Type Description
System.String

PopupHeight

Gets or sets the height of the popup list. By default it renders based on its list item.

For more details about the popup configuration refer to Popup Configuration documentation.

Declaration
[HtmlAttributeName("popupHeight")]
public string PopupHeight { get; set; }
Property Value
Type Description
System.String

PopupWidth

Gets or sets the width of the popup list and percentage values has calculated based on input width.

For more details about the popup configuration refer to Popup Configuration documentation.

Declaration
[HtmlAttributeName("popupWidth")]
public string PopupWidth { get; set; }
Property Value
Type Description
System.String

Query

Accepts the external Query which will execute along with the data processing in MultiSelect.

Declaration
[HtmlAttributeName("query")]
public string Query { get; set; }
Property Value
Type Description
System.String

Readonly

Gets or sets the readonly to input or not. Once enabled, just you can copy or highlight the text however tab key action will perform.

Declaration
[HtmlAttributeName("readonly")]
public bool Readonly { get; set; }
Property Value
Type Description
System.Boolean

Removed

Fires after the selected item removed from the widget.

Declaration
[HtmlAttributeName("removed")]
public string Removed { get; set; }
Property Value
Type Description
System.String

Removing

Fires before the selected item removed from the widget.

Declaration
[HtmlAttributeName("removing")]
public string Removing { get; set; }
Property Value
Type Description
System.String

Select

Triggers when an item in the popup is selected by the user either with mouse/tap or with keyboard navigation.

Declaration
[HtmlAttributeName("select")]
public string Select { get; set; }
Property Value
Type Description
System.String

SelectAllText

Specifies the selectAllText to be displayed on the component.

Declaration
[HtmlAttributeName("selectAllText")]
public string SelectAllText { get; set; }
Property Value
Type Description
System.String

SelectedAll

Fires after select all process completion.

Declaration
[HtmlAttributeName("selectedAll")]
public string SelectedAll { get; set; }
Property Value
Type Description
System.String

ShowClearButton

Enables close icon with the each selected item.

Declaration
[HtmlAttributeName("showClearButton")]
public bool ShowClearButton { get; set; }
Property Value
Type Description
System.Boolean

ShowDropDownIcon

Allows you to either show or hide the DropDown button on the component

Declaration
[HtmlAttributeName("showDropDownIcon")]
public bool ShowDropDownIcon { get; set; }
Property Value
Type Description
System.Boolean

ShowSelectAll

Allows you to either show or hide the selectAll option on the component.

Declaration
[HtmlAttributeName("showSelectAll")]
public bool ShowSelectAll { get; set; }
Property Value
Type Description
System.Boolean

SortOrder

Specifies the sortOrder to sort the data source. The available type of sort orders are None - The data source is not sorting. Ascending - The data source is sorting with ascending order. Descending - The data source is sorting with descending order.

Declaration
[HtmlAttributeName("sortOrder")]
public object SortOrder { get; set; }
Property Value
Type Description
System.Object

Tagging

Fires before set the selected item as chip in the component.

For more details about chip customization refer Chip Customization

Declaration
[HtmlAttributeName("tagging")]
public string Tagging { get; set; }
Property Value
Type Description
System.String

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

Text

Selects the list item which maps the data text field in the component.

Declaration
[HtmlAttributeName("text")]
public string Text { get; set; }
Property Value
Type Description
System.String

UnSelectAllText

Specifies the UnSelectAllText to be displayed on the component.

Declaration
[HtmlAttributeName("unSelectAllText")]
public string UnSelectAllText { get; set; }
Property Value
Type Description
System.String

Value

Selects the list item which maps the data value field in the component. {% codeBlock src='multiselect/value/index.md' %}{% endcodeBlock %}

Declaration
[HtmlAttributeName("value")]
public object Value { get; set; }
Property Value
Type Description
System.Object

ValueTemplate

Accepts the template design and assigns it to the selected list item in the input element of the component. For more details about the available template options refer to Template documentation.

Declaration
[HtmlAttributeName("valueTemplate")]
public string ValueTemplate { get; set; }
Property Value
Type Description
System.String

Width

Gets or sets the width of the component. By default, it sizes based on its parent. container dimension.

Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

ZIndex

specifies the z-index value of the component popup element.

Declaration
[HtmlAttributeName("zIndex")]
public double ZIndex { get; set; }
Property Value
Type Description
System.Double