ListBuilder Methods

A List control.
Name Description
AccessKey(JS) Mirrors the client-side accessKey option.
AccessKey(String) Mirrors the client-side accessKey option.
ActiveStateEnabled(JS) Mirrors the client-side activeStateEnabled option.
ActiveStateEnabled(Boolean) Mirrors the client-side activeStateEnabled option.
AllowItemDeleting(JS) Mirrors the client-side allowItemDeleting option.
AllowItemDeleting(Boolean) Mirrors the client-side allowItemDeleting option.
BounceEnabled(JS) Mirrors the client-side bounceEnabled option.
BounceEnabled(Boolean) Mirrors the client-side bounceEnabled option.
CollapsibleGroups(JS) Mirrors the client-side collapsibleGroups option.
CollapsibleGroups(Boolean) 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) Mirrors the client-side disabled option.
Disabled(Boolean) Mirrors the client-side disabled option.
DisplayExpr(JS) Mirrors the client-side displayExpr option.
DisplayExpr(String) 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) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. 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) Mirrors the client-side grouped option.
Grouped(Boolean) 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) Mirrors the client-side height option.
Height(Double) Mirrors the client-side height option.
Height(String) Mirrors the client-side height option.
Hint(JS) Mirrors the client-side hint option.
Hint(String) 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) Mirrors the client-side indicateLoading option.
IndicateLoading(Boolean) Mirrors the client-side indicateLoading option.
ItemDeleteMode(ListItemDeleteMode) Mirrors the client-side itemDeleteMode option.
ItemDragging(Action<SortableBuilder>) Mirrors the client-side itemDragging object.
ItemHoldTimeout(JS) Mirrors the client-side itemHoldTimeout option.
ItemHoldTimeout(Double) 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) Mirrors the client-side menuMode option.
NextButtonText(JS) Mirrors the client-side nextButtonText option.
NextButtonText(String) Mirrors the client-side nextButtonText option.
NoDataText(JS) Mirrors the client-side noDataText option.
NoDataText(String) Mirrors the client-side noDataText option.
OnContentReady(RazorBlock) Mirrors the client-side onContentReady option.
OnContentReady(String) Mirrors the client-side onContentReady option.
OnDisposing(RazorBlock) Mirrors the client-side onDisposing option.
OnDisposing(String) Mirrors the client-side onDisposing option.
OnGroupRendered(RazorBlock) Mirrors the client-side onGroupRendered option.
OnGroupRendered(String) Mirrors the client-side onGroupRendered option.
OnInitialized(RazorBlock) Mirrors the client-side onInitialized option.
OnInitialized(String) Mirrors the client-side onInitialized option.
OnItemClick(RazorBlock) Mirrors the client-side onItemClick option.
OnItemClick(String) Mirrors the client-side onItemClick option.
OnItemContextMenu(RazorBlock) Mirrors the client-side onItemContextMenu option.
OnItemContextMenu(String) Mirrors the client-side onItemContextMenu option.
OnItemDeleted(RazorBlock) Mirrors the client-side onItemDeleted option.
OnItemDeleted(String) Mirrors the client-side onItemDeleted option.
OnItemDeleting(RazorBlock) Mirrors the client-side onItemDeleting option.
OnItemDeleting(String) Mirrors the client-side onItemDeleting option.
OnItemHold(RazorBlock) Mirrors the client-side onItemHold option.
OnItemHold(String) Mirrors the client-side onItemHold option.
OnItemRendered(RazorBlock) Mirrors the client-side onItemRendered option.
OnItemRendered(String) Mirrors the client-side onItemRendered option.
OnItemReordered(RazorBlock) Mirrors the client-side onItemReordered option.
OnItemReordered(String) Mirrors the client-side onItemReordered option.
OnItemSwipe(RazorBlock) Mirrors the client-side onItemSwipe option.
OnItemSwipe(String) Mirrors the client-side onItemSwipe option.
OnOptionChanged(RazorBlock) Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) Mirrors the client-side onOptionChanged option.
OnPageLoading(RazorBlock) Mirrors the client-side onPageLoading option.
OnPageLoading(String) Mirrors the client-side onPageLoading option.
OnPullRefresh(RazorBlock) Mirrors the client-side onPullRefresh option.
OnPullRefresh(String) Mirrors the client-side onPullRefresh option.
OnScroll(RazorBlock) Mirrors the client-side onScroll option.
OnScroll(String) Mirrors the client-side onScroll option.
OnSelectAllValueChanged(RazorBlock) Mirrors the client-side onSelectAllValueChanged option.
OnSelectAllValueChanged(String) Mirrors the client-side onSelectAllValueChanged option.
OnSelectionChanged(RazorBlock) Mirrors the client-side onSelectionChanged option.
OnSelectionChanged(String) Mirrors the client-side onSelectionChanged option.
Option(String, Object) Specifies an option by its name.
PageLoadingText(JS) Mirrors the client-side pageLoadingText option.
PageLoadingText(String) Mirrors the client-side pageLoadingText option.
PageLoadMode(ListPageLoadMode) Mirrors the client-side pageLoadMode option.
PulledDownText(JS) Mirrors the client-side pulledDownText option.
PulledDownText(String) Mirrors the client-side pulledDownText option.
PullingDownText(JS) Mirrors the client-side pullingDownText option.
PullingDownText(String) Mirrors the client-side pullingDownText option.
PullRefreshEnabled(JS) Mirrors the client-side pullRefreshEnabled option.
PullRefreshEnabled(Boolean) 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) Mirrors the client-side refreshingText option.
RefreshingText(String) Mirrors the client-side refreshingText option.
Render() Inherited from WidgetBuilder.
RepaintChangesOnly(JS) Mirrors the client-side repaintChangesOnly option.
RepaintChangesOnly(Boolean) Mirrors the client-side repaintChangesOnly option.
RtlEnabled(JS) Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Mirrors the client-side rtlEnabled option.
ScrollByContent(JS) Mirrors the client-side scrollByContent option.
ScrollByContent(Boolean) Mirrors the client-side scrollByContent option.
ScrollByThumb(JS) Mirrors the client-side scrollByThumb option.
ScrollByThumb(Boolean) Mirrors the client-side scrollByThumb option.
ScrollingEnabled(JS) Mirrors the client-side scrollingEnabled option.
ScrollingEnabled(Boolean) Mirrors the client-side scrollingEnabled option.
SearchEditorOptions(Action<TextBoxBuilder>) 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) Mirrors the client-side searchTimeout option.
SearchTimeout(Double) Mirrors the client-side searchTimeout option.
SearchValue(JS) Mirrors the client-side searchValue option.
SearchValue(String) Mirrors the client-side searchValue option.
SelectAllMode(SelectAllMode) Mirrors the client-side selectAllMode option.
SelectedItemKeys(JS) Mirrors the client-side selectedItemKeys option.
SelectedItemKeys(IEnumerable) Mirrors the client-side selectedItemKeys option.
SelectedItems(JS) Mirrors the client-side selectedItems option.
SelectedItems(IEnumerable) Mirrors the client-side selectedItems option.
SelectionMode(ListSelectionMode) Mirrors the client-side selectionMode option.
ShowScrollbar(ShowScrollbarMode) Mirrors the client-side showScrollbar option.
ShowSelectionControls(JS) Mirrors the client-side showSelectionControls option.
ShowSelectionControls(Boolean) Mirrors the client-side showSelectionControls option.
TabIndex(JS) Mirrors the client-side tabIndex option.
TabIndex(Int32) 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) Mirrors the client-side useNativeScrolling option.
UseNativeScrolling(Boolean) Mirrors the client-side useNativeScrolling option.
Visible(JS) Mirrors the client-side visible option.
Visible(Boolean) Mirrors the client-side visible option.
Width(JS) Mirrors the client-side width option.
Width(Double) Mirrors the client-side width option.
Width(String) Mirrors the client-side width option.
See Also