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

ToolBarItemBuilder

Class

Defines the fluent API for configuring the ToolBarItem settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ToolBarItemBuilder

Inheritance: objectToolBarItemBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ToolBarItemBuilder(ToolBarItem)

public ToolBarItemBuilder(ToolBarItem settings)

Parameters:settingsToolBarItem

Methods

Buttons(Action<ToolBarItemButtonFactory>)

Specifies the buttons of ButtonGroup.

public ToolBarItemBuilder Buttons(Action<ToolBarItemButtonFactory> configurator)

Parameters:configuratorAction<ToolBarItemButtonFactory>

The action that configures the buttons.

Returns:

ToolBarItemBuilder

Click(Func<object, object>)

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

public ToolBarItemBuilder Click(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The value that configures the click action.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Click(@&lt;text&gt;
function(e) {
// Handle the Click event inline.
}
&lt;/text&gt;);
})
)

Click(string)

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

public ToolBarItemBuilder Click(string handler)

Parameters:handlerstring

The value that configures the click action.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Click("onClick");
})
)

Enable(bool)

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

public ToolBarItemBuilder Enable(bool value)

Parameters:valuebool

The value that configures the enable.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Enable(false);
})
)

Group(string)

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

public ToolBarItemBuilder Group(string value)

Parameters:valuestring

The value that configures the group.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Group("groupName");
})
)

Hidden(bool)

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

public ToolBarItemBuilder Hidden(bool value)

Parameters:valuebool

The value that configures the hidden.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Hidden(true);
})
)

HtmlAttributes(IDictionary<string, object>)

public ToolBarItemBuilder HtmlAttributes(IDictionary<string, object> value)

Parameters:valueIDictionary<string, object>Returns:

ToolBarItemBuilder

HtmlAttributes(object)

Specifies the HTML attributes of a ToolBar button.

public ToolBarItemBuilder HtmlAttributes(object value)

Parameters:valueobject

The value that configures the htmlattributes.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Type(CommandType.Button).Text("Button").HtmlAttributes(new {@class="myClass"});
})
)

Icon(string)

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

public ToolBarItemBuilder Icon(string value)

Parameters:valuestring

The value that configures the icon.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Icon("gear");
})
)

Id(string)

Specifies the ID of the button.

public ToolBarItemBuilder Id(string value)

Parameters:valuestring

The value that configures the id.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Id("itemId");
})
)

ImageUrl(string)

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

public ToolBarItemBuilder ImageUrl(string value)

Parameters:valuestring

The value that configures the imageurl.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().ImageUrl("imageUrl");
})
)

MenuButtons(Action<ToolBarItemMenuButtonFactory>)

Specifies the menu buttons of a SplitButton or a DropDownButton.

public ToolBarItemBuilder MenuButtons(Action<ToolBarItemMenuButtonFactory> configurator)

Parameters:configuratorAction<ToolBarItemMenuButtonFactory>

The action that configures the menubuttons.

Returns:

ToolBarItemBuilder

Overflow(ShowInOverflowPopup)

Specifies how the button behaves when the ToolBar is resized.

public ToolBarItemBuilder Overflow(ShowInOverflowPopup value)

Parameters:valueShowInOverflowPopup

The value that configures the overflow.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Overflow(ShowInOverflowPopup.Auto);
})
)

OverflowTemplate(string)

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

public ToolBarItemBuilder OverflowTemplate(string value)

Parameters:valuestring

The value that configures the overflowtemplate.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().OverflowTemplate("&lt;span&gt;Overflow template&lt;/span&gt;");
})
)

OverflowTemplate<TModel>(TemplateBuilder<TModel>)

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

public ToolBarItemBuilder OverflowTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the overflowtemplate.

Returns:

ToolBarItemBuilder

OverflowTemplateHandler(string)

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

public ToolBarItemBuilder OverflowTemplateHandler(string value)

Parameters:valuestring

The value that configures the overflowtemplate.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().OverflowTemplateHandler("handler");
})
)

OverflowTemplateId(string)

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

public ToolBarItemBuilder OverflowTemplateId(string value)

Parameters:valuestring

The value that configures the overflowtemplate.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().OverflowTemplateId("overflowTemplateId");
})
)

OverflowTemplateView(MvcHtmlString)

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

public ToolBarItemBuilder OverflowTemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the overflowtemplate.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().OverflowTemplateView(Html.Partial("YourPartialViewName"));
})
)

Primary(bool)

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

public ToolBarItemBuilder Primary(bool value)

Parameters:valuebool

The value that configures the primary.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Primary(true);
})
)

Selected(bool)

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

public ToolBarItemBuilder Selected(bool value)

Parameters:valuebool

The value that configures the selected.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Selected(true);
})
)

ShowIcon(ShowIn)

Specifies where the icon will be displayed.

public ToolBarItemBuilder ShowIcon(ShowIn value)

Parameters:valueShowIn

The value that configures the showicon.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().ShowIcon(ShowIn.Overflow);
})
)

ShowText(ShowIn)

Specifies where the text will be displayed.

public ToolBarItemBuilder ShowText(ShowIn value)

Parameters:valueShowIn

The value that configures the showtext.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().ShowText(ShowIn.Overflow);
})
)

SpriteCssClass(string)

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

public ToolBarItemBuilder SpriteCssClass(string value)

Parameters:valuestring

The value that configures the spritecssclass.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().SpriteCssClass("k-icon k-font-icon k-i-refresh");
})
)

Template(string)

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

public ToolBarItemBuilder Template(string value)

Parameters:valuestring

The value that configures the template.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Template("template");
})
)

Template<TModel>(TemplateBuilder<TModel>)

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

public ToolBarItemBuilder Template<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

ToolBarItemBuilder

TemplateHandler(string)

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

public ToolBarItemBuilder TemplateHandler(string value)

Parameters:valuestring

The value that configures the template.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().TemplateHandler("handler");
})
)

TemplateId(string)

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

public ToolBarItemBuilder TemplateId(string value)

Parameters:valuestring

The value that configures the template.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().TemplateId("templateId");
})
)

TemplateView(MvcHtmlString)

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

public ToolBarItemBuilder TemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the template.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().TemplateView(Html.Partial("YourPartialViewName"));
})
)

Text(string)

Sets the text of the button.

public ToolBarItemBuilder Text(string value)

Parameters:valuestring

The value that configures the text.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Text("itemText");
})
)

Togglable(bool)

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

public ToolBarItemBuilder Togglable(bool value)

Parameters:valuebool

The value that configures the togglable.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Type(CommandType.Button).Togglable(true);
})
)

Toggle(Func<object, object>)

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

public ToolBarItemBuilder Toggle(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The value that configures the toggle action.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Type(CommandType.Button).Togglable(true).Toggle(@
function(e) {
console.log("Button toggled", e);
}
);
})
)

Toggle(string)

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

public ToolBarItemBuilder Toggle(string handler)

Parameters:handlerstring

The value that configures the toggle action.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Type(CommandType.Button).Togglable(true).Toggle("handler");
})
)

Type(CommandType)

Specifies the type of the item.

public ToolBarItemBuilder Type(CommandType value)

Parameters:valueCommandType

The value that configures the type.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Type(CommandType.Button);
})
)

Url(string)

Specifies the url to navigate to.

public ToolBarItemBuilder Url(string value)

Parameters:valuestring

The value that configures the url.

Returns:

ToolBarItemBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Url("url");
})
)