New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

PanelBarBuilder

Class

Defines the fluent interface for configuring the PanelBar component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class PanelBarBuilder : WidgetBuilderBase<PanelBar, PanelBarBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<PanelBar, PanelBarBuilder>PanelBarBuilder

Implements: IHtmlString

Constructors

PanelBarBuilder(PanelBar)

Initializes a new instance of the PanelBarBuilder class.

public PanelBarBuilder(PanelBar component)

Parameters:componentPanelBar

The component.

Methods

Animation(Action<ExpandableAnimationBuilder>)

Configures the visual animations of the PanelBar.

public PanelBarBuilder Animation(Action<ExpandableAnimationBuilder> animationAction)

Parameters:animationActionAction<ExpandableAnimationBuilder>

The action that configures the animation.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.Animation(animation =&gt; animation.Expand(config =&gt; config.Fade(FadeDirection.In)))
)

Animation(bool)

Configures the visual animations of the PanelBar.

public PanelBarBuilder Animation(bool enable)

Parameters:enablebool

The boolean value.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.Animation(false)
)

AutoBind(bool)

Controls whether to bind the PanelBar to the DataSource during its initialization.

public PanelBarBuilder AutoBind(bool autoBind)

Parameters:autoBindbool

The boolean value.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.AutoBind(false)
)

BindTo(IEnumerable, Action<NavigationBindingFactory<PanelBarItem>>)

public PanelBarBuilder BindTo(IEnumerable dataSource, Action<NavigationBindingFactory<PanelBarItem>> factoryAction)

Parameters:dataSourceIEnumerablefactoryActionAction<NavigationBindingFactory<PanelBarItem>>Returns:

PanelBarBuilder

BindTo(IEnumerable<PanelBarItemModel>)

public PanelBarBuilder BindTo(IEnumerable<PanelBarItemModel> items)

Parameters:itemsIEnumerable<PanelBarItemModel>Returns:

PanelBarBuilder

BindTo(string, Action<PanelBarItem, SiteMapNode>)

Binds the PanelBar to a sitemap.

public PanelBarBuilder BindTo(string viewDataKey, Action<PanelBarItem, SiteMapNode> siteMapAction)

Parameters:viewDataKeystring

The view data key.

siteMapActionAction<PanelBarItem, SiteMapNode>

The action to configure the item.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.BindTo("examples", (item, siteMapNode) =&gt;
{
})
)

BindTo(string)

Binds the PanelBar to a sitemap.

public PanelBarBuilder BindTo(string viewDataKey)

Parameters:viewDataKeystring

The view data key.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.BindTo("examples")
)

BindTo<T>(IEnumerable<T>, Action<PanelBarItem, T>)

Binds the PanelBar to a list of objects. The PanelBar will be "flat", which means a PanelBar item will be created for every item in the data source.

public PanelBarBuilder BindTo<T>(IEnumerable<T> dataSource, Action<PanelBarItem, T> itemDataBound)

Parameters:dataSourceIEnumerable<T>

The data source.

itemDataBoundAction<PanelBarItem, T>

The action executed for every data bound item.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.BindTo(new []{"First", "Second"}, (item, value) =&gt;
{
item.Text = value;
}))

DataIconClassField(string)

Sets the field of the data item that provides the icon content of the items.

public PanelBarBuilder DataIconClassField(string value)

Parameters:valuestring

The value that configures the dataiconclassfield.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.Items(items =&gt;
{
items.Add().Text("First Item");
items.Add().Text("Second Item");
})
.DataIconClassField("k-i-pencil")
)

DataIconField(string)

Sets the field of the data item that provides the icon content of the items.

public PanelBarBuilder DataIconField(string value)

Parameters:valuestring

The value that configures the dataiconfield.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.Items(items =&gt;
{
items.Add().Text("First Item");
items.Add().Text("Second Item");
})
.DataIconField("pencil")
)

DataImageUrlField(string)

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

public PanelBarBuilder DataImageUrlField(string value)

Parameters:valuestring

The value that configures the dataimageurlfield.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.DataImageUrlField("UserImage")
.DataSource(dataSource =&gt; dataSource
.Read(read =&gt; read.Action("Employees", "PanelBar"))
)
)

DataSource(Action<HierarchicalDataSourceBuilder<object>>)

Configures the DataSource of the component for remote data binding.

public PanelBarBuilder DataSource(Action<HierarchicalDataSourceBuilder<object>> configurator)

Parameters:configuratorAction<HierarchicalDataSourceBuilder<object>>

The action that configures the DataSource.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.DataSource(dataSource =&gt; dataSource
.Read(read =&gt; read.Action("Employees", "PanelBar"))
)
)

DataSource(string)

public PanelBarBuilder DataSource(string dataSourceId)

Parameters:dataSourceIdstringReturns:

PanelBarBuilder

DataSpriteCssClassField(string)

Sets the field of the data item that provides the sprite CSS class of the items.

public PanelBarBuilder DataSpriteCssClassField(string value)

Parameters:valuestring

The value that configures the dataspritecssclassfield.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.DataSpriteCssClassField("spriteProperty")
.DataSource(dataSource =&gt; dataSource
.Read(read =&gt; read.Action("Employees", "PanelBar"))
)
)

DataTextField(params string[])

