Class ListViewProperties
Represents a class for ListViewProperties which includes height, width, header title, data source, query, and scrollbar properties.
Inherited Members
Namespace: Syncfusion.JavaScript.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class ListViewProperties : PropertiesBase
Constructors
ListViewProperties()
Initializes a new instance of the ListViewProperties class.
Declaration
public ListViewProperties()
Properties
AdjustFixedPosition
Specifies whether need to adjust the scrolling content height for fixed position elements with the height of the control, when scrolling is allowed.
Declaration
[JsonProperty("adjustFixedPosition")]
public bool AdjustFixedPosition { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
AjaxBeforeLoad
Event triggers before the ajax request happens.
Declaration
[JsonProperty("ajaxBeforeLoad")]
public string AjaxBeforeLoad { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
AjaxComplete
Event triggers after the ajax content loaded completely.
Declaration
[JsonProperty("ajaxComplete")]
public string AjaxComplete { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
AjaxError
Event triggers when the ajax request failed.
Declaration
[JsonProperty("ajaxError")]
public string AjaxError { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
AjaxSettings
Specifies the ajax settings option for its request
Declaration
[JsonProperty("ajaxSettings")]
public object AjaxSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Object |
AjaxSuccess
Event triggers after the ajax content loaded successfully.
Declaration
[JsonProperty("ajaxSuccess")]
public string AjaxSuccess { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
AllowScrolling
Specifies whether to allow scrolling behaviour for the contents, when the content exceeds visible region of the page.
Declaration
[JsonProperty("allowScrolling")]
public bool AllowScrolling { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
AllowVirtualScrolling
Specifies whether to enable virtual scrolling for listview.
Declaration
[JsonProperty("allowVirtualScrolling")]
public bool AllowVirtualScrolling { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
AutoAdjustHeight
Specifies whether to set the height as window height automatically.
Declaration
[JsonProperty("autoAdjustHeight")]
public bool AutoAdjustHeight { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
AutoAdjustScrollHeight
Specifies whether to set the height as scroll height of the content automatically.
Declaration
[JsonProperty("autoAdjustScrollHeight")]
public bool AutoAdjustScrollHeight { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
CheckDomChanges
Specifies whether need to refresh scrollpanel rendered in the control when elements are added dynamically.
Declaration
[JsonProperty("checkDomChanges")]
public bool CheckDomChanges { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
CheckedIndices
Contains the list of checked items index.
Declaration
[JsonProperty("checkedIndices")]
[HtmlAttributeName("checkedIndices")]
public List<int> CheckedIndices { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.Int32> |
ContentTemplate
To get or set value for ContentTemplate property.
Declaration
[JsonIgnore]
public MvcTemplate<ListViewProperties> ContentTemplate { get; set; }
Property Value
| Type | Description |
|---|---|
| MvcTemplate<ListViewProperties> |
DataSource
Contains the list of data for generating the ListView items.
Declaration
[JsonProperty("dataSource")]
[HtmlAttributeName("datasource")]
[JsonConverter(typeof(DataManagerConverter))]
public object DataSource { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Object |
EmptyDataText
Specifies the Error Message while list appears without data source.
Declaration
public string EmptyDataText { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
EnableAjax
Specifies whether to load ajax content while selecting item.
Declaration
[JsonProperty("enableAjax")]
public bool EnableAjax { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
EnableCache
Specifies whether to enable caching the content
Declaration
[JsonProperty("enableCache")]
public bool EnableCache { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
EnableCheckMark
Specifies whether to enable check mark for the corresponding item,which one we are target by index.
Declaration
[JsonProperty("enableCheckMark")]
public bool EnableCheckMark { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
EnableFiltering
Specifies whether to enable the filtering feature for the list item.
Declaration
[JsonProperty("enableFiltering")]
public bool EnableFiltering { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
EnableGroupList
Allows to group the list item, when it is set to true.
Declaration
[JsonProperty("enableGroupList")]
public bool EnableGroupList { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
EnablePersistence
Saves the current model value to the browser cookies for maintaining states. On refreshing, the Autocomplete control page retains the model value applied from browser cookies.
Declaration
[JsonProperty("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Fieldsettings
Specifies the field settings to map the datasource.
Declaration
[JsonProperty("fieldSettings")]
public ListViewFields Fieldsettings { get; set; }
Property Value
| Type | Description |
|---|---|
| ListViewFields |
Groups
Specifies the ListView Groups.
Declaration
[JsonIgnore]
public List<ListViewGroupItem> Groups { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<ListViewGroupItem> |
HeaderBackButtonTap
Event triggers when touch end happens on the back button in the header.
Declaration
[JsonProperty("headerBackButtonTap")]
public string HeaderBackButtonTap { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
HeaderBackButtonText
Specifies the text of the back button in the header.
Declaration
[JsonProperty("headerBackButtonText")]
public string HeaderBackButtonText { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
HeaderTitle
Specifies the title of the header.
Declaration
[JsonProperty("headerTitle")]
public string HeaderTitle { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Height
Gets or sets the height in integer.
Declaration
[JsonProperty("height")]
public int? Height { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
HideHeaderForUnSupportedDevice
Specifies whether to hide the header for unsupported device, when is set to true.
Declaration
[JsonProperty("hideHeaderForUnSupportedDevice")]
public bool HideHeaderForUnSupportedDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
ItemRequestCount
Gets or sets the itemRequestCount in integer.
Declaration
[JsonProperty("itemRequestCount")]
public int ItemRequestCount { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
Items
Specifies the ListView Items.
Declaration
[HtmlAttributeName("items")]
[JsonIgnore]
public List<ListViewItem> Items { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<ListViewItem> |
Load
Event triggers before the items loaded.
Declaration
[JsonProperty("load")]
public string Load { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
LoadComplete
Event triggers after the items loaded
Declaration
[JsonProperty("loadComplete")]
public string LoadComplete { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Locale
Defines the localization culture for the ListView.
Declaration
[JsonProperty("locale")]
public string Locale { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
MouseDown
Event triggers when mousekey down or keypressing event happens on the item.
Declaration
[JsonProperty("mouseDown")]
public string MouseDown { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
MouseUp
Event triggers when mousekey release or keyup event happens on the item.
Declaration
[JsonProperty("mouseUp")]
public string MouseUp { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
PersistSelection
Specifies whether to retain state for selected item.
Declaration
[JsonProperty("persistSelection")]
public bool PersistSelection { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
PreventSelection
Specifies whether to prevent the selection of the item.
Declaration
[JsonProperty("preventSelection")]
public bool PreventSelection { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Query
Specifies the query to execute with the datasource.
Declaration
[JsonProperty("query")]
[JsonConverter(typeof(QueryConverter))]
public string Query { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Ready
Event triggers when oncontent created happens on the item.
Declaration
[JsonProperty("ready")]
public string Ready { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
RenderTemplate
Specifies whether need to render the control with the template contents.
Declaration
[JsonProperty("renderTemplate")]
public bool RenderTemplate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
SelectedItemIndex
Specifies the index of item which need to be in selected state while loading.
Declaration
[JsonProperty("selectedItemIndex")]
public int SelectedItemIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
ShowHeader
Specifies whether to show the header.
Declaration
[JsonProperty("showHeader")]
public bool ShowHeader { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
ShowHeaderBackButton
Specifies whether to show the back button in the header.
Declaration
[JsonProperty("showHeaderBackButton")]
public bool ShowHeaderBackButton { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
ShowScrollbars
Specifies whether need to show the scroll bars when content exceeds the page height/width,when scrolling is allowed.
Declaration
[JsonProperty("showScrollbars")]
public bool ShowScrollbars { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
TemplateId
Specifies ID of the element contains template contents.
Declaration
[JsonProperty("templateId")]
public string TemplateId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
TotalItemsCount
Gets or sets the totalItemsCount in integer.
Declaration
[JsonProperty("totalItemsCount")]
public int? TotalItemsCount { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Transition
Specifies the transition effect while navigation happens.
Declaration
[JsonProperty("transition")]
public string Transition { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
VirtualScrollMode
Specifies types of virtual mode for listview.
Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("virtualScrollMode")]
public VirtualScrollMode VirtualScrollMode { get; set; }
Property Value
| Type | Description |
|---|---|
| VirtualScrollMode |
Width
Gets or sets the Width in integer.
Declaration
[JsonProperty("width")]
public int? Width { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Methods
GetControlDetails()
Declaration
protected override object GetControlDetails()
Returns
| Type | Description |
|---|---|
| System.Object |