Class MultiSelectFieldSettings

Provides settings to map field names from a data source to the properties expected by the Syncfusion MultiSelect Dropdown component.

Inheritance
System.Object
SfBaseComponent
SfDataBoundComponent
MultiSelectFieldSettings
Inherited Members
Namespace: Syncfusion.Blazor.DropDowns
Assembly: Syncfusion.Blazor.dll
Syntax
public class MultiSelectFieldSettings : SfDataBoundComponent
Remarks

Use this class to specify which fields in your data source should be mapped to text, value, grouping, icon, and other attributes in the dropdown UI.

Examples
<SfMultiSelect TValue="string" TItem="Country" DataSource="@CountryData">
    <MultiSelectFieldSettings Text="Name" Value="Code" GroupBy="Region" IconCss="FlagIcon" />
</SfMultiSelect>
@code {
    public class Country
    {
        public string Name { get; set; }
        public string Code { get; set; }
        public string FlagIcon { get; set; }
        public string Region { get; set; }
    }
    List<Country> CountryData = ...;
}

Constructors

MultiSelectFieldSettings()

Declaration
public MultiSelectFieldSettings()

Properties

Disabled

Gets or sets the field in the data source that determines whether a particular item is disabled (not selectable) in the MultiSelect Dropdown popup.

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

The field name or expression indicating if the item should be disabled; value is parsed as bool or coercible string (e.g. "true" or "false").
Remarks

If this field evaluates to true for an item, it cannot be selected. Use for data-driven disabling scenarios.

GroupBy

Gets or sets the column name in the data source used to group items in the MultiSelect Dropdown popup.

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

The field name by which to group dropdown list items, typically a property on each data item.
Remarks

Setting this property enables grouped item display in the dropdown list based on the specified field value.

HtmlAttributes

(Obsolete) Gets or sets additional HTML attributes for the list element, such as style or CSS class. No longer supported in recent versions.

Declaration
public string HtmlAttributes { get; set; }
Property Value
Type
System.String
Remarks

This property is obsolete and will be removed in a future release. Specify additional styling or classes directly in your markup or with CssClass APIs instead.

IconCss

Gets or sets the field in the data source that provides the CSS class or classes to display an icon for each item in the dropdown list.

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

The data source field containing the icon CSS class, or null for no icon.
Remarks

Use this property when you want to show custom icons on MultiSelect dropdown items based on dynamic data.

Text

Gets or sets the field name in the data source for the text to show for each item in the MultiSelect Dropdown popup.

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

The data source field whose value is shown as the visible label for each dropdown item.
Remarks

Use this to bind meaningful labels for items in the dropdown.

Value

Gets or sets the field in the data source whose value is used as the internal value for each item in the MultiSelect Dropdown popup.

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

The data source field whose value is the actual value submitted or bound for each item.
Remarks

Changing this property updates the data mapping for the dropdown’s Value.