Class ComboBoxBuilder

Inheritance
System.Object
ControlBuilder
ComboBoxBuilder
Inherited Members
Namespace: Syncfusion.EJ2.DropDowns
Assembly: Syncfusion.EJ2.dll
Syntax
public class ComboBoxBuilder : ControlBuilder

Constructors

ComboBoxBuilder()

Declaration
public ComboBoxBuilder()

ComboBoxBuilder(ComboBox)

Declaration
public ComboBoxBuilder(ComboBox model)
Parameters
Type Name Description
ComboBox model

Fields

model

Declaration
public ComboBox model
Field Value
Type Description
ComboBox

Properties

HtmlAttr

Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

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

Output

Declaration
public override TextWriter Output { get; set; }
Property Value
Type Description
System.IO.TextWriter
Overrides

Methods

ActionBegin(String)

Triggers before fetching data from the remote server.

Declaration
public ComboBoxBuilder ActionBegin(string actionBegin)
Parameters
Type Name Description
System.String actionBegin
Returns
Type Description
ComboBoxBuilder

ActionComplete(String)

Triggers after data is fetched successfully from the remote server.

Declaration
public ComboBoxBuilder ActionComplete(string actionComplete)
Parameters
Type Name Description
System.String actionComplete
Returns
Type Description
ComboBoxBuilder

ActionFailure(String)

Triggers when the data fetch request from the remote server fails.

Declaration
public ComboBoxBuilder ActionFailure(string actionFailure)
Parameters
Type Name Description
System.String actionFailure
Returns
Type Description
ComboBoxBuilder

ActionFailureTemplate(String)

Accepts the template and assigns it to the popup list content of the component when the data fetch request from the remote server fails.

Declaration
public ComboBoxBuilder ActionFailureTemplate(string actionFailureTemplate)
Parameters
Type Name Description
System.String actionFailureTemplate
Returns
Type Description
ComboBoxBuilder

AllowCustom(Boolean)

Specifies whether the component allows user defined value which does not exist in data source.

Declaration
public ComboBoxBuilder AllowCustom(bool allowCustom = true)
Parameters
Type Name Description
System.Boolean allowCustom
Returns
Type Description
ComboBoxBuilder

AllowFiltering(Boolean)

When allowFiltering is set to true, show the filter bar (search box) of the component. 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 ComboBoxBuilder AllowFiltering(bool allowFiltering = true)
Parameters
Type Name Description
System.Boolean allowFiltering
Returns
Type Description
ComboBoxBuilder

Autofill(Boolean)

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

Declaration
public ComboBoxBuilder Autofill(bool autofill = true)
Parameters
Type Name Description
System.Boolean autofill
Returns
Type Description
ComboBoxBuilder

BeforeOpen(String)

Triggers when the popup before opens.

Declaration
public ComboBoxBuilder BeforeOpen(string beforeOpen)
Parameters
Type Name Description
System.String beforeOpen
Returns
Type Description
ComboBoxBuilder

Blur(String)

Triggers when focus moves out from the component.

Declaration
public ComboBoxBuilder Blur(string blur)
Parameters
Type Name Description
System.String blur
Returns
Type Description
ComboBoxBuilder

Change(String)

Triggers when an item in a popup is selected or when the model value is changed by user. Use change event to Configure the Cascading DropDownList

Declaration
public ComboBoxBuilder Change(string change)
Parameters
Type Name Description
System.String change
Returns
Type Description
ComboBoxBuilder

Close(String)

Triggers when the popup is closed.

Declaration
public ComboBoxBuilder Close(string close)
Parameters
Type Name Description
System.String close
Returns
Type Description
ComboBoxBuilder

Created(String)

Triggers when the component is created.

Declaration
public ComboBoxBuilder Created(string created)
Parameters
Type Name Description
System.String created
Returns
Type Description
ComboBoxBuilder

CssClass(String)

Sets CSS classes to the root element of the component that allows customization of appearance.

Declaration
public ComboBoxBuilder CssClass(string cssClass)
Parameters
Type Name Description
System.String cssClass
Returns
Type Description
ComboBoxBuilder

CustomValueSpecifier(String)

Triggers on set a custom value to this component.

Declaration
public ComboBoxBuilder CustomValueSpecifier(string customValueSpecifier)
Parameters
Type Name Description
System.String customValueSpecifier
Returns
Type Description
ComboBoxBuilder

DataBound(String)

Triggers when data source is populated in the popup list..

Declaration
public ComboBoxBuilder DataBound(string dataBound)
Parameters
Type Name Description
System.String dataBound
Returns
Type Description
ComboBoxBuilder

DataSource(Action<DataManagerBuilder>)

Declaration
public ComboBoxBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Type Name Description
System.Action<DataManagerBuilder> dataSource
Returns
Type Description
ComboBoxBuilder

