Class ComboBoxProperties

Class ComboBoxProperties.

Inheritance
System.Object
EJTagHelper
ComboBoxProperties
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.JavaScript.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class ComboBoxProperties : EJTagHelper

Constructors

ComboBoxProperties()

Declaration
public ComboBoxProperties()

Properties

ActionBegin

Occurs the action before the XHR request.

Declaration
[JsonProperty("actionBegin")]
public string ActionBegin { get; set; }
Property Value
Type Description
System.String

The action begin.

ActionComplete

Occurs the action when the list of items is bound to the ComboBox by xhr post calling.

Declaration
[JsonProperty("actionComplete")]
public string ActionComplete { get; set; }
Property Value
Type Description
System.String

The action complete.

ActionFailure

Occurs the action when the xhr post calling failed on remote data binding with the ComboBox control.

Declaration
[JsonProperty("actionFailure")]
public string ActionFailure { get; set; }
Property Value
Type Description
System.String

The action failure.

ActionFailureTemplate

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

Declaration
[JsonProperty("actionFailureTemplate")]
public string ActionFailureTemplate { get; set; }
Property Value
Type Description
System.String

The header template.

AllowCustom

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

Declaration
[JsonProperty("allowCustom")]
public bool AllowCustom { get; set; }
Property Value
Type Description
System.Boolean

AllowFiltering

When set to true, enables the filtering option of component. On typing a character into a search box, the filter action retrieves the matched items through the filtering event. If no matches found, then the value of noRecordsTemplate property will be shown.

Declaration
[JsonProperty("allowFiltering")]
public bool AllowFiltering { get; set; }
Property Value
Type Description
System.Boolean

The AllowFiltering.

AutoFill

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

Declaration
[JsonProperty("autofill")]
public bool AutoFill { get; set; }
Property Value
Type Description
System.Boolean

The AutoFill.

Blur

Occurs ComboBox blur.

Declaration
[JsonProperty("blur")]
public string Blur { get; set; }
Property Value
Type Description
System.String

The filtering.

Change

Occurs when the ComboBox control’s value is changed.

Declaration
[JsonProperty("change")]
public string Change { get; set; }
Property Value
Type Description
System.String

The change.

Close

Occurs when the popup is closed.

Declaration
[JsonProperty("close")]
public string Close { get; set; }
Property Value
Type Description
System.String

The popup close.

ComboBoxFields

Gets or sets the mapping fields for the data items of the ComboBox.

Declaration
[HtmlAttributeName("fields")]
[JsonProperty("fields")]
public ComboBoxFields ComboBoxFields { get; set; }
Property Value
Type Description
ComboBoxFields

The ComboBoxFields.

Create

Occurs the action once the ComboBox is created.

Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
Type Description
System.String

The create.

CssClass

Gets or sets the combobox widget’s style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the combobox by using the cssClass property. You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied.

Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
Type Description
System.String

The css class.

CustomValueSpecifier

Occurs Custom Value Specified in combobox.

Declaration
[JsonProperty("customValueSpecifier")]
public string CustomValueSpecifier { get; set; }
Property Value
Type Description
System.String

The filtering.

DataSource

Gets or sets to serve data from the data services based on the query provided. To bind the data to the combobox widget, the dataSource property is assigned with the instance of the ej.DataManager.

Declaration
[HtmlAttributeName("datasource")]
[JsonProperty("dataSource")]
[JsonConverter(typeof(DataManagerConverter))]
public object DataSource { get; set; }
Property Value
Type Description
System.Object

The enableSorting.

Enabled

Gets or sets the enabled.

Declaration
[JsonProperty("enabled")]
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

The enabled.

EnableRTL

Gets or sets the ComboBox textbox direction from right to left align.

Declaration
[JsonProperty("enableRtl")]
public bool EnableRTL { get; set; }
Property Value
Type Description
System.Boolean

The enable RTL.

Filtering

Occurs before filtering the list items that starts in the ComboBox when the enableFilterSearch is enabled.

Declaration
[JsonProperty("filtering")]
public string Filtering { get; set; }
Property Value
Type Description
System.String

The filtering.

Focus

Occurs combobox focus.

Declaration
[JsonProperty("focus")]
public string Focus { get; set; }
Property Value
Type Description
System.String

The focus.

FooterTemplate

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

Declaration
[JsonProperty("footerTemplate")]
public string FooterTemplate { get; set; }
Property Value
Type Description
System.String

The footer template.

GroupTemplate

Accepts the template design and assign it to each list item of component.

