ListViewBuilder
Properties
WriteAction - Func
Methods
DataSource(System.Action)
Binds the ListView to a DataSource.
Parameters
configurator - System.Action<DataSourceBuilder>
The DataSourceBuilder configurator.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.DataSource(dataSource => dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "ListView"))
.PageSize(21)
)
)
BindTo(System.Collections.Generic.IEnumerable)
Binds the ListView to a list of objects
Parameters
dataSource - System.Collections.Generic.IEnumerable<T>
The IEnumerable list of objects.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.BindTo((IEnumerable<ProductViewModel>) ViewData["Products"])
)
DataSource(System.String)
Binds the ListView to an existing DataSource instance.
Parameters
dataSourceId - System.String
The name of the client DataSource instance.
Example
@(Html.Kendo().DataSource<ProductViewModel>()
.Name("dataSource1")
.Ajax(dataSource => dataSource
.PageSize(10)
.Read(read => read.Action("Products_Read", "DataSource"))
)
)
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.DataSource("dataSource1")
)
BindTo(System.Collections.IEnumerable)
Binds the ListView to a list of objects
Parameters
dataSource - System.Collections.IEnumerable
The data source.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.BindTo((IEnumerable<ProductViewModel>) ViewData["Products"])
)
ClientTemplateId(System.String)
Specifies ListView item template.
Parameters
templateId - System.String
The Id of the script element which contains the template.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsListView")
.ClientTemplateId("listViewTemplate")
)
ClientTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Specifies ListView item template.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view which contains the template.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsListView")
.ClientTemplateView(Html.Partial("listViewTemplate"))
)
ClientTemplateHandler(System.String)
Specifies ListView item template.
Parameters
templateHandler - System.String
The function handler which contains the template.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsListView")
.ClientTemplateHandler("listViewHandler")
)
ClientTemplate(Kendo.Mvc.UI.TemplateBuilder)
Specifies ListView item template.
Parameters
template - TemplateBuilder<TModel>
The template component which contains the template.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsListView")
.ClientTemplate(Html.Kendo()
.Template()
.AddHtml("<p>${data.ProductName}</p>")
)
)
ClientAltTemplateId(System.String)
Specifies ListView alternating item template.
Parameters
templateId - System.String
The Id of the script element which contains the template.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsListView")
.ClientAltTemplateId("listViewTemplate")
)
ClientAltTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Specifies ListView alternating item template.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view which contains the template.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsListView")
.ClientAltTemplateView(Html.Partial("listViewTemplate"))
)
ClientAltTemplateHandler(System.String)
Specifies ListView alternating item template.
Parameters
templateHandler - System.String
The view which contains the template.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsListView")
.ClientAltTemplateHandler("listViewHandler")
)
ClientAltTemplate(Kendo.Mvc.UI.TemplateBuilder)
Specifies ListView alternating item template.
Parameters
template - TemplateBuilder<TModel>
The template component which contains the template.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsListView")
.ClientAltTemplate(Html.Kendo()
.Template()
.AddHtml("<p>${data.ProductName}</p>")
)
)
Pageable()
Allows paging of the data.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.Pageable()
.DataSource(dataSource => dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "ListView"))
.PageSize(21)
)
)
Pageable(System.Action)
Allows paging of the data.
Parameters
pagerAction - System.Action<PageableBuilder>
Use builder to define paging settings.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.Pageable(paging => paging.Numeric(true).PreviousNext(true).PageSizes(false))
.DataSource(dataSource => dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "ListView"))
.PageSize(21)
)
)
Scrollable()
If set the listview will display a scrollbar when the content exceeds the listview height value. By default scrolling is disabled.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.Scrollable()
.DataSource(dataSource => dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "ListView"))
.PageSize(21)
)
)
Scrollable(Kendo.Mvc.UI.ListViewScrollableMode)
In endless scrolling mode the listview should be configured to display a scrollbar. Scrolling to the end of the scrollbar will load more items (equal to the pageSize number) and append them to the listview DOM element utill all items are loaded and displayed.
Parameters
mode - ListViewScrollableMode
The value for Scrollable
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.Scrollable(ListViewScrollableMode.Endless)
.DataSource(dataSource => dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "ListView"))
.PageSize(21)
)
)
Selectable(Kendo.Mvc.UI.ListViewSelectionMode)
Enables selection in the specified selection mode.
Parameters
mode - ListViewSelectionMode
The selection mode.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.Selectable(select=>select.Mode(ListViewSelectionMode.Multiple))
.DataSource(dataSource => dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "ListView"))
.PageSize(21)
)
)
Selectable()
Enables selection in the specified selection mode.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.Selectable(select=>select.Mode(ListViewSelectionMode.Multiple))
.DataSource(dataSource => dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "ListView"))
.PageSize(21)
)
)
Editable(System.Action)
Configures the ListView editing settings.
Parameters
configurator - System.Action<ListViewEditingSettingsBuilder>
The editing settings configurator.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.Editable(edit => edit.Enabled(true))
.DataSource(dataSource => dataSource
.Ajax()
.Model(model => model.Id("ProductID"))
.Read(read => read.Action("Products_Read", "ListView"))
.Update(update => update.Action("Products_Update", "ListView"))
.PageSize(21)
)
)
Editable()
Configures the ListView editing settings.
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsLitView")
.Editable(edit => edit.Enabled(true))
.DataSource(dataSource => dataSource
.Ajax()
.Model(model => model.Id("ProductID"))
.Read(read => read.Action("Products_Read", "ListView"))
.Update(update => update.Action("Products_Update", "ListView"))
.PageSize(21)
)
)
AriaLabel(System.String)
Sets an aria-label attribute on the ListView content element (the element with role listbox or list).
Parameters
value - System.String
The value for AriaLabel
Example
@(Html.Kendo().ListView<ProductViewModel>()
.Name("productsListView")
.AriaLabel("ListView with products")
)
AutoBind(System.Boolean)
If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the data source specified in the configuration.
Parameters
value - System.Boolean
The value for AutoBind
Bordered(System.Boolean)
Renders border around the listview element.
Parameters
value - System.Boolean
The value for Bordered
Borders(System.String)
Renders border around the listview items. Valid values are: all: renders borders around listview items.; horizontal: renders top border of listview items. Useful when setting layout: "flex" and flex.direction: column. or vertical: renders top border of listview items. Useful when setting layout: "flex" and flex.direction: row..
Parameters
value - System.String
The value for Borders
ContentElement(System.String)
Defines the type of element that holds the listview content.
Parameters
value - System.String
The value for ContentElement
Layout(System.String)
Specify the layout of listview content. Valid options are: flex: This is equivalent to display: flex. It defines a flex container and enables a flex context for all its direct children. Think of flex items as primarily laying out either in horizontal rows or vertical columns. or grid: This is equivalent to display: grid. It defines the element as a grid container and establishes a new grid formatting context for its contents..
Parameters
value - System.String
The value for Layout
Flex(System.Action)
Flex layout settings
Parameters
configurator - System.Action<ListViewFlexSettingsBuilder>
The configurator for the flex setting.
Grid(System.Action)
Grid layout settings.
Parameters
configurator - System.Action<ListViewGridSettingsBuilder>
The configurator for the grid setting.
Navigatable(System.Boolean)
Indicates whether keyboard navigation is enabled/disabled.
Parameters
value - System.Boolean
The value for Navigatable
Navigatable()
Indicates whether keyboard navigation is enabled/disabled.
TagName(System.String)
Specifies ListView wrapper element tag name.
Parameters
value - System.String
The value for TagName
Selectable(System.Action)
Specifies whether item selection is allowed. By default selection is disabled
Parameters
configurator - System.Action<ListViewSelectableSettingsBuilder>
The configurator for the selectable setting.
Selectable(System.Boolean)
Specifies whether item selection is allowed. By default selection is disabled
Parameters
enabled - System.Boolean
Enables or disables the selectable option.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<ListViewEventBuilder>
The client events action.
Example
@(Html.Kendo().ListView()
.Name("ListView")
.Events(events => events
.Cancel("onCancel")
)
)
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
Render()
Renders the component in place.
ToHtmlString()
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.