Introduction
Knowledge Base
API Reference / kendo.mvc.ui.fluent / ToolBarItemBuilder

ToolBarItemBuilder

Methods

HtmlAttributes(System.Collections.Generic.IDictionary)

Specifies the HTML attributes of a ToolBar button.

Parameters

value - System.Collections.Generic.IDictionary<String,Object>

The value for HtmlAttributes

RETURNS

Returns the current ToolBarItemBuilder instance.

HtmlAttributes(System.Object)

Specifies the HTML attributes of a ToolBar button.

Parameters

value - System.Object

The value for HtmlAttributes

RETURNS

Returns the current ToolBarItemBuilder instance.

Buttons(System.Action)

Specifies the buttons of ButtonGroup.

Parameters

configurator - System.Action<ToolBarItemButtonFactory>

The configurator for the buttons setting.

RETURNS

Returns the current instance of ToolBarItemBuilder .

Click(System.String)

Specifies the click event handler of the button. Applicable only for commands of type button and splitButton.

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ToolBarItemBuilder instance.

Click(System.Func)

Specifies the click event handler of the button. Applicable only for commands of type button and splitButton.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ToolBarItemBuilder instance.

Enable(System.Boolean)

Specifies whether the control is initially enabled or disabled. Default value is "true".

Parameters

value - System.Boolean

The value for Enable

RETURNS

Returns the current ToolBarItemBuilder instance.

Group(System.String)

Assigns the button to a group. Applicable only for buttons with togglable: true.

Parameters

value - System.String

The value for Group

RETURNS

Returns the current ToolBarItemBuilder instance.

Hidden(System.Boolean)

Determines if a button is visible or hidden. By default buttons are visible.

Parameters

value - System.Boolean

The value for Hidden

RETURNS

Returns the current ToolBarItemBuilder instance.

Hidden()

Determines if a button is visible or hidden. By default buttons are visible.

RETURNS

Returns the current ToolBarItemBuilder instance.

Icon(System.String)

Sets icon for the item. The icon should be one of the existing in the Kendo UI theme sprite.

Parameters

value - System.String

The value for Icon

RETURNS

Returns the current ToolBarItemBuilder instance.

Id(System.String)

Specifies the ID of the button.

Parameters

value - System.String

The value for Id

RETURNS

Returns the current ToolBarItemBuilder instance.

ImageUrl(System.String)

If set, the ToolBar will render an image with the specified URL in the button.

Parameters

value - System.String

The value for ImageUrl

RETURNS

Returns the current ToolBarItemBuilder instance.

Specifies the menu buttons of a SplitButton or a DropDownButton.

Parameters

configurator - System.Action<ToolBarItemMenuButtonFactory>

The configurator for the menubuttons setting.

RETURNS

Returns the current instance of ToolBarItemBuilder .

OverflowTemplate(System.String)

Specifies what element will be added in the command overflow popup. Applicable only for items that have a template.

Parameters

value - System.String

The value for OverflowTemplate

RETURNS

Returns the current ToolBarItemBuilder instance.

OverflowTemplateId(System.String)

Specifies what element will be added in the command overflow popup. Applicable only for items that have a template.

Parameters

templateId - System.String

The ID of the template element for OverflowTemplate

RETURNS

Returns the current ToolBarItemBuilder instance.

OverflowTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

Specifies what element will be added in the command overflow popup. Applicable only for items that have a template.

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for OverflowTemplate

RETURNS

Returns the current ToolBarItemBuilder instance.

OverflowTemplateHandler(System.String)

Specifies what element will be added in the command overflow popup. Applicable only for items that have a template.

Parameters

templateHandler - System.String

The handler that returs the template for OverflowTemplate

RETURNS

Returns the current ToolBarItemBuilder instance.

OverflowTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Specifies what element will be added in the command overflow popup. Applicable only for items that have a template.

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the overflowtemplate.

RETURNS

Returns the current ToolBarItemBuilder instance.

Primary(System.Boolean)

Specifies whether the button is primary. Primary buttons receive different styling.

Parameters

value - System.Boolean

The value for Primary

RETURNS

Returns the current ToolBarItemBuilder instance.

Primary()

Specifies whether the button is primary. Primary buttons receive different styling.

RETURNS

Returns the current ToolBarItemBuilder instance.

Selected(System.Boolean)

Specifies if the toggle button is initially selected. Applicable only for buttons with togglable: true.

Parameters

value - System.Boolean

The value for Selected

RETURNS

