Edit this page

Kendo.Mvc.UI.Fluent.PanelBarBuilder

Defines the fluent interface for configuring the PanelBar component.

Methods

Items(System.Action<Kendo.Mvc.UI.Fluent.PanelBarItemFactory>)

Defines the items in the panelbar

Parameters

addAction System.Action<Kendo.Mvc.UI.Fluent.PanelBarItemFactory>

The add action.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.Items(items =>
{
    items.Add().Text("First Item");
    items.Add().Text("Second Item");
})
%>

AutoBind(System.Boolean)

Controls whether to bind the widget to the DataSource on initialization.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.AutoBind(false)
%>

Template(System.String)

Template to be used for rendering the items in the panelbar.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.Template("#= data #")
%>

TemplateId(System.String)

Id of the template element to be used for rendering the items in the panelbar.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.TemplateId("widgetTemplateId")
%>

Events(System.Action<Kendo.Mvc.UI.Fluent.PanelBarEventBuilder>)

Configures the client-side events.

Parameters

clientEventsAction System.Action<Kendo.Mvc.UI.Fluent.PanelBarEventBuilder>

The client events action.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.Events(events =>
    events.Expand("expand").Collapse("collapse")
)
%>

BindTo(System.String,System.Action<Kendo.Mvc.UI.PanelBarItem,Kendo.Mvc.SiteMapNode>)

Binds the panelbar to a sitemap

Parameters

viewDataKey System.String

The view data key.

siteMapAction System.Action<Kendo.Mvc.UI.PanelBarItem,Kendo.Mvc.SiteMapNode>

The action to configure the item.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.BindTo("examples", (item, siteMapNode) =>
{
})
%>

BindTo(System.String)

Binds the panelbar to a sitemap.

Parameters

viewDataKey System.String

The view data key.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.BindTo("examples")
%>

BindTo(System.Collections.Generic.IEnumerable<Kendo.Mvc.UI.PanelBarItemModel>)

Binds the PanelBar to a list of items. Use if a hierarchy of items is being sent from the controller; to bind the PanelBar declaratively, use the Items() method.

Parameters

items System.Collections.Generic.IEnumerable<Kendo.Mvc.UI.PanelBarItemModel>

The list of items

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.BindTo(model)
%>

BindTo(System.Collections.Generic.IEnumerable<T1>,System.Action<Kendo.Mvc.UI.PanelBarItem,T1>)

Binds the panelbar to a list of objects

Parameters

dataSource System.Collections.Generic.IEnumerable<T1>

The data source.

itemDataBound System.Action<Kendo.Mvc.UI.PanelBarItem,T1>

The action executed for every data bound item.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.BindTo(new []{"First", "Second"}, (item, value) =>
{
    item.Text = value;
})
%>

BindTo(System.Collections.IEnumerable,System.Action<Kendo.Mvc.UI.Fluent.NavigationBindingFactory<Kendo.Mvc.UI.PanelBarItem>>)

Binds the panelbar to a list of objects. The panelbar will create a hierarchy of items using the specified mappings.

Parameters

dataSource System.Collections.IEnumerable

The data source.

factoryAction System.Action<Kendo.Mvc.UI.Fluent.NavigationBindingFactory>

The action which will configure the mappings

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.BindTo(Model, mapping => mapping
    .For<Customer>(binding => binding
        .Children(c => c.Orders) // The "child" items will be bound to the the "Orders" property
        .ItemDataBound((item, c) => item.Text = c.ContactName) // Map "Customer" properties to PanelBarItem properties
    )
    .For<Order<(binding => binding
        .Children(o => null) // "Orders" do not have child objects so return "null"
        .ItemDataBound((item, o) => item.Text = o.OrderID.ToString()) // Map "Order" properties to PanelBarItem properties
    )
)
%>

DataSource(System.Action<Kendo.Mvc.UI.Fluent.HierarchicalDataSourceBuilder<System.Object>>)

Configure the DataSource of the component

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.HierarchicalDataSourceBuilder>

