Skip to main content

ListBuilder Members

A List control.

Constructors

Name Description
ListBuilder(OptionsOwnerContext) For internal use only. Initializes a new ListBuilder class instance.

Methods

Name Description
AccessKey(JS) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
AccessKey(String) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
ActiveStateEnabled(JS) Mirrors the client-side activeStateEnabled option.
ActiveStateEnabled(Boolean) Mirrors the client-side activeStateEnabled option.
AllowItemDeleting(JS) Specifies whether or not an end user can delete list items. Mirrors the client-side allowItemDeleting option.
AllowItemDeleting(Boolean) Specifies whether or not an end user can delete list items. Mirrors the client-side allowItemDeleting option.
BounceEnabled(JS) A Boolean value specifying whether to enable or disable the bounce-back effect. Mirrors the client-side bounceEnabled option.
BounceEnabled(Boolean) A Boolean value specifying whether to enable or disable the bounce-back effect. Mirrors the client-side bounceEnabled option.
CollapsibleGroups(JS) Specifies whether or not an end user can collapse groups. Mirrors the client-side collapsibleGroups option.
CollapsibleGroups(Boolean) Specifies whether or not an end user can collapse groups. Mirrors the client-side collapsibleGroups option.
DataSource(JS) Mirrors the client-side dataSource option.
DataSource(IEnumerable, String[]) Binds a List control to a collection: Array, List, or IEnumerable.
DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) Binds a List control to data, allows you to configure data access from different sources: API controllers, Razor page handlers, OData services, arrays, and more.
DataSource(String, String[]) Binds a List control to read-only data in JSON format.
DataSourceOptions(Action<DataSourceOptionsBuilder>) Provides access to methods that mirror client-side data source options.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
DisplayExpr(JS) Specifies the data field whose values should be displayed. Defaults to 'text' when the data source contains objects. Mirrors the client-side displayExpr option.
DisplayExpr(String) Specifies the data field whose values should be displayed. Defaults to 'text' when the data source contains objects. Mirrors the client-side displayExpr option.
ElementAttr(JS) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Dictionary<String, Object>) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(String, Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FocusStateEnabled(JS) Mirrors the client-side focusStateEnabled option.
FocusStateEnabled(Boolean) Mirrors the client-side focusStateEnabled option.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
Grouped(JS) Specifies whether data items should be grouped. Mirrors the client-side grouped option.
Grouped(Boolean) Specifies whether data items should be grouped. Mirrors the client-side grouped option.
GroupTemplate(JS) Specifies the client-side groupTemplate.
GroupTemplate(RazorBlock) Specifies the client-side groupTemplate.
GroupTemplate(TemplateName) Specifies the client-side groupTemplate.
GroupTemplate(String) Specifies the client-side groupTemplate.
Height(JS) Specifies the UI component's height. Mirrors the client-side height option.
Height(Double) Specifies the UI component's height. Mirrors the client-side height option.
Height(String) Specifies the UI component's height. Mirrors the client-side height option.
Hint(JS) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
Hint(String) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
HoverStateEnabled(JS) Mirrors the client-side hoverStateEnabled option.
HoverStateEnabled(Boolean) Mirrors the client-side hoverStateEnabled option.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
IndicateLoading(JS) Specifies whether or not to show the loading panel when the DataSource bound to the UI component is loading data. Mirrors the client-side indicateLoading option.
IndicateLoading(Boolean) Specifies whether or not to show the loading panel when the DataSource bound to the UI component is loading data. Mirrors the client-side indicateLoading option.
ItemDeleteMode(ListItemDeleteMode) Specifies the way a user can delete items from the list. Mirrors the client-side itemDeleteMode option.
ItemDragging(Action<SortableBuilder>) Configures item reordering using drag and drop gestures. Mirrors the client-side itemDragging object.
ItemHoldTimeout(JS) The time period in milliseconds before the onItemHold event is raised. Mirrors the client-side itemHoldTimeout option.
ItemHoldTimeout(Double) The time period in milliseconds before the onItemHold event is raised. Mirrors the client-side itemHoldTimeout option.
Items(Action<CollectionFactory<ListItemBuilder>>) Provides access to the client-side items option that represents a List item collection.
Items(IEnumerable<String>) Mirrors the client-side items option.
ItemTemplate(JS) Specifies the client-side itemTemplate.
ItemTemplate(RazorBlock) Specifies the client-side itemTemplate.
ItemTemplate(TemplateName) Specifies the client-side itemTemplate.
ItemTemplate(String) Specifies the client-side itemTemplate.
KeyExpr(JS) Mirrors the client-side keyExpr option.
KeyExpr(String) Mirrors the client-side keyExpr option.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MenuItems(Action<CollectionFactory<ListMenuItemBuilder>>) Provides access to the client-side menuItems option that represents a List menu item collection.
MenuMode(ListMenuMode) Specifies whether an item context menu is shown when a user holds or swipes an item. Mirrors the client-side menuMode option.
NextButtonText(JS) The text displayed on the button used to load the next page from the data source. Mirrors the client-side nextButtonText option.
NextButtonText(String) The text displayed on the button used to load the next page from the data source. Mirrors the client-side nextButtonText option.
NoDataText(JS) Specifies the text or HTML markup displayed by the UI component if the item collection is empty. Mirrors the client-side noDataText option.
NoDataText(String) Specifies the text or HTML markup displayed by the UI component if the item collection is empty. Mirrors the client-side noDataText option.
OnContentReady(RazorBlock) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnContentReady(String) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnDisposing(RazorBlock) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDisposing(String) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnGroupRendered(RazorBlock) A function that is executed when a group element is rendered. Mirrors the client-side onGroupRendered option.
OnGroupRendered(String) A function that is executed when a group element is rendered. Mirrors the client-side onGroupRendered option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnItemClick(RazorBlock) A function that is executed when a collection item is clicked or tapped. Mirrors the client-side onItemClick option.
OnItemClick(String) A function that is executed when a collection item is clicked or tapped. Mirrors the client-side onItemClick option.
OnItemContextMenu(RazorBlock) A function that is executed when a collection item is right-clicked or pressed. Mirrors the client-side onItemContextMenu option.
OnItemContextMenu(String) A function that is executed when a collection item is right-clicked or pressed. Mirrors the client-side onItemContextMenu option.
OnItemDeleted(RazorBlock) A function that is executed after a list item is deleted from the data source. Mirrors the client-side onItemDeleted option.
OnItemDeleted(String) A function that is executed after a list item is deleted from the data source. Mirrors the client-side onItemDeleted option.
OnItemDeleting(RazorBlock) A function that is executed before a collection item is deleted from the data source. Mirrors the client-side onItemDeleting option.
OnItemDeleting(String) A function that is executed before a collection item is deleted from the data source. Mirrors the client-side onItemDeleting option.
OnItemHold(RazorBlock) A function that is executed when a collection item has been held for a specified period. Mirrors the client-side onItemHold option.
OnItemHold(String) A function that is executed when a collection item has been held for a specified period. Mirrors the client-side onItemHold option.
OnItemRendered(RazorBlock) A function that is executed after a collection item is rendered. Mirrors the client-side onItemRendered option.
OnItemRendered(String) A function that is executed after a collection item is rendered. Mirrors the client-side onItemRendered option.
OnItemReordered(RazorBlock) A function that is executed after a list item is moved to another position. Mirrors the client-side onItemReordered option.
OnItemReordered(String) A function that is executed after a list item is moved to another position. Mirrors the client-side onItemReordered option.
OnItemSwipe(RazorBlock) A function that is executed when a list item is swiped. Mirrors the client-side onItemSwipe option.
OnItemSwipe(String) A function that is executed when a list item is swiped. Mirrors the client-side onItemSwipe option.
OnOptionChanged(RazorBlock) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnPageLoading(RazorBlock) A function that is executed before the next page is loaded. Mirrors the client-side onPageLoading option.
OnPageLoading(String) A function that is executed before the next page is loaded. Mirrors the client-side onPageLoading option.
OnPullRefresh(RazorBlock) A function that is executed when the 'pull to refresh' gesture is performed. Supported on mobile devices only. Mirrors the client-side onPullRefresh option.
OnPullRefresh(String) A function that is executed when the 'pull to refresh' gesture is performed. Supported on mobile devices only. Mirrors the client-side onPullRefresh option.
OnScroll(RazorBlock) A function that is executed on each scroll gesture. Mirrors the client-side onScroll option.
OnScroll(String) A function that is executed on each scroll gesture. Mirrors the client-side onScroll option.
OnSelectAllValueChanged(RazorBlock) A function that is executed when the 'Select All' check box value is changed. Applies only if the selectionMode is 'all'. Mirrors the client-side onSelectAllValueChanged option.
OnSelectAllValueChanged(String) A function that is executed when the 'Select All' check box value is changed. Applies only if the selectionMode is 'all'. Mirrors the client-side onSelectAllValueChanged option.
OnSelectionChanged(RazorBlock) A function that is executed when a collection item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option.
OnSelectionChanged(String) A function that is executed when a collection item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option.
Option(String, Object) Specifies an option by its name.
PageLoadingText(JS) Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. Mirrors the client-side pageLoadingText option.
PageLoadingText(String) Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. Mirrors the client-side pageLoadingText option.
PageLoadMode(ListPageLoadMode) Specifies whether the next page is loaded when a user scrolls the UI component to the bottom or when the 'next' button is clicked. Mirrors the client-side pageLoadMode option.
PulledDownText(JS) Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. Mirrors the client-side pulledDownText option.
PulledDownText(String) Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. Mirrors the client-side pulledDownText option.
PullingDownText(JS) Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. Mirrors the client-side pullingDownText option.
PullingDownText(String) Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. Mirrors the client-side pullingDownText option.
PullRefreshEnabled(JS) A Boolean value specifying whether or not the UI component supports the 'pull down to refresh' gesture. Mirrors the client-side pullRefreshEnabled option.
PullRefreshEnabled(Boolean) A Boolean value specifying whether or not the UI component supports the 'pull down to refresh' gesture. Mirrors the client-side pullRefreshEnabled option.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RefreshingText(JS) Specifies the text displayed in the pullDown panel while the list is being refreshed. Mirrors the client-side refreshingText option.
RefreshingText(String) Specifies the text displayed in the pullDown panel while the list is being refreshed. Mirrors the client-side refreshingText option.
Render() Inherited from WidgetBuilder.
RepaintChangesOnly(JS) Specifies whether to repaint only those elements whose data changed. Mirrors the client-side repaintChangesOnly option.
RepaintChangesOnly(Boolean) Specifies whether to repaint only those elements whose data changed. Mirrors the client-side repaintChangesOnly option.
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
ScrollByContent(JS) A Boolean value specifying if the list is scrolled by content. Mirrors the client-side scrollByContent option.
ScrollByContent(Boolean) A Boolean value specifying if the list is scrolled by content. Mirrors the client-side scrollByContent option.
ScrollByThumb(JS) Specifies whether a user can scroll the content with the scrollbar. Applies only if useNativeScrolling is false. Mirrors the client-side scrollByThumb option.
ScrollByThumb(Boolean) Specifies whether a user can scroll the content with the scrollbar. Applies only if useNativeScrolling is false. Mirrors the client-side scrollByThumb option.
ScrollingEnabled(JS) A Boolean value specifying whether to enable or disable list scrolling. Mirrors the client-side scrollingEnabled option.
ScrollingEnabled(Boolean) A Boolean value specifying whether to enable or disable list scrolling. Mirrors the client-side scrollingEnabled option.
SearchEditorOptions(Action<TextBoxBuilder>) Configures the search panel. Mirrors the client-side searchEditorOptions object.
SearchEnabled(JS) Mirrors the client-side searchEnabled option.
SearchEnabled(Boolean) Mirrors the client-side searchEnabled option.
SearchExpr(JS) Mirrors the client-side searchExpr option.
SearchExpr(IEnumerable<String>) Mirrors the client-side searchExpr option.
SearchExpr(String[]) Mirrors the client-side searchExpr option.
SearchMode(CollectionSearchMode) Mirrors the client-side searchMode option.
SearchTimeout(JS) Specifies a delay in milliseconds between when a user finishes typing, and the search is executed. Mirrors the client-side searchTimeout option.
SearchTimeout(Double) Specifies a delay in milliseconds between when a user finishes typing, and the search is executed. Mirrors the client-side searchTimeout option.
SearchValue(JS) Specifies the current search string. Mirrors the client-side searchValue option.
SearchValue(String) Specifies the current search string. Mirrors the client-side searchValue option.
SelectAllMode(SelectAllMode) Specifies the mode in which all items are selected. Mirrors the client-side selectAllMode option.
SelectAllText(JS)
SelectAllText(String)
SelectByClick(JS) Specifies whether an item is selected if a user clicks it. Mirrors the client-side selectByClick option.
SelectByClick(Boolean) Specifies whether an item is selected if a user clicks it. Mirrors the client-side selectByClick option.
SelectedItemKeys(JS) Mirrors the client-side selectedItemKeys option.
SelectedItemKeys(IEnumerable) Mirrors the client-side selectedItemKeys option.
SelectedItems(JS) An array of currently selected item objects. Mirrors the client-side selectedItems option.
SelectedItems(IEnumerable) An array of currently selected item objects. Mirrors the client-side selectedItems option.
SelectionMode(ListSelectionMode) Specifies item selection mode. Mirrors the client-side selectionMode option.
ShowScrollbar(ShowScrollbarMode) Specifies when the UI component shows the scrollbar. Mirrors the client-side showScrollbar option.
ShowSelectionControls(JS) Specifies whether or not to display controls used to select list items. Mirrors the client-side showSelectionControls option.
ShowSelectionControls(Boolean) Specifies whether or not to display controls used to select list items. Mirrors the client-side showSelectionControls option.
TabIndex(JS) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
TabIndex(Int32) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
UseNativeScrolling(JS) Specifies whether or not the UI component uses native scrolling. Mirrors the client-side useNativeScrolling option.
UseNativeScrolling(Boolean) Specifies whether or not the UI component uses native scrolling. Mirrors the client-side useNativeScrolling option.
Visible(JS) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Visible(Boolean) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Width(JS) Specifies the UI component's width. Mirrors the client-side width option.
Width(Double) Specifies the UI component's width. Mirrors the client-side width option.
Width(String) Specifies the UI component's width. Mirrors the client-side width option.
See Also