Class DropDownListProperties

Class DropDownListProperties.

Inheritance

System.Object

EJTagHelper

DropDownListProperties

Inherited Members

EJTagHelper.GetControlDetails(String)

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 DropDownListProperties : EJTagHelper

Constructors

DropDownListProperties()

Declaration

public DropDownListProperties()

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 DropDownList 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 DropDownList control.

Declaration

[JsonProperty("actionFailure")]
public string ActionFailure { get; set; }

Property Value

Type	Description
System.String	The action failure.

ActionSuccess

Occurs the action when the xhr post calling succeed on remote data binding with the DropDownList control.

Declaration

[JsonProperty("actionSuccess")]
public string ActionSuccess { get; set; }

Property Value

Type	Description
System.String	The action success.

AllowGrouping

AllowGrouping has been deprecated, binding GroupBy field will automatically enable grouping

Declaration

[JsonProperty("allowGrouping")]
[Obsolete("AllowGrouping has been deprecated, binding GroupBy field will automatically enable grouping ")]
public bool AllowGrouping { get; set; }

Property Value

Type	Description
System.Boolean

AllowVirtualScrolling

Gets or sets the list data on demand via scrolling behavior to improve the applicationâ€™s performance. There are two ways to load data which can be defined using â€œvirtualScrollModeâ€ property.

Declaration

[JsonProperty("allowVirtualScrolling")]
public bool AllowVirtualScrolling { get; set; }

Property Value

Type	Description
System.Boolean	The allowVirtualScrolling.

BeforePopupHide

Occurs before the popup is ready to hide.

Declaration

[JsonProperty("beforePopupHide")]
public string BeforePopupHide { get; set; }

Property Value

Type	Description
System.String	The before popup hide.

BeforePopupShown

Occurs before the popup is ready to be displayed.

Declaration

[JsonProperty("beforePopupShown")]
public string BeforePopupShown { get; set; }

Property Value

Type	Description
System.String	The before popup shown.

Cascade

Occurs when the cascading happens between two DropDownList exactly after the value changes in the first dropdown and before filtering in the second Dropdown.

Declaration

[JsonProperty("cascade")]
public string Cascade { get; set; }

Property Value

Type	Description
System.String	The cascade.

CascadeTo

Gets or sets the cascading DropDownLists is a series of two or more DropDownLists in which each DropDownList is filtered according to the previous DropDownListâ€™s value.

Declaration

[JsonProperty("cascadeTo")]
public string CascadeTo { get; set; }

Property Value

Type	Description
System.String	The cascadeTo.

CaseSensitiveSearch

Gets or sets the case sensitivity of the search operation. It supports both enableFilterSearch and enableIncrementalSearch property.

Declaration

[JsonProperty("caseSensitiveSearch")]
public bool CaseSensitiveSearch { get; set; }

Property Value

Type	Description
System.Boolean	The caseSensitiveSearch.

Change

Occurs when the DropDownList controlâ€™s value is changed.

Declaration

[JsonProperty("change")]
public string Change { get; set; }

Property Value

Type	Description
System.String	The change.

CheckAll

Gets or sets the check all the items of the DropDownList widget. It works only when the showCheckbox property is set to true.

Declaration

[JsonProperty("checkAll")]
[Obsolete("CheckAll has been deprecated, use API method ")]
public bool CheckAll { get; set; }

Property Value

Type	Description
System.Boolean	The checkAll.

CheckChange

Occurs when the list item checkbox value is changed.

Declaration

[JsonProperty("checkChange")]
public string CheckChange { get; set; }

Property Value

Type	Description
System.String	The check change.

Create

Occurs the action once the DropDownList is created.

Declaration

[JsonProperty("create")]
public string Create { get; set; }

Property Value

Type	Description
System.String	The create.

CssClass

Gets or sets the dropdown widgetâ€™s style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the dropdown 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.

DataBound

Occurs when the list items is bound to the DropDownList.

Declaration

[JsonProperty("dataBound")]
[HtmlAttributeName("databound")]
public string DataBound { get; set; }

Property Value

Type	Description
System.String	The data bound.

DataSource

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

Declaration

[JsonProperty("dataSource")]
[HtmlAttributeName("datasource")]
[JsonConverter(typeof(DataManagerConverter))]
public object DataSource { get; set; }