The action that configures the M:Kendo.Mvc.UI.Fluent.PanelBarBuilder.DataSource(System.Action{Kendo.Mvc.UI.Fluent.HierarchicalDataSourceBuilder{System.Object}}).

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.DataSource(dataSource => dataSource
    .Read(read => read
        .Action("Employees", "PanelBar")
    )
)
%>

LoadOnDemand(System.Boolean)

Allows the panelbar to fetch the entire datasource at initialization time.

Parameters

field System.Boolean

Whether the datasource should be loaded on demand.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.LoadOnDemand(false)
%>

DataImageUrlField(System.String)

Sets the field of the data item that provides the image URL of the PanelBar nodes.

Parameters

value System.String

The value that configures the dataimageurlfield.

DataSpriteCssClassField(System.String)

Sets the field of the data item that provides the sprite CSS class of the nodes. If an array, each level uses the field that is at the same index in the array, or the last item in the array.

Parameters

value System.String

The value that configures the dataspritecssclassfield.

DataUrlField(System.String)

Sets the field of the data item that provides the link URL of the nodes.

Parameters

value System.String

The value that configures the dataurlfield.

Messages(System.Action<Kendo.Mvc.UI.Fluent.PanelBarMessagesSettingsBuilder>)

The text messages displayed in the widget. Use it to customize or localize the messages.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.PanelBarMessagesSettingsBuilder>

The action that configures the messages.

DataTextField(System.String[])

Sets the field of the data item that provides the text content of the nodes. If an array, each level uses the field that is at the same index in the array, or the last item in the array.

Parameters

value System.String[]

The value that configures the datatextfield.

Animation(System.Boolean)

Configures the animation effects of the panelbar.

Parameters

enable System.Boolean

Whether the component animation is enabled.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.Animation(false)

Animation(System.Action<Kendo.Mvc.UI.Fluent.ExpandableAnimationBuilder>)

Configures the animation effects of the panelbar.

Parameters

animationAction System.Action<Kendo.Mvc.UI.Fluent.ExpandableAnimationBuilder>

The action that configures the animation.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.Animation(animation => animation.Expand(config => config.Fade(FadeDirection.In)))

ItemAction(System.Action<Kendo.Mvc.UI.PanelBarItem>)

Callback for each item.

Parameters

itemAction System.Action<Kendo.Mvc.UI.PanelBarItem>

Action, which will be executed for each item.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.ItemAction(item =>
{
    item
    .Text(...)
    .HtmlAttributes(...);
})
%>

HighlightPath(System.Boolean)

Select item depending on the current URL.

Parameters

value System.Boolean

If true the item will be highlighted.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.HighlightPath(true)
%>

ExpandAll(System.Boolean)

Renders the panelbar with expanded items.

Parameters

value System.Boolean

If true the panelbar will be expanded.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.ExpandAll(true)
%>

ExpandMode(Kendo.Mvc.UI.PanelBarExpandMode)

Sets the expand mode of the panelbar.

Parameters

value Kendo.Mvc.UI.PanelBarExpandMode

The desired expand mode.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.ExpandMode(PanelBarExpandMode.Multiple)
%>

SelectedIndex(System.Int32)

Selects the item at the specified index.

Parameters

index System.Int32

The index.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.Items(items =>
{
    items.Add().Text("First Item");
    items.Add().Text("Second Item");
})
.SelectedIndex(1)
%>

SecurityTrimming(System.Boolean)

Enable/disable security trimming functionality of the component.

Parameters

value System.Boolean

If true security trimming is enabled.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.SecurityTrimming(false)
%>

SecurityTrimming(System.Action<Kendo.Mvc.UI.SecurityTrimmingBuilder>)

Defines the security trimming functionality of the component

Parameters

securityTrimmingAction System.Action<Kendo.Mvc.UI.SecurityTrimmingBuilder>

The securityTrimming action.

Example (ASPX)

<%= Html.Kendo().PanelBar()
.Name("PanelBar")
.SecurityTrimming(builder =>
{
    builder.Enabled(true).HideParent(true);
})
%>