Declaration
[JsonProperty("groupTemplate")]
public string GroupTemplate { get; set; }
Property Value
Type Description
System.String

The group template.

HeaderTemplate

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

Declaration
[JsonProperty("headerTemplate")]
public string HeaderTemplate { get; set; }
Property Value
Type Description
System.String

The header template.

HtmlAttributes

Gets or sets the given HTML attributes for the ComboBox control such as ID, name, disabled, etc.

Declaration
[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

The html attributes.

Index

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

Declaration
[JsonProperty("index")]
public int? Index { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

The index.

IsFor

Gets or sets isFor.

Declaration
[JsonIgnore]
public bool IsFor { get; set; }
Property Value
Type Description
System.Boolean

The isFor.

ItemTemplate

Accepts the template design and assign it to each list item of component.

Declaration
[JsonProperty("itemTemplate")]
public string ItemTemplate { get; set; }
Property Value
Type Description
System.String

The item template.

Locale

Gets or sets the different culture can be given locale property, Text present in comboBox will be localized to respective culture.

Declaration
[JsonProperty("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

The locale.

NoRecordsTemplate

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

Declaration
[JsonProperty("noRecordsTemplate")]
public string NoRecordsTemplate { get; set; }
Property Value
Type Description
System.String

The No Record template.

Open

Occurs when the popup is opened.

Declaration
[JsonProperty("open")]
public string Open { get; set; }
Property Value
Type Description
System.String

The popup shown.

Placeholder

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

Declaration
[JsonProperty("placeholder")]
public string Placeholder { get; set; }
Property Value
Type Description
System.String

The placeholder.

PopupHeight

Gets or sets the height of the suggestion popup box in the ComboBox control.

Declaration
[JsonProperty("popupHeight")]
public string PopupHeight { get; set; }
Property Value
Type Description
System.String

The popup height.

PopupWidth

Gets or sets the width of the suggestion popup box in the ComboBox control.

Declaration
[JsonProperty("popupWidth")]
public string PopupWidth { get; set; }
Property Value
Type Description
System.String

The popup width.

Query

Gets or sets the query to retrieve the data from the DataSource.

Declaration
[JsonConverter(typeof(QueryConverter))]
[JsonProperty("query")]
public string Query { get; set; }
Property Value
Type Description
System.String

The query.

ReadOnly

Gets or sets that the ComboBox textbox values should be read-only.

Declaration
[JsonProperty("readonly")]
public bool ReadOnly { get; set; }
Property Value
Type Description
System.Boolean

The readOnly.

Select

Occurs when the list of item is selected.

Declaration
[JsonProperty("select")]
public string Select { get; set; }
Property Value
Type Description
System.String

The select.

ShowClearButton

Specifies whether show or hide the clear button for the component value, text and index properties are reset as null on clicking clear button.

Declaration
[JsonProperty("showClearButton")]
public bool ShowClearButton { get; set; }
Property Value
Type Description
System.Boolean

SortOrder

Gets or sets the sort order.

Declaration
[JsonProperty("sortOrder")]
[JsonConverter(typeof(StringEnumConverter))]
public SortOrder SortOrder { get; set; }
Property Value
Type Description
SortOrder

The sort order.

Tag

Gets or sets the tag.

Declaration
[JsonIgnore]
public string Tag { get; set; }
Property Value
Type Description
System.String

The tag.

Text

Gets or sets the text value that is displayed in the ComboBox textbox.

Declaration
[JsonProperty("text")]
public string Text { get; set; }
Property Value
Type Description
System.String

The text.

Value

Gets or sets the value (text content) for the ComboBox control.

Declaration
[JsonProperty("value")]
public object Value { get; set; }
Property Value
Type Description
System.Object

ValueTemplate

Accepts the template design and assign it to the selected list item to an input element of component.

Declaration
[JsonProperty("valueTemplate")]
public string ValueTemplate { get; set; }
Property Value
Type Description
System.String

The value template.

Width

Gets or sets the width of the ComboBox textbox.

Declaration
[JsonProperty("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

The height.

Methods

GetControlDetails()

Declaration
protected override object GetControlDetails()
Returns
Type Description
System.Object
Overrides

ShouldSerializeComboBoxFields()

ShouldSerialize Method for ComboBoxFields

Declaration
public bool ShouldSerializeComboBoxFields()
Returns
Type Description
System.Boolean

ShouldSerializeDataSource()

ShouldSerialize Method for DataSource

Declaration
public bool ShouldSerializeDataSource()
Returns
Type Description
System.Boolean