CheckpointBuilder
Properties
WriteAction - Func
Methods
TemplateHandler(System.String)
A function used to render the entire checkpoint body, replacing the default button layout. Called with an empty object and must return an HTML string.
Parameters
templateHandler - System.String
The handler that returs the template for Template
RETURNS
Returns the current CheckpointBuilder instance.
Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)
A function used to render the entire checkpoint body, replacing the default button layout. Called with an empty object and must return an HTML string.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the template.
RETURNS
Returns the current CheckpointBuilder instance.
Messages(System.Action)
Contains the localizable text strings used by the widget.
Parameters
configurator - System.Action<CheckpointMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of CheckpointBuilder .
State(Kendo.Mvc.UI.CheckpointState)
The current action state of the checkpoint.
Parameters
value - CheckpointState
The value for State
RETURNS
Returns the current CheckpointBuilder instance.
DisplayMode(Kendo.Mvc.UI.CheckpointDisplayMode)
Controls when the checkpoint button is visible.
Parameters
value - CheckpointDisplayMode
The value for DisplayMode
RETURNS
Returns the current CheckpointBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<CheckpointEventBuilder>
The client events action.
RETURNS
Returns the current CheckpointBuilder instance.
Example
@(Html.Kendo().Checkpoint()
.Name("Checkpoint")
.Events(events => events
.Action("onAction")
)
)
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.