DataSource(Double[])

Accepts the list items either through local or remote service and binds it to the component. It can be an array of JSON Objects or an instance of DataManager.

Declaration
public ComboBoxBuilder DataSource(double[] dataSource)
Parameters
Type Name Description
System.Double[] dataSource
Returns
Type Description
ComboBoxBuilder

DataSource(Object)

Accepts the list items either through local or remote service and binds it to the component. It can be an array of JSON Objects or an instance of DataManager.

Declaration
public ComboBoxBuilder DataSource(object dataSource)
Parameters
Type Name Description
System.Object dataSource
Returns
Type Description
ComboBoxBuilder

DataSource(String[])

Accepts the list items either through local or remote service and binds it to the component. It can be an array of JSON Objects or an instance of DataManager.

Declaration
public ComboBoxBuilder DataSource(string[] dataSource)
Parameters
Type Name Description
System.String[] dataSource
Returns
Type Description
ComboBoxBuilder

Destroyed(String)

Triggers when the component is destroyed.

Declaration
public ComboBoxBuilder Destroyed(string destroyed)
Parameters
Type Name Description
System.String destroyed
Returns
Type Description
ComboBoxBuilder

Enabled(Boolean)

Specifies a value that indicates whether the component is enabled or not.

Declaration
public ComboBoxBuilder Enabled(bool enabled = true)
Parameters
Type Name Description
System.Boolean enabled
Returns
Type Description
ComboBoxBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads. If enabled, following list of states will be persisted.

  1. value
Declaration
public ComboBoxBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type Description
ComboBoxBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration
public ComboBoxBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type Description
ComboBoxBuilder

EnableVirtualization(Boolean)

Defines whether to enable virtual scrolling in the component.

Declaration
public ComboBoxBuilder EnableVirtualization(bool enableVirtualization = true)
Parameters
Type Name Description
System.Boolean enableVirtualization
Returns
Type Description
ComboBoxBuilder

Fields(ComboBoxFieldSettings)

The fields property maps the columns of the data table and binds the data to the component. 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 ComboBoxBuilder Fields(ComboBoxFieldSettings fields)
Parameters
Type Name Description
ComboBoxFieldSettings fields
Returns
Type Description
ComboBoxBuilder

Fields(Action<ComboBoxFieldSettingsBuilder>)

Declaration
public ComboBoxBuilder Fields(Action<ComboBoxFieldSettingsBuilder> fields)
Parameters
Type Name Description
System.Action<ComboBoxFieldSettingsBuilder> fields
Returns
Type Description
ComboBoxBuilder

Filtering(String)

Triggers on typing a character in the component.

For more details about the filtering refer to Filtering documentation.

Declaration
public ComboBoxBuilder Filtering(string filtering)
Parameters
Type Name Description
System.String filtering
Returns
Type Description
ComboBoxBuilder

FilterType(FilterType)

Determines on which filter type, the component needs to be considered on search action. The FilterType and its supported data types are

Declaration
public ComboBoxBuilder FilterType(FilterType filterType)
Parameters
Type Name Description
FilterType filterType
Returns
Type Description
ComboBoxBuilder

FloatLabelType(FloatLabelType)

Specifies whether to display the floating label above the input element. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.

Declaration
public ComboBoxBuilder FloatLabelType(FloatLabelType floatLabelType)
Parameters
Type Name Description
FloatLabelType floatLabelType
Returns
Type Description
ComboBoxBuilder

Focus(String)

Triggers when the component is focused.

Declaration
public ComboBoxBuilder Focus(string focus)
Parameters
Type Name Description
System.String focus
Returns
Type Description
ComboBoxBuilder

FooterTemplate(String)

Accepts the template design and assigns it to the footer container of the popup list.

For more details about the available template options refer to Template documentation.

Declaration
public ComboBoxBuilder FooterTemplate(string footerTemplate)
Parameters
Type Name Description
System.String footerTemplate
Returns
Type Description
ComboBoxBuilder

GroupTemplate(String)

Accepts the template design and assigns it to the group headers present in the popup list.

Declaration
public ComboBoxBuilder GroupTemplate(string groupTemplate)
Parameters
Type Name Description
System.String groupTemplate
Returns
Type Description
ComboBoxBuilder

HeaderTemplate(String)

Accepts the template design and assigns it to the header container of the popup list.

For more details about the available template options refer to Template documentation.

Declaration
public ComboBoxBuilder HeaderTemplate(string headerTemplate)
Parameters
Type Name Description
System.String headerTemplate
Returns
Type Description
ComboBoxBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
public ComboBoxBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
ComboBoxBuilder

IgnoreAccent(Boolean)

ignoreAccent set to true, then ignores the diacritic characters or accents when filtering.

