Class RibbonComboBoxSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
RibbonComboBoxSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class RibbonComboBoxSettingsBuilder : ControlBuilder
Constructors
RibbonComboBoxSettingsBuilder()
Declaration
public RibbonComboBoxSettingsBuilder()
RibbonComboBoxSettingsBuilder(RibbonComboBoxSettings)
Declaration
public RibbonComboBoxSettingsBuilder(RibbonComboBoxSettings model)
Parameters
Methods
AllowFiltering(Boolean)
Specifies whether to show the filter bar (search box) of the combobox.
The filter action retrieves matched items through the filtering event based on the characters typed in the search TextBox.
If no match is found, the value of the noRecordsTemplate property will be displayed.
Declaration
public RibbonComboBoxSettingsBuilder AllowFiltering(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Autofill(Boolean)
Specifies whether to suggest a first matched item in input when searching.
No action happens when no matches found.
Declaration
public RibbonComboBoxSettingsBuilder Autofill(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
BeforeOpen(String)
Event triggers before opening the popup.
Declaration
public RibbonComboBoxSettingsBuilder BeforeOpen(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Change(String)
Event triggers when an item in a popup is selected or when the model value is changed by user.
Declaration
public RibbonComboBoxSettingsBuilder Change(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Close(String)
Event triggers when the popup is closed.
Declaration
public RibbonComboBoxSettingsBuilder Close(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Created(String)
Event triggers once the combobox is created.
Declaration
public RibbonComboBoxSettingsBuilder Created(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
CssClass(String)
Defines the CSS class to customize the appearance of the combobox.
Declaration
public RibbonComboBoxSettingsBuilder CssClass(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public RibbonComboBoxSettingsBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
| Type |
Name |
Description |
| System.Action<Syncfusion.EJ2.DataManagerBuilder> |
dataSource |
|
Returns
DataSource(Double[])
Defines the list of items to shown in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder DataSource(double[] value)
Parameters
| Type |
Name |
Description |
| System.Double[] |
value |
|
Returns
DataSource(Object)
Defines the list of items to shown in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder DataSource(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
DataSource(String[])
Defines the list of items to shown in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder DataSource(string[] value)
Parameters
| Type |
Name |
Description |
| System.String[] |
value |
|
Returns
Fields(Object)
Specifies the mapping for the columns of the data table bind to the combobox.
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 RibbonComboBoxSettingsBuilder Fields(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Filtering(String)
Event triggers on typing a character in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder Filtering(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
FilterType(Object)
Specifies filter type to be considered on search action.
The FilterType and its supported data types are
Declaration
public RibbonComboBoxSettingsBuilder FilterType(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Specifies the template content for the footer container of the popup list.
Declaration
public RibbonComboBoxSettingsBuilder FooterTemplate(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
GroupTemplate(String)
Specifies the template content for the group headers present in the popup list.
Declaration
public RibbonComboBoxSettingsBuilder GroupTemplate(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Specifies the template content for the header container of the popup list.
Declaration
public RibbonComboBoxSettingsBuilder HeaderTemplate(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
HtmlAttributes(Object)
Specifies additional HTML attributes to be applied to the combobox.
Declaration
public RibbonComboBoxSettingsBuilder HtmlAttributes(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Index(Double)
Specifies the index of the selected item in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder Index(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ItemTemplate(String)
Specifies the template content for each list item present in the popup.
Declaration
public RibbonComboBoxSettingsBuilder ItemTemplate(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Label(String)
Specifies the label text for the overflow item.
Declaration
public RibbonComboBoxSettingsBuilder Label(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
NoRecordsTemplate(String)
Specifies the template content for the popup list of combobox when no data is available.
Declaration
public RibbonComboBoxSettingsBuilder NoRecordsTemplate(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Open(String)
Event triggers when the popup is opened
Declaration
public RibbonComboBoxSettingsBuilder Open(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Placeholder(String)
Specifies a short hint that describes the expected value of the combobox.
Declaration
public RibbonComboBoxSettingsBuilder Placeholder(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Specifies the height of the popup list.
Declaration
public RibbonComboBoxSettingsBuilder PopupHeight(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Specifies the width of the popup list.
By default, the popup width sets based on the width of the combobox.
Declaration
public RibbonComboBoxSettingsBuilder PopupWidth(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Select(String)
Event triggers when an item in the popup is selected.
Declaration
public RibbonComboBoxSettingsBuilder Select(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Specifies whether to show or hide the clear button.
When the clear button is clicked, value, text, and index properties are reset to null.
Declaration
public RibbonComboBoxSettingsBuilder ShowClearButton(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
SortOrder(Object)
Specifies the order in which the data source needs to be sorted. The available type of sort orders are
None - The data source is not sorted.
Ascending - The data source is sorted in ascending order.
Descending - The data source is sorted in descending order.
Declaration
public RibbonComboBoxSettingsBuilder SortOrder(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Text(String)
Defines the display text of the selected item in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder Text(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Value(Boolean)
Defines the value of the selected item in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder Value(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Value(Double)
Defines the value of the selected item in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder Value(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Value(Object)
Defines the value of the selected item in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder Value(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Value(String)
Defines the value of the selected item in the combobox.
Declaration
public RibbonComboBoxSettingsBuilder Value(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Width(String)
Specifies the width of the combobox.
By default, the combobox width sets based on the width of its parent container.
Declaration
public RibbonComboBoxSettingsBuilder Width(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
