ToolCallBuilder
Properties
WriteAction - Func
Methods
SvgIcon(System.String)
The name of the SVG icon displayed in the step header.
Parameters
value - System.String
The value for SvgIcon
RETURNS
Returns the current ToolCallBuilder instance.
Label(System.String)
The primary text label displayed in the step header.
Parameters
value - System.String
The value for Label
RETURNS
Returns the current ToolCallBuilder instance.
SecondaryLabel(System.String)
A secondary text label displayed after the separator in the step header.
Parameters
value - System.String
The value for SecondaryLabel
RETURNS
Returns the current ToolCallBuilder instance.
Expandable(System.Boolean)
Enables toggling the visibility of the step body by clicking the header or using the keyboard.
Parameters
value - System.Boolean
The value for Expandable
RETURNS
Returns the current ToolCallBuilder instance.
Expandable()
Enables toggling the visibility of the step body by clicking the header or using the keyboard.
RETURNS
Returns the current ToolCallBuilder instance.
Expanded(System.Boolean)
Controls whether the step body is visible when the widget initializes.
Parameters
value - System.Boolean
The value for Expanded
RETURNS
Returns the current ToolCallBuilder instance.
Expanded()
Controls whether the step body is visible when the widget initializes.
RETURNS
Returns the current ToolCallBuilder instance.
Parameters(System.Object)
A plain JavaScript object rendered as formatted JSON in the step body under the parameters label.
Parameters
value - System.Object
The value for Parameters
RETURNS
Returns the current ToolCallBuilder instance.
Result(System.Object)
A plain JavaScript object rendered as formatted JSON in the step body under the result label.
Parameters
value - System.Object
The value for Result
RETURNS
Returns the current ToolCallBuilder instance.
ApprovalText(System.String)
A text message displayed inside the approval card when state is "awaitingApproval".
Parameters
value - System.String
The value for ApprovalText
RETURNS
Returns the current ToolCallBuilder instance.
ErrorText(System.String)
An error message displayed when state is "error".
Parameters
value - System.String
The value for ErrorText
RETURNS
Returns the current ToolCallBuilder instance.
StatusSVGIcon(System.String)
Overrides the default SVG icon used inside the state badge. When null, a built-in icon is chosen based on the current state.
Parameters
value - System.String
The value for StatusSVGIcon
RETURNS
Returns the current ToolCallBuilder instance.
ParametersTemplateHandler(System.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.
Parameters
templateHandler - System.String
The handler that returs the template for ParametersTemplate
RETURNS
Returns the current ToolCallBuilder instance.
ParametersTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
A function used to render the parameters section body. Receives the widget options object as the first argument and must return an HTML string.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the parameterstemplate.
RETURNS
Returns the current ToolCallBuilder instance.
ApprovalTemplateHandler(System.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.
Parameters
templateHandler - System.String
The handler that returs the template for ApprovalTemplate
RETURNS
Returns the current ToolCallBuilder instance.
ApprovalTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
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.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the approvaltemplate.
RETURNS
Returns the current ToolCallBuilder instance.
ResultTemplateHandler(System.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.
Parameters
templateHandler - System.String
The handler that returs the template for ResultTemplate
RETURNS
Returns the current ToolCallBuilder instance.
ResultTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
A function used to render the result section body. Receives the widget options object as the first argument and must return an HTML string.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the resulttemplate.
RETURNS
Returns the current ToolCallBuilder instance.
ErrorTemplateHandler(System.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.
Parameters
templateHandler - System.String
The handler that returs the template for ErrorTemplate
RETURNS
Returns the current ToolCallBuilder instance.
ErrorTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
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.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the errortemplate.
RETURNS
Returns the current ToolCallBuilder instance.
Messages(System.Action)
Contains the localizable text strings used by the widget.
Parameters
configurator - System.Action<ToolCallMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of ToolCallBuilder .
State(Kendo.Mvc.UI.ToolCallState)
The current state of the tool call.
Parameters
value - ToolCallState
The value for State
RETURNS
Returns the current ToolCallBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<ToolCallEventBuilder>
The client events action.
RETURNS
Returns the current ToolCallBuilder instance.
Example
@(Html.Kendo().ToolCall()
.Name("ToolCall")
.Events(events => events
.ExpandedChange("onExpandedChange")
)
)
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
The name.
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
The name.
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with Kendo.Mvc.UI.Fluent.WidgetFactory.DeferredScripts(System.Boolean,System.Boolean)
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.