Class ListViewPropertiesBuilder

Represents a class for ListViewPropertiesBuilder which includes height, width, header title, data source, query, and scrollbar properties.

Inheritance

System.Object

ListViewPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

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

Assembly: Syncfusion.EJ.dll

Syntax

public class ListViewPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

ListViewPropertiesBuilder(ListView)

Initializes a new instance of the ListViewPropertiesBuilder class.

Declaration

public ListViewPropertiesBuilder(ListView ListView)

Parameters

Type	Name	Description
ListView	ListView

Methods

AdjustFixedPosition(Boolean)

Specifies whether need to adjust the scrolling content height for fixed position elements with the height of the control, when scrolling is allowed.with boolean argument.

Declaration

public ListViewPropertiesBuilder AdjustFixedPosition(bool adjustFixedPosition)

Parameters

Type	Name	Description
System.Boolean	adjustFixedPosition

Returns

Type	Description
ListViewPropertiesBuilder

AjaxSettings(Action<jQueryAjaxOptionsBuilder>)

Specifies the settings option for ajax request.with array argument.

Declaration

public ListViewPropertiesBuilder AjaxSettings(Action<jQueryAjaxOptionsBuilder> ajaxSettings)

Parameters

Type	Name	Description
System.Action<jQueryAjaxOptionsBuilder>	ajaxSettings

Returns

Type	Description
ListViewPropertiesBuilder

AllowScrolling(Boolean)

Specifies whether to allow scrolling behaviour when the content height/width exceeds the browser window.with boolean argument.

Declaration

public ListViewPropertiesBuilder AllowScrolling(bool allowScrolling)

Parameters

Type	Name	Description
System.Boolean	allowScrolling

Returns

Type	Description
ListViewPropertiesBuilder

AllowVirtualScrolling(Boolean)

Specifies VirtualScrolling for ListView.

Declaration

public ListViewPropertiesBuilder AllowVirtualScrolling(bool allowVirtualScrolling)

Parameters

Type	Name	Description
System.Boolean	allowVirtualScrolling

Returns

Type	Description
ListViewPropertiesBuilder

AutoAdjustHeight(Boolean)

Specifies whether to set the height as window height automatically.with boolean argument.

Declaration

public ListViewPropertiesBuilder AutoAdjustHeight(bool autoAdjustHeight)

Parameters

Type	Name	Description
System.Boolean	autoAdjustHeight

Returns

Type	Description
ListViewPropertiesBuilder

AutoAdjustScrollHeight(Boolean)

Specifies whether to set the height as scroll height of the content automatically.with using boolean argument.

Declaration

public ListViewPropertiesBuilder AutoAdjustScrollHeight(bool autoAdjustScrollHeight)

Parameters

Type	Name	Description
System.Boolean	autoAdjustScrollHeight

Returns

Type	Description
ListViewPropertiesBuilder

CheckDomChanges(Boolean)

Specifies whether need to refresh scrollpanel rendered in the control when elements are added dynamically.with boolean argument.

Declaration

public ListViewPropertiesBuilder CheckDomChanges(bool checkDomChanges)

Parameters

Type	Name	Description
System.Boolean	checkDomChanges

Returns

Type	Description
ListViewPropertiesBuilder

CheckedIndices(List<Int32>)

Contains the list of checked ListView items.

Declaration

public ListViewPropertiesBuilder CheckedIndices(List<int> checkedIndices)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	checkedIndices

Returns

Type	Description
ListViewPropertiesBuilder

ClientSideEvents(Action<ListViewClientSideEventsBuilder>)

Specifies the ListView ClientSideEvents.

Declaration

