Class ComboBox

Represents the ComboBox UI element.

Inheritance

System.Object

CommonDataBoundControl

ComboBox

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonDataBoundControl.PerformDataBinding(IEnumerable)

CommonDataBoundControl.RaisePostBackEvent(String)

CommonDataBoundControl.OnLoad(EventArgs)

CommonDataBoundControl.OnPreRender(EventArgs)

CommonDataBoundControl.RenderContents(HtmlTextWriter)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class ComboBox : CommonDataBoundControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

ComboBox()

Declaration

public ComboBox()

Properties

ActionFailureTemplate

Declaration

public string ActionFailureTemplate { get; set; }

Property Value

Type	Description
System.String

AllowCustom

Gets or sets a value indicating whether [allow custom].

Declaration

public bool AllowCustom { get; set; }

Property Value

Type	Description
System.Boolean	true if [allow custom]; otherwise, false.

AllowFiltering

Gets or sets a value indicating whether [allow filtering].

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	true if [allow filtering]; otherwise, false.

AutoFill

Gets or sets a value indicating whether [auto fill].

Declaration

public bool AutoFill { get; set; }

Property Value

Type	Description
System.Boolean	true if [auto fill]; otherwise, false.

ClientSideOnActionBegin

Occurs when the client side on action begin.

Declaration

public string ClientSideOnActionBegin { get; set; }

Property Value

Type	Description
System.String	The client side on action begin.

ClientSideOnActionComplete

Occurs when the client side on action complete.

Declaration

public string ClientSideOnActionComplete { get; set; }

Property Value

Type	Description
System.String	The client side on action complete.

ClientSideOnActionFailure

Occurs when the action failure.

Declaration

public string ClientSideOnActionFailure { get; set; }

Property Value

Type	Description
System.String	The action failure.

ClientSideOnBlur

Occurs blur in the ComboBox.

Declaration

public string ClientSideOnBlur { get; set; }

Property Value

Type	Description
System.String	The client side on blur.

ClientSideOnChange

Occurs when the list item checkbox value is changed.

Declaration

public string ClientSideOnChange { get; set; }

Property Value

Type	Description
System.String	The client side on change.

ClientSideOnClose

Occurs when the popup is closed.

Declaration

public string ClientSideOnClose { get; set; }

Property Value

Type	Description
System.String	The client side on close.

ClientSideOnCreate

Occurs when client side on create.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String	The client side on create.

ClientSideOnCustomValueSpecifier

Occurs custom Value Specified in the ComboBox.

Declaration

public string ClientSideOnCustomValueSpecifier { get; set; }

Property Value

Type	Description
System.String	The client side on customValueSpecifier.

ClientSideOnFiltering

Occurs before filtering the list items that starts in the ComboBox.

Declaration

public string ClientSideOnFiltering { get; set; }

Property Value

Type	Description
System.String	The client side on filtering.

ClientSideOnFocus

Occurs focus in the ComboBox.

Declaration

public string ClientSideOnFocus { get; set; }

Property Value

Type	Description
System.String	The client side on focus.

ClientSideOnOpen

Occurs when the popup is opened.

Declaration

public string ClientSideOnOpen { get; set; }

Property Value

Type	Description
System.String	The client side on open.

ClientSideOnSelect

Occurs when the list of item is selected.

Declaration

public string ClientSideOnSelect { get; set; }

Property Value

Type	Description
System.String	The client side on select.

ComboBoxFields

Gets the drop down list fields.

Declaration

public ComboBoxFields ComboBoxFields { get; }

Property Value

Type	Description
ComboBoxFields	The drop down list fields.

CssClass

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The CSS class.

DataGroupByField

Gets or sets the data group by field.

Declaration

public string DataGroupByField { get; set; }

Property Value

Type	Description
System.String	The data group by field.

DataIconCSSField

Gets or sets the data sprite CSS field.

Declaration

public string DataIconCSSField { get; set; }

Property Value

Type	Description
System.String	The data sprite CSS field.

DataManager

Data Manager as Inner property, which help us to bind the data sources from data adaptors

Declaration

public DataSource DataManager { get; set; }

Property Value

Type	Description
DataSource

DataSource

Gets or sets the object from which the data-bound control retrieves its list of data items.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object	The data source.

DataSourceCachingMode

Gets or sets the data source caching mode.

Declaration

public DataSourceCachingMode DataSourceCachingMode { get; set; }

Property Value

Type	Description
DataSourceCachingMode	The data source caching mode.

DataTextField

Gets or sets the data text field.

Declaration

public string DataTextField { get; set; }

Property Value

Type	Description
System.String	The data text field.

DataValueField

Gets or sets the data value field.

Declaration

public string DataValueField { get; set; }

Property Value

Type	Description
System.String	The data value field.

Enabled

Gets or sets a value indicating whether the Web server control is enabled.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	true if enabled; otherwise, false.

EnableRTL

Gets or sets a value indicating whether [enable RTL].

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable RTL]; otherwise, false.

FooterTemplate

Gets or sets the footer template.

Declaration

public string FooterTemplate { get; set; }

Property Value

Type	Description
System.String	The footer template.

GroupTemplate

Gets or sets the grouptemplate.

Declaration

public string GroupTemplate { get; set; }

Property Value

Type	Description
System.String	The group template.

HeaderTemplate

Gets or sets the header template.

Declaration

public string HeaderTemplate { get; set; }

Property Value

Type	Description
System.String	The header template.

HtmlAttributes

Declaration

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

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

Index

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

Declaration

public int? Index { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The items count.

ItemTemplate

Gets or sets the itemtemplate.

Declaration

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

public string Locale { get; set; }

Property Value

Type	Description
System.String	The Locale.

Model

Gets or sets the ComboBox property to its model.

Declaration

public ComboBoxProperties Model { get; set; }

Property Value

Type	Description
ComboBoxProperties	The model value

NoRecordsTemplate

Gets or sets the NoRecords Template.

Declaration

public string NoRecordsTemplate { get; set; }

Property Value

Type	Description
System.String	The NoRecordsTemplate.

Placeholder

Gets or sets the placeholder.

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
System.String	The placeholder.

PopupHeight

Gets or sets the height of the popup.

Declaration

public string PopupHeight { get; set; }

Property Value

Type	Description
System.String	The height of the popup.

PopupWidth

Gets or sets the width of the popup.

Declaration

public string PopupWidth { get; set; }

Property Value

Type	Description
System.String	The width of the popup.

Query

Gets or sets the query.

Declaration

public string Query { get; set; }

Property Value

Type	Description
System.String	The query.

ReadOnly

Gets or sets a value indicating whether [read only].

Declaration

public bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean	true if [read only]; otherwise, false.

ShowClearButton

Gets or sets a value indicating whether [show clear button].

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type	Description
System.Boolean	true if [show clear button]; otherwise, false.

SortOrder

Gets or sets the sort order.

Declaration

public SortOrder SortOrder { get; set; }

Property Value

Type	Description
SortOrder	The sort order.

Text

Gets or sets the text.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The text.

Value

Gets or sets the value.

Declaration

public object Value { get; set; }

Property Value

Type	Description
System.Object	The value.

ValueTemplate

Gets or sets the valuetemplate.

Declaration

public string ValueTemplate { get; set; }

Property Value

Type	Description
System.String	The value template.

Width

Gets or sets the width of the Web server control.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The width.

Methods

DependentScripts()

Represents the dependent scripts for ComboBox control.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	This method returns the list of dependent script files which is of type string

FetchData(IEnumerable)

Declaration

public override void FetchData(IEnumerable data)

Parameters

Type	Name	Description
System.Collections.IEnumerable	data

Overrides

CommonDataBoundControl.FetchData(IEnumerable)

GetDependentFiles()

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>

Overrides

CommonDataBoundControl.GetDependentFiles()

LoadViewState(Object)

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state

Overrides

CommonDataBoundControl.LoadViewState(Object)

PostBackEventHandler(String, Dictionary<String, Object>)

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonDataBoundControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Declaration

public string Render()

Returns

Type	Description
System.String

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonDataBoundControl.Render(HtmlTextWriter)

SaveViewState()

Declaration

protected override object SaveViewState()

Returns

Type	Description
System.Object

UpdateServerModel(Dictionary<String, Object>)

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonDataBoundControl.UpdateServerModel(Dictionary<String, Object>)

Events

ValueSelect

Occurs when [value select].

Declaration

public event ComboBox.ComboBoxEventHandler ValueSelect

Event Type

Type	Description
ComboBox.ComboBoxEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

See Also

CommonDataBoundControl