Class MultiSelectModel<T>

Interface for a class MultiSelect.

Inheritance

System.Object

MultiSelectModel<T>

Namespace: Syncfusion.Blazor.DropDowns

Assembly: Syncfusion.Blazor.dll

Syntax

public class MultiSelectModel<T> : Object

Type Parameters

Name	Description
T	Specifies the type of MultiSelectModel.

Constructors

MultiSelectModel()

Declaration

public MultiSelectModel()

Properties

ActionBegin

Gets or sets the ActionBegin event arguments.

Declaration

public ActionBeginEventArgs ActionBegin { get; set; }

Property Value

Type
ActionBeginEventArgs

ActionComplete

Gets or sets the ActionComplete event arguments.

Declaration

public ActionCompleteEventArgs ActionComplete { get; set; }

Property Value

Type
ActionCompleteEventArgs

ActionFailure

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

Declaration

public EventCallback<object> ActionFailure { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

ActionFailureTemplate

Gets or sets the template that is used as the popup list content of the component when the data fetch request from the remote server fails.

Declaration

public string ActionFailureTemplate { get; set; }

Property Value

Type
System.String

AllowCustomValue

Gets or sets a value indicating whether the user is allowed to add a custom value that is not present in the suggestion list.

Declaration

public bool AllowCustomValue { get; set; }

Property Value

Type
System.Boolean

AllowFiltering

Gets or sets a value indicating whether the filtering option is enabled 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
System.Boolean

BeforeOpen

Gets or sets the BeforeOpen event arguments.

Declaration

public BeforeOpenEventArgs BeforeOpen { get; set; }

Property Value

Type
BeforeOpenEventArgs

Blur

Event triggers when the input get focus-out.

Declaration

public EventCallback<object> Blur { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Change

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

Declaration

public EventCallback<object> Change { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

ChangeOnBlur

Gets or sets a value indicating whether the MultiSelect component fires the Change event on every value selection and removal, instead of only on focus out of the component.

Declaration

public bool ChangeOnBlur { get; set; }

Property Value

Type
System.Boolean

ChipSelection

Event triggers when the chip selection.

Declaration

public EventCallback<object> ChipSelection { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Close

Fires when popup close after animation completion.

Declaration

public EventCallback<object> Close { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

ClosePopupOnSelect

Gets or sets a value indicating whether the popup visibility state will be changed when an item is selected, based on the property.

Declaration

public bool ClosePopupOnSelect { get; set; }

Property Value

Type
System.Boolean

Created

Triggers when the component is created.

Declaration

public EventCallback<object> Created { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

CssClass

Gets or sets the CSS class name that can be appended with the root element of the MultiSelect. One or more custom CSS classes can be added to a MultiSelect.

Declaration

public string CssClass { get; set; }

Property Value

Type
System.String

CustomValueSelection

Triggers when the CustomValue is selected.

Declaration

public EventCallback<object> CustomValueSelection { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DataBound

Gets or sets the DataBound event arguments.

Declaration

public DataBoundEventArgs DataBound { get; set; }

Property Value

Type
DataBoundEventArgs

DataSource

Gets or sets the data source that provides the list items for 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
System.Object

DelimiterChar

Gets or sets the delimiter character for 'default' and 'delimiter' visibility modes.

Declaration

public string DelimiterChar { get; set; }

Property Value

Type
System.String

Destroyed

Triggers when the component is destroyed.

Declaration

public EventCallback<object> Destroyed { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Enabled

Gets or sets a value indicating whether the MultiSelect control allows the user to interact with it.

Declaration

public bool Enabled { get; set; }

Property Value

Type
System.Boolean

EnableGroupCheckBox

Gets or sets a value indicating whether the grouped list items are allowed to be checked 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
System.Boolean

EnablePersistence

Gets or sets a value indicating whether the MultiSelect control persists the MultiSelect state between page reloads. If enabled, the Value state will be persisted.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type
System.Boolean

EnableRtl

Gets or sets a value indicating whether the MultiSelect control is rendered in the right-to-left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type
System.Boolean

EnableSelectionOrder

Gets or sets a value indicating whether the selected items in the popup visibility state are reordered.

Declaration

public bool EnableSelectionOrder { get; set; }

Property Value

Type
System.Boolean

Fields

Gets or sets the Fields property of the MultiSelect control that maps the columns of the data table and binds the data to the component. The Text property maps the text column from the data table for each list item. The Value property maps the value column from the data table for each list item. The IconCss property maps the icon class column from the data table for each list item. The GroupBy property groups the list items with its related items by mapping the groupBy field.

Declaration

public FieldSettingsModel Fields { get; set; }

Property Value

Type
FieldSettingsModel

FilterBarPlaceholder

Gets or sets the watermark text displayed in the filter bar of the MultiSelect control.

Declaration

public string FilterBarPlaceholder { get; set; }

Property Value

Type
System.String

Filtering

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

Declaration

public EventCallback<object> Filtering { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

FilterType

Gets or sets a value indicating the filter type the MultiSelect control uses during a search action.

Declaration

public FilterType FilterType { get; set; }

Property Value

Type
FilterType

FloatLabelType

Gets or sets the floating label behavior of the MultiSelect control. The placeholder text floats above the MultiSelect based on the following values: Never - never floats the label in the MultiSelect when the placeholder is available; Always - the floating label always floats above the MultiSelect; Auto - the floating label floats above the MultiSelect after focusing it or when entering a value in it.

Declaration

public FloatLabelType FloatLabelType { get; set; }

Property Value

Type
FloatLabelType

Focus

Event triggers when the input get focused.

Declaration

public EventCallback<object> Focus { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

FooterTemplate

Gets or sets the template design for the footer container of the popup list in the MultiSelect control.

Declaration

public string FooterTemplate { get; set; }

Property Value

Type
System.String

GroupTemplate

Gets or sets the template design for the group headers in the MultiSelect control popup list.

Declaration

public string GroupTemplate { get; set; }

Property Value

Type
System.String

HeaderTemplate

Gets or sets the template design for the header container of the popup list.

Declaration

public string HeaderTemplate { get; set; }

Property Value

Type
System.String

HideSelectedItem

Gets or sets a value indicating whether the selected item is hidden from the list item.

Declaration

public bool HideSelectedItem { get; set; }

Property Value

Type
System.Boolean

HtmlAttributes

Gets or sets the additional input attributes such as disabled, value, and more for the root element.

If both the property and equivalent input attribute are configured, the component considers the property value.

Declaration

public object HtmlAttributes { get; set; }

Property Value

Type
System.Object

IgnoreAccent

Gets or sets a value indicating whether diacritic characters or accents are ignored when filtering, when set to true.

Declaration

public bool IgnoreAccent { get; set; }

Property Value

Type
System.Boolean

IgnoreCase

Gets or sets a value indicating whether the filter operation is case sensitive.

Declaration

public bool IgnoreCase { get; set; }

Property Value

Type
System.Boolean

ItemTemplate

Gets or sets the template design for each list item present in the popup.

Declaration

public string ItemTemplate { get; set; }

Property Value

Type
System.String

Locale

Gets or sets the global culture and localization of the MultiSelect component.

Declaration

public string Locale { get; set; }

Property Value

Type
System.String

MaximumSelectionLength

Gets or sets the maximum number of selections allowed in the list.

The list selection will be prevented based on the limitation.

Declaration

public int MaximumSelectionLength { get; set; }

Property Value

Type
System.Int32

Mode

Gets or sets the visibility mode for component interaction.

Declaration

public VisualMode Mode { get; set; }

Property Value

Type
VisualMode

NoRecordsTemplate

Gets or sets the template design for the popup list of the MultiSelect component when no data is available.

Declaration

public string NoRecordsTemplate { get; set; }

Property Value

Type
System.String

Open

Fires when popup opens after animation completion.

Declaration

public EventCallback<object> Open { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

OpenOnClick

Gets or sets a value indicating whether the popup is automatically opened when the control is clicked.

Declaration

public bool OpenOnClick { get; set; }

Property Value

Type
System.Boolean

Placeholder

Gets or sets the text that is shown as a hint or placeholder until the user focuses or enters a value in MultiSelect. The property depends on the FloatLabelType property.

Declaration

public string Placeholder { get; set; }

Property Value

Type
System.String

PopupHeight

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

Declaration

public string PopupHeight { get; set; }

Property Value

Type
System.String

PopupWidth

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

Declaration

public string PopupWidth { get; set; }

Property Value

Type
System.String

Query

Gets or sets the external Query which will execute along with the data processing in MultiSelect.

Declaration

public object Query { get; set; }

Property Value

Type
System.Object

Readonly

Gets or sets a value indicating whether the MultiSelect allows the user to change the value.

Declaration

public bool Readonly { get; set; }

Property Value

Type
System.Boolean

Removed

Fires after the selected item removed from the widget.

Declaration

public EventCallback<object> Removed { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Removing

Fires before the selected item removed from the widget.

Declaration

public EventCallback<object> Removing { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Select

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

Declaration

public EventCallback<object> Select { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

SelectAllText

Gets or sets the selectAllText to be displayed on the component.

Declaration

public string SelectAllText { get; set; }

Property Value

Type
System.String

SelectedAll

Fires after select all process completion.

Declaration

public EventCallback<object> SelectedAll { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

ShowClearButton

Gets or sets a value indicating whether to enable a close icon with each selected item.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type
System.Boolean

ShowDropDownIcon

Gets or sets a value indicating whether to show the DropDown button on the component.

Declaration

public bool ShowDropDownIcon { get; set; }

Property Value

Type
System.Boolean

ShowSelectAll

Gets or sets a value indicating whether to show the selectAll option on the component.

Declaration

public bool ShowSelectAll { get; set; }

Property Value

Type
System.Boolean

SortOrder

Gets or sets the SortOrder to sort the data source. The available types of sort orders are None, Ascending, and Descending.

Declaration

public SortOrder SortOrder { get; set; }

Property Value

Type
SortOrder

Tagging

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

Declaration

public EventCallback<object> Tagging { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Text

Gets or sets the list item that maps the data Text field in the component.

Declaration

public string Text { get; set; }

Property Value

Type
System.String

UnSelectAllText

Gets or sets the unSelectAllText to be displayed on the component.

Declaration

public string UnSelectAllText { get; set; }

Property Value

Type
System.String

Value

Gets or sets the selected list item which maps the data Value field in the component.

Declaration

public T Value { get; set; }

Property Value

Type
T

ValueTemplate

Gets or sets the template design that will be assigned to the selected list item in the input element of the component.

Declaration

public string ValueTemplate { get; set; }

Property Value

Type
System.String

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
System.String

ZIndex

Gets or sets the z-index value of the component popup element.

Declaration

public double ZIndex { get; set; }

Property Value

Type
System.Double