Returns the current ToolBarItemBuilder instance.

Selected()

Specifies if the toggle button is initially selected. Applicable only for buttons with togglable: true.

RETURNS

Returns the current ToolBarItemBuilder instance.

SpriteCssClass(System.String)

Defines a CSS class (or multiple classes separated by spaces) which will be used for button icon.

Parameters

value - System.String

The value for SpriteCssClass

RETURNS

Returns the current ToolBarItemBuilder instance.

Template(System.String)

Specifies what element will be added in the ToolBar wrapper. Items with template does not have a type.

Parameters

value - System.String

The value for Template

RETURNS

Returns the current ToolBarItemBuilder instance.

TemplateId(System.String)

Specifies what element will be added in the ToolBar wrapper. Items with template does not have a type.

Parameters

templateId - System.String

The ID of the template element for Template

RETURNS

Returns the current ToolBarItemBuilder instance.

TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

Specifies what element will be added in the ToolBar wrapper. Items with template does not have a type.

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for Template

RETURNS

Returns the current ToolBarItemBuilder instance.

TemplateHandler(System.String)

Specifies what element will be added in the ToolBar wrapper. Items with template does not have a type.

Parameters

templateHandler - System.String

The handler that returs the template for Template

RETURNS

Returns the current ToolBarItemBuilder instance.

Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Specifies what element will be added in the ToolBar wrapper. Items with template does not have a type.

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the template.

RETURNS

Returns the current ToolBarItemBuilder instance.

Text(System.String)

Sets the text of the button.

Parameters

value - System.String

The value for Text

RETURNS

Returns the current ToolBarItemBuilder instance.

Togglable(System.Boolean)

Specifies if the button is togglable, e.g. has a selected and unselected state.

Parameters

value - System.Boolean

The value for Togglable

RETURNS

Returns the current ToolBarItemBuilder instance.

Togglable()

Specifies if the button is togglable, e.g. has a selected and unselected state.

RETURNS

Returns the current ToolBarItemBuilder instance.

Toggle(System.String)

Specifies the toggle event handler of the button. Applicable only for commands of type button and togglable: true.

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ToolBarItemBuilder instance.

Toggle(System.Func)

Specifies the toggle event handler of the button. Applicable only for commands of type button and togglable: true.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ToolBarItemBuilder instance.

Url(System.String)

Specifies the url to navigate to.

Parameters

value - System.String

The value for Url

RETURNS

Returns the current ToolBarItemBuilder instance.

Type(Kendo.Mvc.UI.CommandType)

Specifies the type of the item.

Parameters

value - CommandType

The value for Type

RETURNS

Returns the current ToolBarItemBuilder instance.

ShowText(Kendo.Mvc.UI.ShowIn)

Specifies where the text will be displayed.

Parameters

value - ShowIn

The value for ShowText

RETURNS

Returns the current ToolBarItemBuilder instance.

ShowIcon(Kendo.Mvc.UI.ShowIn)

Specifies where the icon will be displayed.

Parameters

value - ShowIn

The value for ShowIcon

RETURNS

Returns the current ToolBarItemBuilder instance.

Overflow(Kendo.Mvc.UI.ShowInOverflowPopup)

Specifies how the button behaves when the ToolBar is resized.

Parameters

value - ShowInOverflowPopup

The value for Overflow

RETURNS

Returns the current ToolBarItemBuilder instance.

In this article
MethodsHtmlAttributes(System.Collections.Generic.IDictionary)HtmlAttributes(System.Object)Buttons(System.Action)Click(System.String)Click(System.Func)Enable(System.Boolean)Group(System.String)Hidden(System.Boolean)Hidden()Icon(System.String)Id(System.String)ImageUrl(System.String)MenuButtons(System.Action)OverflowTemplate(System.String)OverflowTemplateId(System.String)OverflowTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)OverflowTemplateHandler(System.String)OverflowTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)Primary(System.Boolean)Primary()Selected(System.Boolean)Selected()SpriteCssClass(System.String)Template(System.String)TemplateId(System.String)TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)TemplateHandler(System.String)Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)Text(System.String)Togglable(System.Boolean)Togglable()Toggle(System.String)Toggle(System.Func)Url(System.String)Type(Kendo.Mvc.UI.CommandType)ShowText(Kendo.Mvc.UI.ShowIn)ShowIcon(Kendo.Mvc.UI.ShowIn)Overflow(Kendo.Mvc.UI.ShowInOverflowPopup)
Not finding the help you need?
Contact Support