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

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Class

Defines the fluent API for configuring the TaskBoardToolbarSettingsItem settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TCard

TColumn

Syntax:

public class TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> where TCard : class where TColumn : class

Inheritance: objectTaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

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

Constructors

TaskBoardToolbarSettingsItemBuilder(TaskBoardToolbarSettingsItem)

Initialize the TaskBoardToolbarSettingsItemBuilder

public TaskBoardToolbarSettingsItemBuilder(TaskBoardToolbarSettingsItem settings)

Parameters:settingsTaskBoardToolbarSettingsItem

The TaskBoardToolbarSettingsItem

Methods

Click(string)

Specifies the click handler of the button.

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Click(string value)

Parameters:valuestring

The value that configures the click.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Click("handlerName")))
)

Command(string)

Specifies the command of the button.

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Command(string value)

Parameters:valuestring

The value that configures the command.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Command("customAddCardCommand")))
)

Enable(bool)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Enable(bool value)

Parameters:valuebool

The value that configures the enable.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Enable(true)))
)

Hidden(bool)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Hidden(bool value)

Parameters:valuebool

The value that configures the hidden.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Hidden(true)))
)

HtmlAttributes(IDictionary<string, object>)

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> HtmlAttributes(IDictionary<string, object> value)

Parameters:valueIDictionary<string, object>Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

HtmlAttributes(object)

Specifies the HTML attributes of a ToolBar button.

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> HtmlAttributes(object value)

Parameters:valueobject

The value that configures the htmlattributes.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().HtmlAttributes(new { @class = "my-custom-class", id = "myAddButton", style = "color: red;" })))
)

Icon(string)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Icon(string value)

Parameters:valuestring

The value that configures the icon.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Icon("gear")))
)

Id(string)

Specifies the ID of the button.

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Id(string value)

Parameters:valuestring

The value that configures the id.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Id("toolbarItemId")))
)

ImageUrl(string)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> ImageUrl(string value)

Parameters:valuestring

The value that configures the imageurl.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().ImageUrl("imageUrl")))
)

Name(string)

Specifies the name of the button.

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Name(string value)

Parameters:valuestring

The value that configures the name.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Name("name")))
)

Options(string)

Specifies the command options of the button.

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Options(string value)

Parameters:valuestring

The value that configures the options.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Options("options")))
)

Overflow(string)

Specifies the overflow of the button.

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Overflow(string value)

Parameters:valuestring

The value that configures the overflow.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Overflow("overflow")))
)

Primary(bool)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Primary(bool value)

Parameters:valuebool

The value that configures the primary.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Primary(true)))
)

ShowIcon(string)

Specifies where the button icon will be displayed. Possible values are: "toolbar", "overflow" or "both" (default).

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> ShowIcon(string value)

Parameters:valuestring

The value that configures the showicon.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().ShowIcon("gear")))
)

ShowText(string)

Specifies where the text will be displayed. Possible values are: "toolbar", "overflow" or "both" (default).

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> ShowText(string value)

Parameters:valuestring

The value that configures the showtext.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().ShowText("text")))
)

SpriteCssClass(string)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> SpriteCssClass(string value)

Parameters:valuestring

The value that configures the spritecssclass.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().SpriteCssClass("my-sprite-class")))
)

Template(string)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Template(string value)

Parameters:valuestring

The value that configures the template.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.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 TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Template<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Template(Html.Kendo().Template().AddComponent(a =&gt; a.TextBox()))))
)

TemplateHandler(string)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> TemplateHandler(string value)

Parameters:valuestring

The value that configures the template.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().TemplateHandler("handler")))
)

TemplateId(string)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> TemplateId(string value)

Parameters:valuestring

The value that configures the template.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().TemplateId("templateId")))
)

TemplateView(MvcHtmlString)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> TemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the template.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().TemplateView(new System.Web.Mvc.MvcHtmlString("&lt;div&gt;#= ColumnName #&lt;/div&gt;"))))
)

Text(string)

Sets the text of the button.

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Text(string value)

Parameters:valuestring

The value that configures the text.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Text("customText")))
)

Togglable(bool)

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

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Togglable(bool value)

Parameters:valuebool

The value that configures the togglable.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Togglable(true)))
)

Type(string)

Specifies the type of the button.

public TaskBoardToolbarSettingsItemBuilder<TCard, TColumn> Type(string value)

Parameters:valuestring

The value that configures the type.

Returns:

TaskBoardToolbarSettingsItemBuilder<TCard, TColumn>

Example:

@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Toolbar(t =&gt; t.Items(i =&gt; i.Add().Type("button")))
)