Class ListBoxProperties

Inheritance
System.Object
EJTagHelper
ListBoxProperties
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 ListBoxProperties : EJTagHelper

Constructors

ListBoxProperties()

Declaration
public ListBoxProperties()

Properties

ActionBegin

Triggers before the AJAX request begins to load data in the ListBox widget.

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

ActionComplete

Triggers when the AJAX requests complete. The request may get failed or succeed.

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

ActionFailure

Triggers when the data requested from AJAX get failed.

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

ActionSuccess

Triggers after the data requested via AJAX is successfully loaded in the ListBox widget.

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

AllowDrag

Enables/disables the dragging behavior of the items in ListBox widget.

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

AllowDragAndDrop

Enables/disables the drag and drop behavior of the ListBox widget.

Declaration
[JsonProperty("allowDragAndDrop")]
[Obsolete("The allowDragAndDrop property has been deprecated.Use AllowDrag and AllowDrop property instead of allowDragAndDrop")]
public bool AllowDragAndDrop { get; set; }
Property Value
Type Description
System.Boolean

AllowDrop

Accepts the items which are dropped in to it, when it is set to true.

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

AllowMultiSelection

Enables or disables multiple selection.

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

AllowVirtualScrolling

Loads 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

Cascade

Triggers when the cascade action performs in listbox.

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

CascadeTo

Dynamically populate data of a list box while selecting an item in another list box i.e. rendering child list box based on the item selection in parent list box. This property accepts the id of the child ListBox widget to populate the data.

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

CaseSensitiveSearch

Enables or disables the case sensitive search for list item by typing the text (search) value.

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

Change

Triggers when the item selection is changed.

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

CheckAll

To check all the items of the ListBox widget. It works only when the showCheckbox property is set to true.

Declaration
[JsonProperty("checkAll")]
[Obsolete("The CheckAll property has been deprecated.Use 'checkAll' method instead of CheckAll property")]
public bool CheckAll { get; set; }
Property Value
Type Description
System.Boolean

CheckChange

Triggers when the list item is checked or unchecked.

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

CheckedIndices

Set of list items to be checked by default using its index. It works only when the showCheckbox property is set to true.