Property Value

Type	Description
System.Object	The enableSorting.

DelimiterChar

Gets or sets the separator when the multiSelectMode with delimiter option or checkbox is enabled with the dropdown. When you enter the delimiter value, the texts after the delimiter are considered as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character.

Declaration

[JsonProperty("delimiterChar")]
public string DelimiterChar { get; set; }

Property Value

Type	Description
System.String	The delimiter char.

Destroy

Occurs the action when the DropDownList is destroyed.

Declaration

[JsonProperty("destroy")]
public string Destroy { get; set; }

Property Value

Type	Description
System.String	The destroy.

DisableItemsByIndex

Getsor sets the DisableItemsByIndex.

Declaration

[JsonProperty("disableItemsByIndex")]
[Obsolete("DisableItemsByIndex has been deprecated, use API method")]
public string DisableItemsByIndex { get; set; }

Property Value

Type	Description
System.String	The DisableItemsByIndex.

DropDownListFields

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

Declaration

[JsonProperty("fields")]
[HtmlAttributeName("fields")]
public DropDownListFields DropDownListFields { get; set; }

Property Value

Type	Description
DropDownListFields	The DropDownListFields.

EnableAnimation

Gets or sets the enabled Animation property uses the easeOutQuad animation to SlideDown and SlideUp the Popup list in 200 and 100 milliseconds, respectively.

Declaration

[JsonProperty("enableAnimation")]
public bool EnableAnimation { get; set; }

Property Value

Type	Description
System.Boolean	The enable animation.

Enabled

Gets or sets the enabled.

Declaration

[JsonProperty("enabled")]
public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	The enabled.

EnableFilterSearch

Gets or sets this property selects the item in the DropDownList when the item is entered in the Search textbox.

Declaration

[JsonProperty("enableFilterSearch")]
public bool EnableFilterSearch { get; set; }

Property Value

Type	Description
System.Boolean	The enableFilterSearch.

EnableIncrementalSearch

Gets or sets to perform incremental search for the selection of items from the DropDownList with the help of this property. This helps in selecting the item by using the typed character.

Declaration

[JsonProperty("enableIncrementalSearch")]
public bool EnableIncrementalSearch { get; set; }

Property Value

Type	Description
System.Boolean	The enableIncrementalSearch.

EnableItemsByIndex

Gets or sets the enableItemsByIndex.

Declaration

[JsonProperty("enableItemsByIndex")]
[Obsolete("EnableItemsByIndex has been deprecated, use API method ")]
public string EnableItemsByIndex { get; set; }

Property Value

Type	Description
System.String	The DisableItemsByIndex.

EnablePersistence

Gets or sets the enablePersistence.

Declaration

[JsonProperty("enablePersistence")]
public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The enablePersistence.

EnablePopupResize

Declaration

[JsonProperty("enablePopupResize")]
public bool EnablePopupResize { get; set; }

Property Value

Type	Description
System.Boolean	The enablePopupResize.

EnableRTL

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

Declaration

