Class RibbonComboBoxSettings

Inheritance

System.Object

RibbonComboBoxSettings

Namespace: Syncfusion.Blazor.Ribbon

Assembly: Syncfusion.Blazor.dll

Syntax

public class RibbonComboBoxSettings : OwningComponentBase

Constructors

RibbonComboBoxSettings()

Declaration

public RibbonComboBoxSettings()

Properties

AllowFiltering

Gets or sets a value indicating whether filtering is enabled for the items based on the characters typed in the search TextBox.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that determines if filtering is applied to retrieve matched items through the Filtering event. If no matches are found, the value of the NoRecordsTemplate property will be displayed. The default value is false.

Remarks

Set this property to true to enable filtering of items in response to user input in the search TextBox. If filtering is enabled and no matches are found, the NoRecordsTemplate will be shown to indicate that no records match the search criteria.

Autofill

Gets or sets a value indicating whether to automatically suggest the first matched item in the input when searching.

Declaration

public bool Autofill { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that determines if the first matching item is automatically suggested in the input field. No action is taken if no matches are found. The default value is true.

Remarks

Set this property to true to enable the autofill feature, which suggests the first item that matches the search criteria as the user types. If set to false, no automatic suggestion is made, and the user must select from the available matches manually.

CssClass

Gets or sets one or more CSS classes to customize the appearance of the ComboBox.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	A string containing one or more CSS class names, separated by spaces, to apply custom styles to the ComboBox. The default value is String.Empty.

Remarks

Use this property to add custom CSS classes to the ComboBox for styling purposes. If multiple classes are needed, separate them with a space.

DataSource

Gets or sets the list of items to bind to the component. It should be dynamic data collection.

Declaration

public dynamic DataSource { get; set; }

Property Value

Type	Description
System.Object	A value representing the data source for the ComboBox. The data source is a collection of dynamic objects.

Remarks

Use this property to provide a list of dynamic objects, each representing an item in the ComboBox. This collection will be displayed in the dropdown, with each item's text shown to the user while its corresponding value can be used internally.

FieldSettings

Gets or sets the fields that map the columns of the data table and bind the data to the component.

Declaration

public FieldSettingsModel FieldSettings { get; set; }

Property Value

Type	Description
FieldSettingsModel	An instance of FieldSettingsModel that specifies how the fields in the data source should be mapped to the ComboBox columns.

Remarks

Use this property to configure the field mappings for data binding. The FieldSettingsModel allows you to define how the data source columns are represented in the ComboBox.

Filtering

Gets or sets an event callback that is raised when a character is typed in the combobox.

Declaration

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

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ComboBoxFilterEventArgs>	An event callback of type ComboBoxFilterEventArgs that provides information during the filtering process.

Remarks

Use this event to set the callback for filtering events. It provides information when a character is typed in the component for filtering purposes.

FilterType

Gets or sets the type of filter to be applied during the search action.

Declaration

public FilterType FilterType { get; set; }

Property Value

Type	Description
FilterType	A FilterType value that specifies the type of filtering to be used in the search operation.

Remarks

Use this property to define how the search should filter the items. The FilterType enum allows you to specify various filtering criteria, such as:

• Contains: Filters items that contain the specified text.
• StartsWith: Filters items that start with the specified text.
• EndsWith: Filters items that end with the specified text.

FooterTemplate

Sets the template design for the footer container of the popup list.

Declaration

public RenderFragment FooterTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A string representing the template content for the footer. The default value is String.Empty.

Remarks

Use this property to define a custom template for the footer of the popup list. The template content can include HTML and other styling elements.

GroupTemplate

Gets or sets the template for customizing the group headers in the popup list.

Declaration

public RenderFragment<ComposedItemModel<object>> GroupTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<Syncfusion.Blazor.DropDowns.ComposedItemModel<System.Object>>	A Microsoft.AspNetCore.Components.RenderFragment<> of type Syncfusion.Blazor.DropDowns.ComposedItemModel`1 where T is System.Object. This allows for custom rendering of group headers. The default value is null.

Remarks

Use this property to provide a custom template for group headers in the popup list.
The template receives a Syncfusion.Blazor.DropDowns.ComposedItemModel`1 of System.Object which can be used to access
group-specific data for rendering. This allows for flexible styling and organization of the group headers.

HeaderTemplate

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

Declaration

public RenderFragment HeaderTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment representing the template content for the header. The default value is null.

Remarks

Use this property to customize the header section displayed above the list items in the popup.

HtmlAttributes

Specifies additional HTML attributes to be applied to the ComboBox Item.

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type
System.Collections.Generic.Dictionary<System.String, System.Object>

Index

Gets or sets the index of the selected item in the component.

Declaration

public Nullable<int> Index { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	A nullable integer representing the index of the selected item. The default value is null, indicating that no item is selected.

Remarks

Use this property to get or set the index of the currently selected item. If the value is null, it means no item is selected or the selection is not yet set.

ItemTemplate

Gets or sets the template for customizing the appearance of each list item in the popup.

Declaration

public RenderFragment<object> ItemTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>	A Microsoft.AspNetCore.Components.RenderFragment<> where TValue is System.Object. This allows for custom rendering of each list item. The default value is null.

Remarks

Use this property to define a custom template for each item in the dropdown.
The template receives an System.Object which can be cast to the appropriate type to access item-specific data. This allows for flexible styling and content definition for each list item. The template can include HTML, Blazor components, and other styling elements.

NoRecordsTemplate

Gets or sets the template design and assigns it to popup list of component when no data is available on the component.

Declaration

public RenderFragment NoRecordsTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	The template content. The default value is null.

Remarks

Use this property to define the template content for when no records are found during filtering. This template will be shown when the filtering does not return any results.

Placeholder

Gets or sets a short hint that describes the expected value of the combobox.

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
System.String	Accepts a string to define the placeholder value for the combobox. The default value is String.Empty.

Remarks

Use this property to provide a short hint that describes the expected value of the combobox, which will appear as placeholder text in the input field.

PopupClosed

Gets or sets an event callback that is raised when the popup is closed.

Declaration

public EventCallback<ComboBoxPopupClosedEventArgs> PopupClosed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ComboBoxPopupClosedEventArgs>	An event callback of type ComboBoxPopupClosedEventArgs that provides information when the popup is closed.

Remarks

Use this event to set the callback for when the ComboBox popup has closed. It provides information when the popup is closed.

PopupClosing

Gets or sets an event callback that is raised before the popup closes.

Declaration

public EventCallback<ComboBoxPopupCloseEventArgs> PopupClosing { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ComboBoxPopupCloseEventArgs>	An event callback of type ComboBoxPopupCloseEventArgs that provides information before the popup is closed.

Remarks

Use this event to set the callback for when the ComboBox popup closes. It provides information before the popup closes.

PopupHeight

Gets or sets the height of the popup list.

Declaration

public string PopupHeight { get; set; }

Property Value

Type	Description
System.String	Accepts a string to define the popup height. The default value is 300px.

Remarks

Use this property to define the height of the popup list. You can specify the height using pixel values or other valid CSS units.

PopupOpened

Gets or sets an event callback that is raised when the popup is opened.

Declaration

public EventCallback<ComboBoxPopupOpenedEventArgs> PopupOpened { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ComboBoxPopupOpenedEventArgs>	An event callback of type ComboBoxPopupOpenedEventArgs that provides information when the popup is opened.

Remarks

Use this event to set the callback for when the ComboBox popup has opened. It provides information when the popup is opened.

PopupOpening

Gets or sets an event callback that is raised before the popup opens.

Declaration

public EventCallback<ComboBoxPopupOpenEventArgs> PopupOpening { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ComboBoxPopupOpenEventArgs>	An event callback of type ComboBoxPopupOpenEventArgs that provides information before the popup is opened.

Remarks

Use this event to set the callback for when the ComboBox popup opens. It provides information before the popup opens.

PopupWidth

Gets or sets the width of the popup list. By default, the popup width sets based on the width of the input section.

Declaration

public string PopupWidth { get; set; }

Property Value

Type	Description
System.String	Accepts a string to define the popup width. By default, the popup width sets based on the width of the input section.

Remarks

Use this property to define the width of the popup list. You can specify the width using pixel values or other valid CSS units.

Selecting

Gets or sets an event callback that is raised when an item in the popup is selected by the user, either with a mouse/tap or keyboard navigation.

Declaration

public EventCallback<ComboBoxSelectEventArgs> Selecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ComboBoxSelectEventArgs>	An event callback of type ComboBoxSelectEventArgs that provides information when an item is selected.

Remarks

Use this event to set the callback for when an item is selected in the ComboBox. It provides information when an item is selected by the user.

ShowClearButton

Gets or sets a value indicating whether the ComboBox should display a clear button to clear the selected value.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type	Description
System.Boolean	true if the clear button is visible; otherwise, false. The default is false.

Remarks

When you click the clear button, the Value, and selected item will be cleared from the ComboBox input field.

SortOrder

Specifies the sorting order for the ComboBox data source.

Declaration

public SortOrder SortOrder { get; set; }

Property Value

Type	Description
SortOrder	A SortOrder value that determines the data source sorting order. None Ascending Descending

Text

Gets or sets the display text of the selected item in the ComboBox.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	A string representing the display text of the selected item. The default value is String.Empty.

Value

Gets or sets the value of the selected item in the ComboBox.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String	A string representing the value of the currently selected item. The default value is null.

Remarks

Use this property to retrieve or set the value of the item that is currently selected in the ComboBox.

ValueChange

Gets or sets an event callback that is raised when an item in the popup is selected or when the model value is changed by the user.

Declaration

public EventCallback<ComboBoxChangeEventArgs> ValueChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ComboBoxChangeEventArgs>	An event callback of type ComboBoxChangeEventArgs that provides information when the value changes.

Remarks

Use this event to set the callback for when the ComboBox value changes. It provides information when an item in the popup is selected or the model value is changed.

Width

Gets or sets the width of the ComboBox. You can specify the width using pixel values or other valid CSS units.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	A string representing the width of the component. The default value is "150px".

Remarks

Use this property to define the width of the ComboBox. Specify the width in pixels (e.g., "150px"), percentages (e.g., "100%"), or other CSS-supported units.

Methods

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task