Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / ToolCallBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

ToolCallBuilder

Class

Defines the fluent API for configuring the Kendo ToolCall for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class ToolCallBuilder : WidgetBuilderBase<ToolCall, ToolCallBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<ToolCall, ToolCallBuilder>ToolCallBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<ToolCall, ToolCallBuilder>.ToComponent()WidgetBuilderBase<ToolCall, ToolCallBuilder>.Name(string)WidgetBuilderBase<ToolCall, ToolCallBuilder>.Deferred(bool)WidgetBuilderBase<ToolCall, ToolCallBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<ToolCall, ToolCallBuilder>.HtmlAttributes(object)WidgetBuilderBase<ToolCall, ToolCallBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<ToolCall, ToolCallBuilder>.AsModule(bool)WidgetBuilderBase<ToolCall, ToolCallBuilder>.Render()WidgetBuilderBase<ToolCall, ToolCallBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<ToolCall, ToolCallBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<ToolCall, ToolCallBuilder>.ToHtmlString()WidgetBuilderBase<ToolCall, ToolCallBuilder>.ToClientTemplate()WidgetBuilderBase<ToolCall, ToolCallBuilder>.ToString()WidgetBuilderBase<ToolCall, ToolCallBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ToolCallBuilder(ToolCall)

Initializes a new instance of the ToolCall class.

C#
public ToolCallBuilder(ToolCall component)
Parameters:componentToolCall

The component.

Methods

ApprovalTemplate<TModel>(TemplateBuilder<TModel>)

A function used to render the entire approval section when state is "awaitingApproval". Receives the widget options object as the first argument and must return an HTML string. When set, the built-in approve and reject buttons are not rendered.

C#
public ToolCallBuilder ApprovalTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the approvaltemplate.

Returns:

ToolCallBuilder

ApprovalTemplateHandler(string)

A function used to render the entire approval section when state is "awaitingApproval". Receives the widget options object as the first argument and must return an HTML string. When set, the built-in approve and reject buttons are not rendered.

C#
public ToolCallBuilder ApprovalTemplateHandler(string value)
Parameters:valuestring

The value that configures the approvaltemplate.

Returns:

ToolCallBuilder

ApprovalText(string)

A text message displayed inside the approval card when state is "awaitingApproval".

C#
public ToolCallBuilder ApprovalText(string value)
Parameters:valuestring

The value that configures the approvaltext.

Returns:

ToolCallBuilder

ErrorTemplate<TModel>(TemplateBuilder<TModel>)

A function used to render the entire error section when state is "error". Receives the widget options object as the first argument and must return an HTML string. When set, the built-in error message box is not rendered.

C#
public ToolCallBuilder ErrorTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the errortemplate.

Returns:

ToolCallBuilder

ErrorTemplateHandler(string)

A function used to render the entire error section when state is "error". Receives the widget options object as the first argument and must return an HTML string. When set, the built-in error message box is not rendered.

C#
public ToolCallBuilder ErrorTemplateHandler(string value)
Parameters:valuestring

The value that configures the errortemplate.

Returns:

ToolCallBuilder

ErrorText(string)

An error message displayed when state is "error".

C#
public ToolCallBuilder ErrorText(string value)
Parameters:valuestring

The value that configures the errortext.

Returns:

ToolCallBuilder

Events(Action<ToolCallEventBuilder>)

Configures the client-side events.

C#
public ToolCallBuilder Events(Action<ToolCallEventBuilder> configurator)
Parameters:configuratorAction<ToolCallEventBuilder>

The client events action.

Returns:

ToolCallBuilder

Example:
C#
@(Html.Kendo().ToolCall()
.Name("ToolCall")
.Events(events =&gt; events
.ExpandedChange("onExpandedChange")
)
)

Expandable(bool)

Enables toggling the visibility of the step body by clicking the header or using the keyboard.

C#
public ToolCallBuilder Expandable(bool value)
Parameters:valuebool

The value that configures the expandable.

Returns:

ToolCallBuilder

Expanded(bool)

Controls whether the step body is visible when the widget initializes.

