Class MultiSelect

Inheritance
System.Object
EJTagHelper
MultiSelect
Inherited Members
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
public string ActionBegin { get; set; }
Property Value
Type Description
System.String

The default value is null

ActionComplete

Triggers after data is fetched successfully from the remote server.

Declaration
public string ActionComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

ActionFailure

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

Declaration
public string ActionFailure { get; set; }
Property Value
Type Description
System.String

The default value is null

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
public string ActionFailureTemplate { get; set; }
Property Value
Type Description
System.String

The default value is "Request failed"

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
public bool AddTagOnBlur { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AllowCustomValue

Declaration
public bool AllowCustomValue { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

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
public bool AllowFiltering { get; set; }
Property Value
Type Description
System.Boolean

The default value is null

BeforeOpen

Fires when popup opens before animation.

Declaration
public string BeforeOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeSelectAll

Fires before select all process.

Declaration
public string BeforeSelectAll { get; set; }
Property Value
Type Description
System.String

The default value is null

Blur

Event triggers when the input get focus-out.

Declaration
public string Blur { get; set; }
Property Value
Type Description
System.String

The default value is null

Change

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

Declaration
public string Change { get; set; }
Property Value
Type Description
System.String

The default value is null

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
public bool ChangeOnBlur { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

ChipSelection

Event triggers when the chip selection.

Declaration
public string ChipSelection { get; set; }
Property Value
Type Description
System.String

The default value is null

Close

Fires when popup close after animation completion.

Declaration
public string Close { get; set; }
Property Value
Type Description
System.String

The default value is null

ClosePopupOnSelect

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

Declaration
public bool ClosePopupOnSelect { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

Created

Triggers when the component is created.

Declaration
public string Created { get; set; }
Property Value
Type Description
System.String

The default value is null

CssClass

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

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

The default value is null

CustomValueSelection

Declaration
public string CustomValueSelection { get; set; }
Property Value
Type Description
System.String

The default value is null

DataBound

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

Declaration
public string DataBound { get; set; }
Property Value
Type Description
System.String

The default value is null

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
public object DataSource { get; set; }
Property Value
Type Description
System.Object

The default value is null

DelimiterChar

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

Declaration
public string DelimiterChar { get; set; }
Property Value
Type Description
System.String

The default value is ","

Destroyed

Triggers when the component is destroyed.

Declaration
public string Destroyed { get; set; }
Property Value
Type Description
System.String

The default value is null

Enabled

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

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

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
public bool EnableGroupCheckBox { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableHtmlSanitizer

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

Declaration
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnablePersistence

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

  1. value
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableSelectionOrder

Reorder the selected items in popup visibility state.

Declaration
public bool EnableSelectionOrder { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

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
public MultiSelectFieldSettings Fields { get; set; }
Property Value
Type Description
MultiSelectFieldSettings

The default value is null

FilterBarPlaceholder

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

Declaration
public string FilterBarPlaceholder { get; set; }
Property Value
Type Description
System.String

The default value is null

Filtering

Declaration
public string Filtering { get; set; }
Property Value
Type Description
System.String

The default value is null

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
public FilterType FilterType { get; set; }
Property Value
Type Description
FilterType

The default value is FilterType.StartsWith

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
public FloatLabelType FloatLabelType { get; set; }
Property Value
Type Description
FloatLabelType

The default value is Syncfusion.EJ2.Inputs.FloatLabelType.Never

Focus

Event triggers when the input get focused.

Declaration
public string Focus { get; set; }
Property Value
Type Description
System.String

The default value is null

FooterTemplate

Declaration
public string FooterTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

For

Declaration
public override ModelExpression For { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExpression
Overrides

GroupTemplate

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

Declaration
public string GroupTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

HeaderTemplate

Declaration
public string HeaderTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

HideSelectedItem

Hides the selected item from the list item.

Declaration
public bool HideSelectedItem { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

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
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

The default value is null

IgnoreAccent

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

Declaration
public bool IgnoreAccent { get; set; }
Property Value
Type Description
System.Boolean

The default value is null

IgnoreCase

Declaration
public bool IgnoreCase { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

ItemTemplate

Declaration
public string ItemTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

Locale

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

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

The default value is "en-US"

MaximumSelectionLength

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

Declaration
public double MaximumSelectionLength { get; set; }
Property Value
Type Description
System.Double

The default value is 1000

Mode

configures visibility mode for component interaction.

Declaration
public VisualMode Mode { get; set; }
Property Value
Type Description
VisualMode

The default value is VisualMode.Default

NoRecordsTemplate

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

Declaration
public string NoRecordsTemplate { get; set; }
Property Value
Type Description
System.String

The default value is "No records found"

Open

Fires when popup opens after animation completion.

Declaration
public string Open { get; set; }
Property Value
Type Description
System.String

The default value is null

OpenOnClick

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

Declaration
public bool OpenOnClick { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

Placeholder

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

Declaration
public string Placeholder { get; set; }
Property Value
Type Description
System.String

The default value is null

PopupHeight

Declaration
public string PopupHeight { get; set; }
Property Value
Type Description
System.String

The default value is "300px"

PopupWidth

Declaration
public string PopupWidth { get; set; }
Property Value
Type Description
System.String

The default value is "100%"

Query

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

Declaration
public string Query { get; set; }
Property Value
Type Description
System.String

The default value is null

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
public bool Readonly { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

Removed

Fires after the selected item removed from the widget.

Declaration
public string Removed { get; set; }
Property Value
Type Description
System.String

The default value is null

Removing

Fires before the selected item removed from the widget.

Declaration
public string Removing { get; set; }
Property Value
Type Description
System.String

The default value is null

Select

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

Declaration
public string Select { get; set; }
Property Value
Type Description
System.String

The default value is null

SelectAllText

Specifies the selectAllText to be displayed on the component.

Declaration
public string SelectAllText { get; set; }
Property Value
Type Description
System.String

The default value is "select All"

SelectedAll

Fires after select all process completion.

Declaration
public string SelectedAll { get; set; }
Property Value
Type Description
System.String

The default value is null

ShowClearButton

Enables close icon with the each selected item.

Declaration
public bool ShowClearButton { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

ShowDropDownIcon

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

Declaration
public bool ShowDropDownIcon { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ShowSelectAll

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

Declaration
public bool ShowSelectAll { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

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
public object SortOrder { get; set; }
Property Value
Type Description
System.Object

The default value is null

Tagging

Declaration
public string Tagging { get; set; }
Property Value
Type Description
System.String

The default value is null

Text

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

Declaration
public string Text { get; set; }
Property Value
Type Description
System.String

The default value is null

UnSelectAllText

Specifies the UnSelectAllText to be displayed on the component.

Declaration
public string UnSelectAllText { get; set; }
Property Value
Type Description
System.String

The default value is "select All"

Value

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

Declaration
public object Value { get; set; }
Property Value
Type Description
System.Object

The default value is null

ValueTemplate

Declaration
public string ValueTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

Width

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

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String

The default value is "100%"

ZIndex

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

Declaration
public double ZIndex { get; set; }
Property Value
Type Description
System.Double

The default value is 1000