[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	The enable RTL.

EnableServerFiltering

Gets or sets this property selects the item in the DropDownList when the item is entered in the Search textbox.

Declaration

[JsonProperty("enableServerFiltering")]
public bool EnableServerFiltering { get; set; }

Property Value

Type	Description
System.Boolean	The enableServerFiltering.

EnableSorting

Gets or sets to sort the Items in the DropDownList. By default, it sorts the items in an ascending order.

Declaration

[JsonProperty("enableSorting")]
public bool EnableSorting { get; set; }

Property Value

Type	Description
System.Boolean	The enableSorting.

FilterType

Gets or sets the filterType.

Declaration

[JsonProperty("filterType")]
[JsonConverter(typeof(StringEnumConverter))]
public SearchFilterType FilterType { get; set; }

Property Value

Type	Description
SearchFilterType	The filterType.

FocusIn

Fires the action when the DropDownList is focused.

Declaration

[JsonProperty("focusIn")]
public string FocusIn { get; set; }

Property Value

Type	Description
System.String	The focusIn.

FocusOut

Fires the action when the DropDownList is about to lose focus.

Declaration

[JsonProperty("focusOut")]
public string FocusOut { get; set; }

Property Value

Type	Description
System.String	The focusOut.

HeaderTemplate

Gets or sets the header template.

Declaration

[JsonProperty("headerTemplate")]
public string HeaderTemplate { get; set; }

Property Value

Type	Description
System.String	The header template.

Height

Gets or sets the height of the DropDownList textbox.

Declaration

[JsonProperty("height")]
public string Height { get; set; }

Property Value

Type	Description
System.String	The height.

HtmlAttributes

Gets or sets the given HTML attributes for the DropDownList 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.

IsFor

Gets or sets isFor.

Declaration

[JsonIgnore]
public bool IsFor { get; set; }

Property Value

Type	Description
System.Boolean	The isFor.

ItemsCount

Gets or sets the Data can be fetched in the DropDownList control by using the DataSource, specifying the number of items.

Declaration

[JsonProperty("itemsCount")]
public int ItemsCount { get; set; }

Property Value

Type	Description
System.Int32	The items count.

ItemValue

Gets or sets the ItemValue of DropDownList control.

Declaration

[JsonProperty("itemValue")]
public string ItemValue { get; set; }

Property Value

Type	Description
System.String	The item value.

LoadOnDemand

Gets or sets to the Dropdownlist popup and list generation load on demand.

Declaration

[JsonProperty("loadOnDemand")]
public bool LoadOnDemand { get; set; }

Property Value

Type	Description
System.Boolean	The loadOnDemand.

Locale

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

Declaration

[JsonProperty("locale")]
public string Locale { get; set; }

Property Value

Type	Description
System.String	The locale.

MaxPopupHeight

Gets or sets the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled.

Declaration

[JsonProperty("maxPopupHeight")]
public string MaxPopupHeight { get; set; }

Property Value

Type	Description
System.String	The max popup height.

MaxPopupWidth

Gets or sets the maximum width of the suggestion box. This property restricts the maximum width of the popup when resize is enabled.

Declaration

[JsonProperty("maxPopupWidth")]
public string MaxPopupWidth { get; set; }

Property Value

Type	Description
System.String	The max popup width.

MinPopupHeight

Gets or sets the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled.

Declaration

[JsonProperty("minPopupHeight")]
public string MinPopupHeight { get; set; }

Property Value

Type	Description
System.String	The min popup height.

MinPopupWidth

Gets or sets the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled.

Declaration

[JsonProperty("minPopupWidth")]
public string MinPopupWidth { get; set; }

Property Value

Type	Description
System.String	The min popup width.

MultiSelectMode

Gets or sets the multi select mode.

Declaration

[JsonProperty("multiSelectMode")]
[JsonConverter(typeof(StringEnumConverter))]
public MultiSelectModeTypes MultiSelectMode { get; set; }

Property Value

Type	Description
MultiSelectModeTypes	The multi select mode.

PopupHeight

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

Declaration

[JsonProperty("popupHeight")]
public string PopupHeight { get; set; }

Property Value

Type	Description
System.String	The popup height.

PopupHide

Occurs when the popup is closed.

Declaration

[JsonProperty("popupHide")]
public string PopupHide { get; set; }

Property Value

Type	Description
System.String	The popup hide.

PopupResize

Occurs when the popup is resized.

Declaration

[JsonProperty("popupResize")]
public string PopupResize { get; set; }

Property Value

Type	Description
System.String	The popup resize.

PopupResizeStart

Occurs when resizing a popup starts.

Declaration

[JsonProperty("popupResizeStart")]
public string PopupResizeStart { get; set; }

Property Value

Type	Description
System.String	The popup resize start.

PopupResizeStop

Occurs when the popup resizing is stopped.

Declaration

[JsonProperty("popupResizeStop")]
public string PopupResizeStop { get; set; }

Property Value

Type	Description
System.String	The popup resize stop.

PopupShown

Occurs when the popup is opened.

Declaration

[JsonProperty("popupShown")]
public string PopupShown { get; set; }

Property Value

Type	Description
System.String	The popup shown.

PopupWidth

Gets or sets the width of the suggestion popup box in the DropDownList 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 DropDownList textbox values should be read-only.

Declaration

[JsonProperty("readOnly")]
public bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean	The readOnly.

Search

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

Declaration

[JsonProperty("search")]
public string Search { get; set; }

Property Value

Type	Description
System.String	The search.

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.

SelectedIndex

Gets or sets the item to be selected in the DropDownList.

Declaration

[JsonProperty("selectedIndex")]
public int SelectedIndex { get; set; }

Property Value

Type	Description
System.Int32	The SelectedIndex.

SelectedIndices

Gets or sets the selectedItems for the DropDownList.

Declaration

[JsonProperty("selectedIndices")]
public List<int> SelectedIndices { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>	The SelectedIndices.

SelectedItemIndex

Gets or sets the item to be selected by default using its index.

Declaration

[JsonProperty("selectedItemIndex")]
[Obsolete("SelectedItemIndex has been deprecated, use SelectedIndex property")]
public int SelectedItemIndex { get; set; }

Property Value

Type	Description
System.Int32	The SelectedItemIndex.

SelectedItems

Gets or sets the list of items to be selected by default using its index. To use this property allowMultiSelection should be enabled.

Declaration

[Obsolete("SelectedItems has been deprecated, use SelectedIndices property")]
public List<int> SelectedItems { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>	The SelectedItems.

ShowCheckbox

Gets or sets the show checkbox.

Declaration

[JsonProperty("showCheckbox")]
public bool ShowCheckbox { get; set; }

Property Value

Type	Description
System.Boolean	The showCheckbox.

ShowPopupOnLoad

Gets or sets the DropDownList control is displayed with the popup seen.

Declaration

[JsonProperty("showPopupOnLoad")]
public bool ShowPopupOnLoad { get; set; }

Property Value

Type	Description
System.Boolean	The show popup onload.

ShowRoundedCorner

Gets or sets the DropDownList textbox displayed with the rounded corner style.

Declaration

[JsonProperty("showRoundedCorner")]
public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean	The show rounded corner.

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.

TargetID

Gets or sets the targetID for the DropDownListâ€™s items.

Declaration

[JsonProperty("targetID")]
public string TargetID { get; set; }

Property Value

Type	Description
System.String	The target ID.

Template

Gets or sets the template.

Declaration

[JsonProperty("template")]
public string Template { get; set; }

Property Value

Type	Description
System.String	The template.

Text

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

Declaration

[JsonProperty("text")]
public string Text { get; set; }

Property Value

Type	Description
System.String	The text.

UncheckAll

Gets or sets the Unchecks all the checked list items. It is dependent on showCheckbox property.

Declaration

[JsonProperty("uncheckAll")]
[Obsolete("UncheckAll has been deprecated, use API method ")]
public bool UncheckAll { get; set; }

Property Value

Type	Description
System.Boolean	The uncheckAll.

ValidationMessage

Gets or sets the jQuery validation error message in the DropDownList.

Declaration

[JsonProperty("validationMessage")]
public Dictionary<string, object> ValidationMessage { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	The validation message.

ValidationRules

Gets or sets the jquery validation rules in the Dropdownlist.

Declaration

[JsonProperty("validationRules")]
public Dictionary<string, object> ValidationRules { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	The validation rules.

Value

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

Declaration

[JsonProperty("value")]
public string Value { get; set; }

Property Value

Type	Description
System.String

VirtualScrollMode

Gets or sets the Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an Ajax request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. You can set the itemsCount property that represents the number of items to be fetched from the server on every Ajax request.

Declaration

[JsonProperty("virtualScrollMode")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualScrollMode VirtualScrollMode { get; set; }

Property Value

Type	Description
VirtualScrollMode	The virtual scroll mode.

WatermarkText

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

Declaration

[JsonProperty("watermarkText")]
public string WatermarkText { get; set; }

Property Value

Type	Description
System.String	The watermarkText.

Width

Gets or sets the width of the DropDownList 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

EJTagHelper.GetControlDetails()

ShouldSerializeDataSource()

ShouldSerialize Method for DataSource

Declaration

public bool ShouldSerializeDataSource()

Returns

Type	Description
System.Boolean

ShouldSerializeDropDownListFields()

ShouldSerialize Method for DropDownListFields

Declaration

public bool ShouldSerializeDropDownListFields()

Returns

Type	Description
System.Boolean

ShouldSerializeMultiSelectedItemsIndex()

ShouldSerialize Method for MultiSelectedItemsIndex

Declaration

public bool ShouldSerializeMultiSelectedItemsIndex()

Returns

Type	Description
System.Boolean