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

ToolBarItemButtonBuilder

Class

Defines the fluent API for configuring the ToolBarItemButton settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ToolBarItemButtonBuilder

Inheritance: objectToolBarItemButtonBuilder

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

Constructors

ToolBarItemButtonBuilder(ToolBarItemButton)

public ToolBarItemButtonBuilder(ToolBarItemButton settings)

Parameters:settingsToolBarItemButton

Methods

Click(Func<object, object>)

Specifies the click event handler of the button. Applicable only for the children of a ButtonGroup.

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

Parameters:handlerFunc<object, object>

The value that configures the click action.

Returns:

ToolBarItemButtonBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add()
.Type(CommandType.Button)
.Text("Click Me")
.Click(@
function(e) {
alert("Button clicked!");
}
);
})
)

Click(string)

Specifies the click event handler of the button. Applicable only for the children of a ButtonGroup.

public ToolBarItemButtonBuilder Click(string handler)

Parameters:handlerstring

The value that configures the click action.

Returns:

ToolBarItemButtonBuilder

Example:

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

Enable(bool)

Specifies whether the button is initially enabled or disabled.

public ToolBarItemButtonBuilder Enable(bool value)

Parameters:valuebool

The value that configures the enable.

Returns:

ToolBarItemButtonBuilder

Example:

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

Group(string)

Assigns the button to a group. Applicable only for the children of a ButtonGroup that has togglable true.

public ToolBarItemButtonBuilder Group(string value)

Parameters:valuestring

The value that configures the group.

Returns:

ToolBarItemButtonBuilder

Example:

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

Hidden(bool)

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

public ToolBarItemButtonBuilder Hidden(bool value)

Parameters:valuebool

The value that configures the hidden.

Returns:

ToolBarItemButtonBuilder

Example:

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

HtmlAttributes(IDictionary<string, object>)

Specifies the HTML attributes of a ButtonGroup's button.

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

Parameters:valueIDictionary<string, object>

The value that configures the htmlattributes.

Returns:

ToolBarItemButtonBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Type(CommandType.Button).Text("Button").HtmlAttributes(new Dictionary&lt;string, object&gt;
{
{ "class", "custom-button" },
{ "id", "customButtonId" },
{ "data-role", "button" }
});
})
)

HtmlAttributes(object)

Specifies the HTML attributes of a ButtonGroup's button.

public ToolBarItemButtonBuilder HtmlAttributes(object value)

Parameters:valueobject

The value that configures the htmlattributes.

Returns:

ToolBarItemButtonBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add().Type(CommandType.Button).Text("Button").HtmlAttributes(new { @class = "custom-button", id = "customButtonId" });
})
)

Icon(string)

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

public ToolBarItemButtonBuilder Icon(string value)

Parameters:valuestring

The value that configures the icon.

Returns:

ToolBarItemButtonBuilder

Example:

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

Id(string)

Specifies the ID of the button.

public ToolBarItemButtonBuilder Id(string value)

Parameters:valuestring

The value that configures the id.

Returns:

ToolBarItemButtonBuilder

Example:

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

ImageUrl(string)

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

public ToolBarItemButtonBuilder ImageUrl(string value)

Parameters:valuestring

The value that configures the imageurl.

Returns:

ToolBarItemButtonBuilder

Example:

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

Selected(bool)

Specifies if the toggle button is initially selected. Applicable only for the children of a ButtonGroup that has togglable true.

public ToolBarItemButtonBuilder Selected(bool value)

Parameters:valuebool

The value that configures the selected.

Returns:

ToolBarItemButtonBuilder

Example:

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

ShowIcon(ShowIn)

Specifies where the icon of the button will be displayed. Applicable only for the children of a ButtonGroup.

public ToolBarItemButtonBuilder ShowIcon(ShowIn value)

Parameters:valueShowIn

The value that configures the showicon.

Returns:

ToolBarItemButtonBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add()
.Type(CommandType.Button)
.Text("Toggle Me");
.ShowIcon(ShowIn.Overflow);
})
)

ShowText(ShowIn)

Specifies where the text of the menu button will be displayed. Applicable only for the buttons of a ButtonGroup.

public ToolBarItemButtonBuilder ShowText(ShowIn value)

Parameters:valueShowIn

The value that configures the showtext.

Returns:

ToolBarItemButtonBuilder

Example:

@(Html.Kendo().ToolBar()
.Name("toolBar")
.Items(items =&gt;
{
items.Add()
.Type(CommandType.Button)
.Text("Toggle Me");
.ShowText(ShowIn.Overflow);
})
)

SpriteCssClass(string)

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

public ToolBarItemButtonBuilder SpriteCssClass(string value)

Parameters:valuestring

The value that configures the spritecssclass.

Returns:

ToolBarItemButtonBuilder

Example:

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

Text(string)

Specifies the text of the menu button.

public ToolBarItemButtonBuilder Text(string value)

Parameters:valuestring

The value that configures the text.

Returns:

ToolBarItemButtonBuilder

Example:

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

Togglable(bool)

Specifies if the button is togglable, e.g. has a selected and unselected state. Applicable only for the children of a ButtonGroup.

public ToolBarItemButtonBuilder Togglable(bool value)

Parameters:valuebool

The value that configures the togglable.

Returns:

ToolBarItemButtonBuilder

Example:

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

Toggle(Func<object, object>)

Specifies the toggle event handler of the button. Applicable only for the children of a ButtonGroup.

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

Parameters:handlerFunc<object, object>

The value that configures the toggle action.

Returns:

ToolBarItemButtonBuilder

Example:

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

Toggle(string)

Specifies the toggle event handler of the button. Applicable only for the children of a ButtonGroup.

public ToolBarItemButtonBuilder Toggle(string handler)

Parameters:handlerstring

The value that configures the toggle action.

Returns:

ToolBarItemButtonBuilder

Example:

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

Url(string)

Specifies the url of the button to navigate to.

public ToolBarItemButtonBuilder Url(string value)

Parameters:valuestring

The value that configures the url.

Returns:

ToolBarItemButtonBuilder

Example:

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