public ListViewPropertiesBuilder ClientSideEvents(Action<ListViewClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<ListViewClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
ListViewPropertiesBuilder

ContentTemplate(Action<ListViewProperties>)

Specifies the ContentTemplate for webform.with array argument.

Declaration

public ListViewPropertiesBuilder ContentTemplate(Action<ListViewProperties> template)

Parameters

Type	Name	Description
System.Action<ListViewProperties>	template

Returns

Type	Description
ListViewPropertiesBuilder

ContentTemplate(Func<ListViewProperties, Object>)

Specifies the ContentTemplate for RazorView.with array argument.

Declaration

public ListViewPropertiesBuilder ContentTemplate(Func<ListViewProperties, object> template)

Parameters

Type	Name	Description
System.Func<ListViewProperties, System.Object>	template

Returns

Type	Description
ListViewPropertiesBuilder

CssClass(String)

Sets the root class for ListView theme. This will applies custom skinning option for ListView control.Before using this API, we need to include this root class in CSS.with string argument.

Declaration

public ListViewPropertiesBuilder CssClass(string CssClass)

Parameters

Type	Name	Description
System.String	CssClass

Returns

Type	Description
ListViewPropertiesBuilder

DataSource(DataSource)

Specifies the datasource is enabled.with object argument.

Declaration

public ListViewPropertiesBuilder DataSource(DataSource dataSource)

Parameters

Type	Name	Description
DataSource	dataSource

Returns

Type	Description
ListViewPropertiesBuilder

DataSource(Action<DataSourceBuilder>)

Specifies the datasource is enabled.with array argument.

Declaration

public ListViewPropertiesBuilder DataSource(Action<DataSourceBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataSourceBuilder>	dataSource

Returns

Type	Description
ListViewPropertiesBuilder

DataSource(IEnumerable)

Specifies the datasource is enabled.with IEnumerable argument.

Declaration

public ListViewPropertiesBuilder DataSource(IEnumerable dataSource)

Parameters

Type	Name	Description
System.Collections.IEnumerable	dataSource

Returns

Type	Description
ListViewPropertiesBuilder

EnableAjax(Boolean)

Specifies whether to load ajax content while selecting item.with boolean argument.

Declaration

public ListViewPropertiesBuilder EnableAjax(bool loadAjax)

Parameters

Type	Name	Description
System.Boolean	loadAjax

Returns

Type	Description
ListViewPropertiesBuilder

EnableCache(Boolean)

Specifies whether to enable caching the content.by setting up boolean argument to true.

Declaration

public ListViewPropertiesBuilder EnableCache(bool cache)

Parameters

Type	Name	Description
System.Boolean	cache

Returns

Type	Description
ListViewPropertiesBuilder

EnableCheckMark(Boolean)

Specifies whether to enable check mark for coressponding selected item.with boolean argument.

Declaration

public ListViewPropertiesBuilder EnableCheckMark(bool enableCheckMark)

Parameters

Type	Name	Description
System.Boolean	enableCheckMark

Returns

Type	Description
ListViewPropertiesBuilder

EnableFiltering(Boolean)

Specifies whether to enable the filtering feature for the items in listView.with boolean argument.

Declaration

public ListViewPropertiesBuilder EnableFiltering(bool enableFiltering)

Parameters

Type	Name	Description
System.Boolean	enableFiltering

Returns

Type	Description
ListViewPropertiesBuilder

EnableGroupList(Boolean)

Specifies whether to group the list item.with boolean argument.

Declaration

public ListViewPropertiesBuilder EnableGroupList(bool enablegroupList)

Parameters

Type	Name	Description
System.Boolean	enablegroupList

Returns

Type	Description
ListViewPropertiesBuilder

EnablePersistence(Boolean)

Specifies that "Saves the current model value to the browser cookies for maintaining states. On refreshing, the ListView control page retains the model value applied from browser cookies.with boolean argument

Declaration

public ListViewPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
ListViewPropertiesBuilder

FieldSettings(Action<ListViewFieldsBuilder>)

Specifies the field settings to map the datasource is enabled.with array argument.

Declaration

public ListViewPropertiesBuilder FieldSettings(Action<ListViewFieldsBuilder> fieldsettings)

Parameters

Type	Name	Description
System.Action<ListViewFieldsBuilder>	fieldsettings

Returns

Type	Description
ListViewPropertiesBuilder

Groups(Action<ListViewGroupItemAdder>)

Specifies the group list items.with array argument.

Declaration

public ListViewPropertiesBuilder Groups(Action<ListViewGroupItemAdder> groupList)

Parameters

Type	Name	Description
System.Action<ListViewGroupItemAdder>	groupList

Returns

Type	Description
ListViewPropertiesBuilder

HeaderBackButtonText(String)

Specifies the text of the back button in the header.with string argument.

Declaration

public ListViewPropertiesBuilder HeaderBackButtonText(string headerBackButtonText)

Parameters

Type	Name	Description
System.String	headerBackButtonText

Returns

Type	Description
ListViewPropertiesBuilder

HeaderTitle(String)

Specifies the title of the header.with string argument.

Declaration

public ListViewPropertiesBuilder HeaderTitle(string headerTitle)

Parameters

Type	Name	Description
System.String	headerTitle

Returns

Type	Description
ListViewPropertiesBuilder

Height(Int32)

Specifies the height.with integer argument.

Declaration

public ListViewPropertiesBuilder Height(int height)

Parameters

Type	Name	Description
System.Int32	height

Returns

Type	Description
ListViewPropertiesBuilder

HideHeaderForUnSupportedDevice(Boolean)

Specifies whether to hide the header for unsupported device.with boolean argument.

Declaration

public ListViewPropertiesBuilder HideHeaderForUnSupportedDevice(bool hideHeaderForUnSupportedDevice)

Parameters

Type	Name	Description
System.Boolean	hideHeaderForUnSupportedDevice

Returns

Type	Description
ListViewPropertiesBuilder

ItemRequestCount(Int32)

Specifies the itemRequestCount with integer argument.

Declaration

public ListViewPropertiesBuilder ItemRequestCount(int itemRequestCount)

Parameters

Type	Name	Description
System.Int32	itemRequestCount

Returns

Type	Description
ListViewPropertiesBuilder

Items(Action<ListViewItemAdder>)

Specifies the list items.with array argument.

Declaration

public ListViewPropertiesBuilder Items(Action<ListViewItemAdder> listItem)

Parameters

Type	Name	Description
System.Action<ListViewItemAdder>	listItem

Returns

Type	Description
ListViewPropertiesBuilder

Locale(String)

Defines the localization culture for the ListView. A string argument 'locale' is passed.

Declaration

public ListViewPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
ListViewPropertiesBuilder

PersistSelection(Boolean)

Specifies whether to retain the selection of the item.with boolean argument.

Declaration

public ListViewPropertiesBuilder PersistSelection(bool persistSelection)

Parameters

Type	Name	Description
System.Boolean	persistSelection

Returns

Type	Description
ListViewPropertiesBuilder

PreventSelection(Boolean)

Specifies whether to prevent the selection of the item being selected.with boolean argument.

Declaration

public ListViewPropertiesBuilder PreventSelection(bool preventSelection)

Parameters

Type	Name	Description
System.Boolean	preventSelection

Returns

Type	Description
ListViewPropertiesBuilder

Query(String)

Specifies the query to execute with the datasource is enabled.with string argument.

Declaration

public ListViewPropertiesBuilder Query(string query)

Parameters

Type	Name	Description
System.String	query

Returns

Type	Description
ListViewPropertiesBuilder

Render()

Declaration

public void Render()

RenderTemplate(Boolean)

Specifies whether to render the control with the template contents.by setting boolean argument to true.

Declaration

public ListViewPropertiesBuilder RenderTemplate(bool renderTemplate)

Parameters

Type	Name	Description
System.Boolean	renderTemplate

Returns

Type	Description
ListViewPropertiesBuilder

SelectedItemIndex(Int32)

Specifies the index of item which need to be in selected state initially while loading.with integer argument.

Declaration

public ListViewPropertiesBuilder SelectedItemIndex(int selectedItemIndex)

Parameters

Type	Name	Description
System.Int32	selectedItemIndex

Returns

Type	Description
ListViewPropertiesBuilder

ShowHeader(Boolean)

Specifies whether to show the header.with using boolean argument.

Declaration

public ListViewPropertiesBuilder ShowHeader(bool showHeader)

Parameters

Type	Name	Description
System.Boolean	showHeader

Returns

Type	Description
ListViewPropertiesBuilder

ShowHeaderBackButton(Boolean)

Specifies whether to show the back button in the header.with boolean argument.

Declaration

public ListViewPropertiesBuilder ShowHeaderBackButton(bool showHeaderBackButton)

Parameters

Type	Name	Description
System.Boolean	showHeaderBackButton

Returns

Type	Description
ListViewPropertiesBuilder

ShowScrollbars(Boolean)

Specifies whether need to show the scroll bars when scrolling is allowed.with boolean argument.

Declaration

public ListViewPropertiesBuilder ShowScrollbars(bool scrollbars)

Parameters

Type	Name	Description
System.Boolean	scrollbars

Returns

Type	Description
ListViewPropertiesBuilder

TemplateId(String)

Specifies ID of the element contains template contents.with string argument.

Declaration

public ListViewPropertiesBuilder TemplateId(string templateId)

Parameters

Type	Name	Description
System.String	templateId

Returns

Type	Description
ListViewPropertiesBuilder

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

TotalItemsCount(Int32)

Specifies the totalItemsCount with integer argument.

Declaration

public ListViewPropertiesBuilder TotalItemsCount(int totalItemsCount)

Parameters

Type	Name	Description
System.Int32	totalItemsCount

Returns

Type	Description
ListViewPropertiesBuilder

VirtualScrollMode(VirtualScrollMode)

Specifies the virtual scroll mode to load the list data on demand via scrolling behavior.

Declaration

public ListViewPropertiesBuilder VirtualScrollMode(VirtualScrollMode virtualScrollMode)

Parameters

Type	Name	Description
VirtualScrollMode	virtualScrollMode

Returns

Type	Description
ListViewPropertiesBuilder

Width(Int32)

Specifies the width.with integer argument.

Declaration

public ListViewPropertiesBuilder Width(int width)

Parameters

Type	Name	Description
System.Int32	width

Returns

Type	Description
ListViewPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString