Class MultiSelectModel<T>
Interface for a class MultiSelect
Inheritance
Implements
Namespace: Syncfusion.Blazor.DropDowns
Assembly: Syncfusion.Blazor.dll
Syntax
public class MultiSelectModel<T> : Object, IEquatable<MultiSelectModel<T>>
Type Parameters
Name | Description |
---|---|
T |
Constructors
MultiSelectModel()
Declaration
public MultiSelectModel()
Properties
ActionBegin
Triggers before fetching data from the remote server.
Declaration
public ActionBeginEventArgs ActionBegin { get; set; }
Property Value
Type | Description |
---|---|
ActionBeginEventArgs |
ActionComplete
Triggers after data is fetched successfully from the remote server.
Declaration
public ActionCompleteEventArgs ActionComplete { get; set; }
Property Value
Type | Description |
---|---|
ActionCompleteEventArgs |
ActionFailure
Triggers when the data fetch request from the remote server fails.
Declaration
public EventCallback<object> ActionFailure { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
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 |
AllowCustomValue
Allows user to add a custom value the value which is not present in the suggestion list.
Declaration
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
public bool AllowFiltering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
BeforeOpen
Fires when popup opens before animation.
Declaration
public BeforeOpenEventArgs BeforeOpen { get; set; }
Property Value
Type | Description |
---|---|
BeforeOpenEventArgs |
Blur
Event triggers when the input get focus-out.
Declaration
public EventCallback<object> Blur { get; set; }
Property Value
Type | Description |
---|---|
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 | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
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 |
ChipSelection
Event triggers when the chip selection.
Declaration
public EventCallback<object> ChipSelection { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
Close
Fires when popup close after animation completion.
Declaration
public EventCallback<object> Close { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
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 |
Created
Triggers when the component is created.
Declaration
public EventCallback<object> Created { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
CssClass
Specifies 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 | Description |
---|---|
System.String |
CustomValueSelection
Triggers when the CustomValue is selected.
Declaration
public EventCallback<object> CustomValueSelection { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
DataBound
Triggers when data source is populated in the popup list.
Declaration
public DataBoundEventArgs DataBound { get; set; }
Property Value
Type | Description |
---|---|
DataBoundEventArgs |
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 |
DelimiterChar
Sets the delimiter character for 'default' and 'delimiter' visibility modes.
Declaration
public string DelimiterChar { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Destroyed
Triggers when the component is destroyed.
Declaration
public EventCallback<object> Destroyed { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
Enabled
Specifies a boolean value that indicates whether the MultiSelect allows the user to interact with it.
Declaration
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
public bool EnableGroupCheckBox { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnablePersistence
Enable or disable persisting MultiSelect state between page reloads.
If enabled, the `Value` state will be persisted.
- Value
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableSelectionOrder
Reorder the selected items in popup visibility state.
Declaration
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.
- TextMaps the text column from data table for each list item.
- ValueMaps the value column from data table for each list item.
- IconCssMaps the icon class column from data table for each list item.
- GroupByGroup the list items with it's related items by mapping groupBy field.
Declaration
public FieldSettingsModel Fields { get; set; }
Property Value
Type | Description |
---|---|
FieldSettingsModel |
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 |
Filtering
Triggers event,when user types a text in search box.
Declaration
public EventCallback<object> Filtering { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
FilterType
Determines on which filter type, the MultiSelect component needs to be considered on search action.
Declaration
public FilterType FilterType { get; set; }
Property Value
Type | Description |
---|---|
FilterType |
FloatLabelType
Specifies the floating label behavior of the MultiSelect that the placeholder text floats above the MultiSelect based on the following values.
Possible values are:
- NeverNever floats the label in the MultiSelect when the placeholder is available.
- AlwaysThe floating label always floats above the MultiSelect.
- AutoThe floating label floats above the MultiSelect after focusing it or when enters the value in it.
Declaration
public FloatLabelType FloatLabelType { get; set; }
Property Value
Type | Description |
---|---|
FloatLabelType |
Focus
Event triggers when the input get focused.
Declaration
public EventCallback<object> Focus { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
FooterTemplate
Accepts the template design and assigns it to the footer container of the popup list.
Declaration
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
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.
Declaration
public string HeaderTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String |
HideSelectedItem
Hides the selected item from the list item.
Declaration
public bool HideSelectedItem { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
HtmlAttributes
You can add the additional input attributes such as disabled, value, and more to the root element.
If you configured both the property and equivalent input attribute, then the component considers the property value.
Declaration
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
public bool IgnoreAccent { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IgnoreCase
Sets case sensitive option for filter operation.
Declaration
public bool IgnoreCase { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ItemTemplate
Accepts the template design and assigns it to each list item present in the popup.
Declaration
public string ItemTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Locale
Specifies the global culture and localization of the MultiSelect.
Declaration
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
public int MaximumSelectionLength { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Mode
configures visibility mode for component interaction.
Declaration
public VisualMode Mode { get; set; }
Property Value
Type | Description |
---|---|
VisualMode |
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 |
Open
Fires when popup opens after animation completion.
Declaration
public EventCallback<object> Open { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
OpenOnClick
Whether to automatically open the popup when the control is clicked.
Declaration
public bool OpenOnClick { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Placeholder
Specifies the text that is shown as a hint or placeholder until the user focuses or enter a value in MultiSelect. The property is depending on the FloatLabelType property.
Declaration
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.
Declaration
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.
Declaration
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
public object Query { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
Readonly
Specifies the boolean value whether the MultiSelect allows the user to change the value.
Declaration
public bool Readonly { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Removed
Fires after the selected item removed from the widget.
Declaration
public EventCallback<object> Removed { get; set; }
Property Value
Type | Description |
---|---|
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 | Description |
---|---|
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 | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
SelectAllText
Specifies the selectAllText to be displayed on the component.
Declaration
public string SelectAllText { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SelectedAll
Fires after select all process completion.
Declaration
public EventCallback<object> SelectedAll { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
ShowClearButton
Enables close icon with the each selected item.
Declaration
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
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
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
- NoneThe data source is not sorting.
- AscendingThe data source is sorting with ascending order.
- DescendingThe data source is sorting with descending order.
Declaration
public SortOrder SortOrder { get; set; }
Property Value
Type | Description |
---|---|
SortOrder |
Tagging
Fires before set the selected item as chip in the component.
Declaration
public EventCallback<object> Tagging { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
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 |
UnSelectAllText
Specifies the UnSelectAllText to be displayed on the component.
Declaration
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.
Declaration
public T Value { get; set; }
Property Value
Type | Description |
---|---|
T |
ValueTemplate
Accepts the template design and assigns it to the selected list item in the input element of the component.
Declaration
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
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ZIndex
specifies the z-index value of the component popup element.
Declaration
public double ZIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Methods
Equals(MultiSelectModel<T>)
Declaration
public bool Equals(MultiSelectModel<T> multiSelectModel)
Parameters
Type | Name | Description |
---|---|---|
MultiSelectModel<T> | multiSelectModel |
Returns
Type | Description |
---|---|
System.Boolean |