Declaration
[JsonProperty("checkedIndices")]
public List<int> CheckedIndices { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Int32>

CheckedItemList

List of items to be checked by default using its index. It works only when the showCheckbox property is set to true.

Declaration
[JsonProperty("checkedItemlist")]
[Obsolete("The CheckedItemlist property has been deprecated.Use 'checkedIndices' instead of CheckedItemlist")]
public List<int> CheckedItemList { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Int32>

CheckedItems

List of items to be checked by default using its index. It works only when the showCheckbox property is set to true.

Declaration
[Obsolete("The checkedItems property has been deprecated.Use checkedIndices instead of checkedItems")]
[JsonProperty("checkedItems")]
public List<int> CheckedItems { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Int32>

CheckItemsByIndex

List of items to be checked by default using index values. It works only when the showCheckbox property is set to true.

Declaration
[JsonProperty("checkItemsByIndex")]
[Obsolete("The checkItemsByIndex property has been deprecated.Use checkedIndices instead of checkItemsByIndex")]
public string CheckItemsByIndex { get; set; }
Property Value
Type Description
System.String

Create

Triggers when the ListBox widget is created successfully.

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

CssClass

The root class for the ListBox widget to customize the existing theme.

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

DataSource

Contains the list of data for generating the list items.

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

Destroy

Triggers when the ListBox widget is destroyed successfully.

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

DisableItemsByIndex

Disables set of list items using its index value.

Declaration
[Obsolete("The disableItemsByIndex property has been deprecated and have been modified as methods")]
[JsonProperty("disableItemsByIndex")]
public string DisableItemsByIndex { get; set; }
Property Value
Type Description
System.String

EmptyDataText

To get or set value for EmptyDataText property.

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

Enabled

Enables or disables the ListBox widget.

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

EnableIncrementalSearch

Enables or disables the search behavior to find the specific list item by typing the text value.

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

EnableItemsByIndex

Enables the set of disabled list items using its index value.

Declaration
[JsonProperty("enableItemsByIndex")]
[Obsolete("The enableItemsByIndex property has been deprecated and have been modified as methods")]
public string EnableItemsByIndex { get; set; }
Property Value
Type Description
System.String

EnableLoadOnDemand

Loads data on demand for the ListBox widget via scrolling behavior.If this is set to true, this will implicitly make allowVirtualScrolling to true and sets virtualScrollMode to “normal”.

Declaration
[JsonProperty("enableLoadOnDemand")]
[Obsolete("The enableLoadOnDemand property has been deprecated.Use AllowVirtualScrolling instead of enableLoadOnDemand")]
public bool EnableLoadOnDemand { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true.

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

EnableRTL

Displays the ListBox widget’s content from right to left when enabled.

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

EnableVirtualScrolling

Loads data on demand for the ListBox widget via scrolling behavior. If this is set to true, this will implicitly make allowVirtualScrolling to true and sets virtualScrollMode to “continuous”.

Declaration
[JsonProperty("enableVirtualScrolling")]
[Obsolete("The enableVirtualScrolling property has deprecated, Use 'VirtualScrollMode=VirtualScrollMode.Normal' instead of enableVirtualScrolling")]
public bool EnableVirtualScrolling { get; set; }
Property Value
Type Description
System.Boolean

EnableWordWrap

Disables wordwrap the specified to the text value.

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

Height

Defines the height of the ListBox widget.

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

HtmlAttributes

Mapping Field for HtmlAttribute property.

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

IsFor

To get or set value for IsFor property.

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

ItemDrag

Triggers when the list item is being dragged.

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

ItemDragStart

Triggers when the list item is ready to be dragged.

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

ItemDragStop

Triggers when the list item stops dragging.

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

ItemDrop

Triggers when the list item is dropped.

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

ItemDropped

Triggers when the list item is dropped.

Declaration
[Obsolete("The itemDropped property has been deprecated.Use itemDrop instead of itemDropped")]
[JsonProperty("itemDropped")]
public string ItemDropped { get; set; }
Property Value
Type Description
System.String

ItemHeight

Defines the itemHeight of the ListBox widget.

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

ItemRequest

Triggers when scrolling action (virtual scrolling) requests for new set of list items to be loaded in the ListBox widget.

Declaration
[JsonProperty("itemRequest")]
[Obsolete("The ItemRequest property has been deprecated.Use ItemRequestCount instead of ItemRequest ")]
public string ItemRequest { get; set; }
Property Value
Type Description
System.String

ItemRequestCount

The number of list items to be loaded in the list box while enabling virtual scrolling and when virtualScrollMode is set to continuous.

Declaration
[JsonProperty("itemRequestCount")]
public int ItemRequestCount { get; set; }
Property Value
Type Description
System.Int32

ItemsCount

The number of list items to be shown in the ListBox widget. The remaining list items will be scrollable.

Declaration
[JsonProperty("itemsCount")]
public int ItemsCount { get; set; }
Property Value
Type Description
System.Int32

ListBoxFields

Mapping fields for the data items of the ListBox widget.

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

LoadDataOnInit

Loads data for the listbox by default (i.e. on initialization) when it is set to true. It creates empty ListBox if it is set to false.

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

Query

The query to retrieve required data from the data source.

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

Select

Triggers when a list item gets selected.

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

Selected

Triggers when a list item gets selected.

Declaration
[JsonProperty("selected")]
[Obsolete("The Selected property has been deprecated.Use Select instead of Selected")]
public string Selected { get; set; }
Property Value
Type Description
System.String

SelectedIndex

The list item to be selected by default using its index.

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

SelectedIndices

The list items to be selected by default using its indices. To use this property allowMultiSelection should be enabled.

Declaration
[JsonProperty("selectedIndices")]
public List<int> SelectedIndices { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Int32>

SelectedItemIndex

The item to be selected by default using its index.

Declaration
[JsonProperty("selectedItemIndex")]
[Obsolete("The selectedItemIndex property has been deprecated.Use selectedIndex instead of selectedItemIndex ")]
public int? SelectedItemIndex { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SelectedItemlist

The list of items to be selected by default using its index values. To use this property allowMultiSelection should be enabled.

Declaration
[JsonProperty("selectedItemlist")]
[Obsolete("The selectedItemlist property has been deprecated.Use selectedIndices instead of selectedItemlist")]
public List<int> SelectedItemlist { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Int32>

SelectedItems

The list of items to be selected by default using its index. To use this property allowMultiSelection should be enabled.

Declaration
[JsonProperty("selectedItems")]
[Obsolete("The selectedItems property has been deprecated.Use selectedIndices instead of selectedItems ")]
public List<int> SelectedItems { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Int32>

SelectIndexChanged

Triggers when the item selection is changed.

Declaration
[JsonProperty("selectIndexChanged")]
[Obsolete("The selectIndexChanged property has been deprecated.Use change instead of selectIndexChanged")]
public string SelectIndexChanged { get; set; }
Property Value
Type Description
System.String

ShowCheckbox

Enables/Disables the multi selection option with the help of checkbox control.

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

ShowRoundedCorner

To display the ListBox container with rounded corners.

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

SortOrder

Enables or disables sorting in either ascending or Descending.

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

None

Tag

To get or set value for Tag property.

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

TargetID

Specifies the targetID for the listbox items.

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

Template

The template to display the ListBox widget with customized appearance.

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

Text

To get or set value for Text property.

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

TotalItemsCount

The total number of list items to be rendered in the ListBox widget.

Declaration
[JsonProperty("totalItemsCount")]
public int TotalItemsCount { get; set; }
Property Value
Type Description
System.Int32

UncheckAll

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

Declaration
[JsonProperty("uncheckAll")]
[Obsolete("The UncheckAll property has been deprecated.Use 'uncheckAll' method instead of UnCheckAll property")]
public bool UncheckAll { get; set; }
Property Value
Type Description
System.Boolean

UncheckItemsByIndex

Unchecks the list of items by using its index values. It is dependent on showCheckbox property.

Declaration
[JsonProperty("UncheckItemsByIndex")]
[Obsolete("The UncheckItemsByIndex property has been deprecated.Use 'uncheckItemByIndex' method instead of UncheckItemsByIndex property")]
public string UncheckItemsByIndex { get; set; }
Property Value
Type Description
System.String

Unselect

Triggers when a list item gets unselected.

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

Value

Holds the selected items values and used to bind value to the list item using angular and knockout.

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

VirtualScrollMode

Specifies the virtual scroll mode to load the list data on demand via scrolling behavior. There are two types of mode.

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

Width

Defines the width of the ListBox widget.

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

Methods

GetControlDetails()

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

ShouldSerializeDataSource()

ShouldSerialize method for DataSource.

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

ShouldSerializeListBoxFields()

ShouldSerialize method for ListBoxFields.

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

ShouldSerializeMultiSelectedItemsIndex()

ShouldSerialize method for MultiSelectedItemsIndex.

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