Declaration
public ComboBoxBuilder IgnoreAccent(bool ignoreAccent = true)
Parameters
Type Name Description
System.Boolean ignoreAccent
Returns
Type Description
ComboBoxBuilder

IgnoreCase(Boolean)

When set to ‘false’, consider the case-sensitive on performing the search to find suggestions. By default consider the casing.

Declaration
public ComboBoxBuilder IgnoreCase(bool ignoreCase = true)
Parameters
Type Name Description
System.Boolean ignoreCase
Returns
Type Description
ComboBoxBuilder

Index(Double)

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

Declaration
public ComboBoxBuilder Index(double index)
Parameters
Type Name Description
System.Double index
Returns
Type Description
ComboBoxBuilder

ItemTemplate(String)

Accepts the template design and assigns it to each list item present in the popup. We have built-in template engine

Declaration
public ComboBoxBuilder ItemTemplate(string itemTemplate)
Parameters
Type Name Description
System.String itemTemplate
Returns
Type Description
ComboBoxBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public ComboBoxBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
ComboBoxBuilder

NoRecordsTemplate(String)

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

Declaration
public ComboBoxBuilder NoRecordsTemplate(string noRecordsTemplate)
Parameters
Type Name Description
System.String noRecordsTemplate
Returns
Type Description
ComboBoxBuilder

Open(String)

Triggers when the popup opens.

Declaration
public ComboBoxBuilder Open(string open)
Parameters
Type Name Description
System.String open
Returns
Type Description
ComboBoxBuilder

Placeholder(String)

Specifies a short hint that describes the expected value of the DropDownList component.

Declaration
public ComboBoxBuilder Placeholder(string placeholder)
Parameters
Type Name Description
System.String placeholder
Returns
Type Description
ComboBoxBuilder

PopupHeight(String)

Specifies the height of the popup list.

For more details about the popup configuration refer to Popup Configuration documentation.

Declaration
public ComboBoxBuilder PopupHeight(string popupHeight)
Parameters
Type Name Description
System.String popupHeight
Returns
Type Description
ComboBoxBuilder

PopupWidth(String)

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

For more details about the popup configuration refer to Popup Configuration documentation.

Declaration
public ComboBoxBuilder PopupWidth(string popupWidth)
Parameters
Type Name Description
System.String popupWidth
Returns
Type Description
ComboBoxBuilder

Query(String)

Accepts the external Query that execute along with data processing.

Declaration
public ComboBoxBuilder Query(string query)
Parameters
Type Name Description
System.String query
Returns
Type Description
ComboBoxBuilder

Readonly(Boolean)

Declaration
public ComboBoxBuilder Readonly(bool readOnly = true)
Parameters
Type Name Description
System.Boolean readOnly
Returns
Type Description
ComboBoxBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
Microsoft.AspNetCore.Html.HtmlString

Select(String)

Triggers when an item in the popup is selected by the user either with mouse/tap or with keyboard navigation.

Declaration
public ComboBoxBuilder Select(string select)
Parameters
Type Name Description
System.String select
Returns
Type Description
ComboBoxBuilder

ShowClearButton(Boolean)

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 ComboBoxBuilder ShowClearButton(bool showClearButton = true)
Parameters
Type Name Description
System.Boolean showClearButton
Returns
Type Description
ComboBoxBuilder

SortOrder(Object)

Specifies the sortOrder to sort the data source. The available type of sort orders are None - The data source is not sorting. Ascending - The data source is sorting with ascending order. Descending - The data source is sorting with descending order.

Declaration
public ComboBoxBuilder SortOrder(object sortOrder)
Parameters
Type Name Description
System.Object sortOrder
Returns
Type Description
ComboBoxBuilder

Text(String)

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

Declaration
public ComboBoxBuilder Text(string text)
Parameters
Type Name Description
System.String text
Returns
Type Description
ComboBoxBuilder

Value(Boolean)

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

Declaration
public ComboBoxBuilder Value(bool value = true)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
ComboBoxBuilder

Value(Double)

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

Declaration
public ComboBoxBuilder Value(double value)
Parameters
Type Name Description
System.Double value
Returns
Type Description
ComboBoxBuilder

Value(Object)

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

Declaration
public ComboBoxBuilder Value(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
ComboBoxBuilder

Value(String)

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

Declaration
public ComboBoxBuilder Value(string value)
Parameters
Type Name Description
System.String value
Returns
Type Description
ComboBoxBuilder

Width(String)

Specifies the width of the component. By default, the component width sets based on the width of its parent container. You can also set the width in pixel values.

Declaration
public ComboBoxBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
ComboBoxBuilder

ZIndex(Double)

specifies the z-index value of the component popup element.

Declaration
public ComboBoxBuilder ZIndex(double zIndex)
Parameters
Type Name Description
System.Double zIndex
Returns
Type Description
ComboBoxBuilder