Class RibbonComboBoxSettings

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

RibbonComboBoxSettings

Namespace: Syncfusion.EJ2.Ribbon

Assembly: Syncfusion.EJ2.dll

Syntax

public class RibbonComboBoxSettings : EJTagHelper

Constructors

RibbonComboBoxSettings()

Declaration

public RibbonComboBoxSettings()

Properties

AllowFiltering

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 bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Autofill

Specifies whether to suggest a first matched item in input when searching. No action happens when no matches found.

Declaration

public bool Autofill { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

BeforeOpen

Declaration

public string BeforeOpen { get; set; }

Property Value

Type	Description
System.String	The default value is null

Change

Declaration

public string Change { get; set; }

Property Value

Type	Description
System.String	The default value is null

Close

Declaration

public string Close { get; set; }

Property Value

Type	Description
System.String	The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

Created

Declaration

public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

CssClass

Defines the CSS class to customize the appearance of the combobox.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The default value is ""

DataSource

Defines the list of items to shown in the combobox.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Fields

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 object Fields { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Filtering

Declaration

public string Filtering { get; set; }

Property Value

Type	Description
System.String	The default value is null

FilterType

Specifies filter type to be considered on search action. The FilterType and its supported data types are

Declaration

public object FilterType { get; set; }

Property Value

Type	Description
System.Object	The default value is null

FooterTemplate

Specifies the template content for the footer container of the popup list.

Declaration

public string FooterTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

GroupTemplate

Specifies the template content for the group headers present in the popup list.

Declaration

public string GroupTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

HeaderTemplate

Specifies the template content for the header container of the popup list.

Declaration

public string HeaderTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

HtmlAttributes

Specifies additional HTML attributes to be applied to the combobox.

Declaration

public object HtmlAttributes { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Index

Specifies the index of the selected item in the combobox.

Declaration

public double Index { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

ItemTemplate

Specifies the template content for each list item present in the popup.

Declaration

public string ItemTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

Label

Specifies the label text for the overflow item.

Declaration

public string Label { get; set; }

Property Value

Type	Description
System.String	The default value is ""

NoRecordsTemplate

Specifies the template content for the popup list of combobox when no data is available.

Declaration

public string NoRecordsTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is "No records found"

Open

Declaration

public string Open { get; set; }

Property Value

Type	Description
System.String	The default value is null

Placeholder

Specifies a short hint that describes the expected value of the combobox.

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
System.String	The default value is null

PopupHeight

Specifies the height of the popup list.

Declaration

public string PopupHeight { get; set; }

Property Value

Type	Description
System.String	The default value is "300px"

PopupWidth

Specifies the width of the popup list. By default, the popup width sets based on the width of the combobox.

Declaration

public string PopupWidth { get; set; }

Property Value

Type	Description
System.String	The default value is "100%"

Select

Declaration

public string Select { get; set; }

Property Value

Type	Description
System.String	The default value is null

ShowClearButton

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type
System.Boolean

SortOrder

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 object SortOrder { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Text

Defines the display text of the selected item in the combobox.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The default value is null

Value

Defines the value of the selected item in the combobox.

Declaration

public object Value { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Width

Specifies the width of the combobox. By default, the combobox width sets based on the width of its parent container.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is "150px"