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

GridActionCommandBuilderBase<TCommand, TBuilder>

Class

Defines the fluent interface for configuring command.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TCommand

The type of the command.

TBuilder

The type of the builder.

Syntax:

public abstract class GridActionCommandBuilderBase<TCommand, TBuilder> where TCommand : GridActionCommandBase where TBuilder : GridActionCommandBuilderBase<TCommand, TBuilder>

Inheritance: objectGridActionCommandBuilderBase<TCommand, TBuilder>

Derived Classes: GridCustomActionCommandBuilder<T>GridDestroyActionCommandBuilderGridEditActionCommandBuilderGridSelectActionCommandBuilder

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

Constructors

GridActionCommandBuilderBase(TCommand)

Initializes a new instance of the GridActionCommandBuilderBase<TCommand, TBuilder> class.

public GridActionCommandBuilderBase(TCommand command)

Parameters:commandTCommand

The command.

Properties

Command

TCommand

protected TCommand Command { get; }

Methods

HtmlAttributes(IDictionary<string, object>)

Sets the HTML attributes.

public TBuilder HtmlAttributes(IDictionary<string, object> attributes)

Parameters:attributesIDictionary<string, object>

The HTML attributes.

Returns:

TBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Command(cmd=&gt;cmd.Custom("Button").HtmlAttributes(new Dictionary&lt;string, object&gt;() {  }));
}))

HtmlAttributes(object)

Sets the HTML attributes.

public TBuilder HtmlAttributes(object attributes)

Parameters:attributesobject

The HTML attributes.

Returns:

TBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Command(cmd=&gt;cmd.Custom("Button").HtmlAttributes(new { @class="myClass" }));
}))

HtmlAttributes(string)

Sets the HTML attributes.

public TBuilder HtmlAttributes(string attributesHandler)

Parameters:attributesHandlerstring

The HTML attributes.

Returns:

TBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Command(cmd=&gt;cmd.Custom("Button").HtmlAttributes("attributesHandler"));
}))

IconClass(string)

The class for the web font icon of the button.

public TBuilder IconClass(string iconClass)

Parameters:iconClassstring

The class for the web font icon of the button

Returns:

TBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Command(cmd=&gt;cmd.Custom("Button").IconClass("k-icon k-i-check"));
}))

Template(string)

The template of the command column.

public TBuilder Template(string value)

Parameters:valuestring

The value that configures the template.

Returns:

TBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Command(cmd=&gt;cmd.Custom("Button").Template("Button Template"));
}))

Template<T>(TemplateBuilder<T>)

Sets the template of the command column.

public TBuilder Template<T>(TemplateBuilder<T> template)

Parameters:templateTemplateBuilder<T>

The template component

Returns:

TBuilder

Example:

@(Html.Kendo().Grid&lt;User&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).Template(Html.Kendo().Template()
.AddHtml(
@&lt;text&gt;
Value
@Html.TextBox("value")
&lt;/text&gt;
)
);
})
)

TemplateHandler(string)

The name of the JavaScript function that returns the template of the command column.

public TBuilder TemplateHandler(string value)

Parameters:valuestringReturns:

TBuilder

TemplateId(string)

The template of the command column.

public TBuilder TemplateId(string value)

Parameters:valuestring

The value that configures the template.

Returns:

TBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Command(cmd=&gt;cmd.Custom("Button").TemplateId("TemplateId"));
}))

TemplateView(MvcHtmlString)

The template of the command column.

public TBuilder TemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the template.

Returns:

TBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Command(cmd=&gt;cmd.Custom("Button").TemplateView(Html.Partial("CommandTemplate")));
}))

Text(string)

Sets the text displayed by the command. If not set a default value is used.

public TBuilder Text(string text)

Parameters:textstring

The text which should be displayed

Returns:

TBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Command(cmd=&gt;cmd.Custom("Button").Text("Text"));
}))

Visible(Func<object, object>)

Sets the visible function which will determine if the command button will render.

public TBuilder Visible(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The visible function.

Returns:

TBuilder

Visible(string)

Sets the visible function which will determine if the command button will render.

public TBuilder Visible(string handler)

Parameters:handlerstring

The visible function.

Returns:

TBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Command(cmd=&gt;cmd.Custom("Button").Visible("handlerName"));
}))