Sets the field of the data item that provides the text content of the items.

public PanelBarBuilder DataTextField(params string[] value)

Parameters:valuestring[]

The value that configures the datatextfield.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.DataTextField("Name")
.DataSource(dataSource =&gt; dataSource
.Read(read =&gt; read.Action("Employees", "PanelBar"))
)
)

DataUrlField(string)

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

public PanelBarBuilder DataUrlField(string value)

Parameters:valuestring

The value that configures the dataurlfield.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.DataUrlField("urlProperty")
.DataSource(dataSource =&gt; dataSource
.Read(read =&gt; read.Action("Employees", "PanelBar"))
)
)

Events(Action<PanelBarEventBuilder>)

Configures the client-side event handlers.

public PanelBarBuilder Events(Action<PanelBarEventBuilder> clientEventsAction)

Parameters:clientEventsActionAction<PanelBarEventBuilder>

The client events action.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.Events(events =&gt;
events.Expand("expand").Collapse("collapse")
)
)

ExpandAll(bool)

Renders the PanelBar with expanded items.

public PanelBarBuilder ExpandAll(bool value)

Parameters:valuebool

The boolean value.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.ExpandAll(true)
)

ExpandMode(PanelBarExpandMode)

Specifies how the PanelBar items are displayed when opened and closed.

public PanelBarBuilder ExpandMode(PanelBarExpandMode value)

Parameters:valuePanelBarExpandMode

The desired expand mode.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.ExpandMode(PanelBarExpandMode.Multiple)
)

HighlightPath(bool)

Selects the item depending on the current URL.

public PanelBarBuilder HighlightPath(bool value)

Parameters:valuebool

The boolean value.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.HighlightPath(true)
)

ItemAction(Action<PanelBarItem>)

Defines the callback for each item.

public PanelBarBuilder ItemAction(Action<PanelBarItem> action)

Parameters:actionAction<PanelBarItem>

Action, which will be executed for each item.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.ItemAction(item =&gt;
{
item
.Text(...)
.HtmlAttributes(...);
})
)

Items(Action<PanelBarItemFactory>)

Defines the items within the PanelBar declaration.

public PanelBarBuilder Items(Action<PanelBarItemFactory> addAction)

Parameters:addActionAction<PanelBarItemFactory>

The add action.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.Items(items =&gt;
{
items.Add().Text("First Item");
items.Add().Text("Second Item");
})
)

LoadOnDemand(bool)

Indicates whether the child DataSources should be fetched lazily when parent groups get expanded. Setting this to false causes all child DataSources to be loaded at initialization time.

public PanelBarBuilder LoadOnDemand(bool value)

Parameters:valuebool

The boolean value.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.LoadOnDemand(false)
)

Messages(Action<PanelBarMessagesSettingsBuilder>)

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

public PanelBarBuilder Messages(Action<PanelBarMessagesSettingsBuilder> configurator)

Parameters:configuratorAction<PanelBarMessagesSettingsBuilder>

The action that configures the messages.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.Messages(msg =&gt; msg.Loading("loading..."))
)

SecurityTrimming(Action<SecurityTrimmingBuilder>)

Defines the security trimming functionality of the component.

public PanelBarBuilder SecurityTrimming(Action<SecurityTrimmingBuilder> securityTrimmingAction)

Parameters:securityTrimmingActionAction<SecurityTrimmingBuilder>

The securityTrimming action.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.SecurityTrimming(builder =&gt;
{
builder.Enabled(true).HideParent(true);
})
)

SecurityTrimming(bool)

Enables/disables the security trimming functionality of the component.

public PanelBarBuilder SecurityTrimming(bool value)

Parameters:valuebool

The boolean value.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.SecurityTrimming(false)
)

SelectedIndex(int)

Selects the item at the specified index.

public PanelBarBuilder SelectedIndex(int index)

Parameters:indexint

The index.

Returns:

PanelBarBuilder

Example:

@( Html.Kendo().PanelBar()
.Name("PanelBar")
.Items(items =&gt;
{
items.Add().Text("First Item");
items.Add().Text("Second Item");
})
.SelectedIndex(1)
)

Template(string)

Defines a template for the items rendering.

public PanelBarBuilder Template(string template)

Parameters:templatestring

The template content.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.Template("#= item.text #")
)

TemplateHandler(string)

Defines a template for the items rendering by using client-side handler.

public PanelBarBuilder TemplateHandler(string template)

Parameters:templatestring

The name of the JavaScript function that will return the template content.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.TemplateHandler("getItemTemplate")
)

function getItemTemplate(data) {
return `${data.item.text}`;
}

TemplateId(string)

Specifies the "id" of the external Kendo UI template used for rendering the PanelBar items.

public PanelBarBuilder TemplateId(string templateId)

Parameters:templateIdstring

The value of the template "id".

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.TemplateId("panelbar-template")
)

#: item.text #

TemplateView(MvcHtmlString)

Defines a template for the items rendering by using a partial View.

public PanelBarBuilder TemplateView(MvcHtmlString template)

Parameters:templateMvcHtmlString

The partial View name.

Returns:

PanelBarBuilder

Example:

@(Html.Kendo().PanelBar()
.Name("PanelBar")
.TemplateView(Html.Partial("panelbar-template-view"))
)