C#
public ToolCallBuilder Expanded(bool value)
Parameters:valuebool

The value that configures the expanded.

Returns:

ToolCallBuilder

Label(string)

The primary text label displayed in the step header.

C#
public ToolCallBuilder Label(string value)
Parameters:valuestring

The value that configures the label.

Returns:

ToolCallBuilder

Messages(Action<ToolCallMessagesSettingsBuilder>)

Contains the localizable text strings used by the widget.

C#
public ToolCallBuilder Messages(Action<ToolCallMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<ToolCallMessagesSettingsBuilder>

The action that configures the messages.

Returns:

ToolCallBuilder

Parameters(object)

A plain JavaScript object rendered as formatted JSON in the step body under the parameters label.

C#
public ToolCallBuilder Parameters(object value)
Parameters:valueobject

The value that configures the parameters.

Returns:

ToolCallBuilder

ParametersTemplate<TModel>(TemplateBuilder<TModel>)

A function used to render the parameters section body. Receives the widget options object as the first argument and must return an HTML string.

C#
public ToolCallBuilder ParametersTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the parameterstemplate.

Returns:

ToolCallBuilder

ParametersTemplateHandler(string)

A function used to render the parameters section body. Receives the widget options object as the first argument and must return an HTML string.

C#
public ToolCallBuilder ParametersTemplateHandler(string value)
Parameters:valuestring

The value that configures the parameterstemplate.

Returns:

ToolCallBuilder

Result(object)

A plain JavaScript object rendered as formatted JSON in the step body under the result label.

C#
public ToolCallBuilder Result(object value)
Parameters:valueobject

The value that configures the result.

Returns:

ToolCallBuilder

ResultTemplate<TModel>(TemplateBuilder<TModel>)

A function used to render the result section body. Receives the widget options object as the first argument and must return an HTML string.

C#
public ToolCallBuilder ResultTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the resulttemplate.

Returns:

ToolCallBuilder

ResultTemplateHandler(string)

A function used to render the result section body. Receives the widget options object as the first argument and must return an HTML string.

C#
public ToolCallBuilder ResultTemplateHandler(string value)
Parameters:valuestring

The value that configures the resulttemplate.

Returns:

ToolCallBuilder

SecondaryLabel(string)

A secondary text label displayed after the separator in the step header.

C#
public ToolCallBuilder SecondaryLabel(string value)
Parameters:valuestring

The value that configures the secondarylabel.

Returns:

ToolCallBuilder

State(ToolCallState)

The current state of the tool call.

C#
public ToolCallBuilder State(ToolCallState value)
Parameters:valueToolCallState

The value that configures the state.

Returns:

ToolCallBuilder

StatusSVGIcon(string)

Overrides the default SVG icon used inside the state badge. When null, a built-in icon is chosen based on the current state.

C#
public ToolCallBuilder StatusSVGIcon(string value)
Parameters:valuestring

The value that configures the statussvgicon.

Returns:

ToolCallBuilder

SvgIcon(string)

The name of the SVG icon displayed in the step header.

C#
public ToolCallBuilder SvgIcon(string value)
Parameters:valuestring

The value that configures the svgicon.

Returns:

ToolCallBuilder

In this article
DefinitionConstructorsToolCallBuilder(ToolCall)MethodsApprovalTemplate<TModel>(TemplateBuilder<TModel>)ApprovalTemplateHandler(string)ApprovalText(string)ErrorTemplate<TModel>(TemplateBuilder<TModel>)ErrorTemplateHandler(string)ErrorText(string)Events(Action<ToolCallEventBuilder>)Expandable(bool)Expanded(bool)Label(string)Messages(Action<ToolCallMessagesSettingsBuilder>)Parameters(object)ParametersTemplate<TModel>(TemplateBuilder<TModel>)ParametersTemplateHandler(string)Result(object)ResultTemplate<TModel>(TemplateBuilder<TModel>)ResultTemplateHandler(string)SecondaryLabel(string)State(ToolCallState)StatusSVGIcon(string)SvgIcon(string)
Not finding the help you need?
Contact Support