CheckBoxBuilder

Properties

WriteAction - Func

Methods

Enable(System.Boolean)

If set to false, the CheckBox will be disabled and will not allow the user to change its checked state.

Parameters

value - System.Boolean

The value for Enabled

RETURNS

Returns the current instance of CheckBoxBuilder for method chaining.

Example

Razor
 
                @(Html.Kendo().CheckBox()
                       .Name("checkbox")
                       .Enable(false)
                )
             

Checked(System.Boolean)

The checked state of the CheckBox.

Parameters

value - System.Boolean

The value for Checked

RETURNS

Returns the current CheckBoxBuilder instance.

Checked()

The checked state of the CheckBox.

RETURNS

Returns the current CheckBoxBuilder instance.

Encoded(System.Boolean)

Determines whether the checkbox label content should be rendered as an HTML string or it should be encoded.

Parameters

value - System.Boolean

The value for Encoded

RETURNS

Returns the current CheckBoxBuilder instance.

Label(System.String)

Specifies the label content for the checkbox.

Parameters

value - System.String

The value for Label

RETURNS

Returns the current CheckBoxBuilder instance.

Size(Kendo.Mvc.UI.ComponentSize)

Sets a value controlling the size of the component.

Parameters

value - ComponentSize

The value for Size

RETURNS

Returns the current CheckBoxBuilder instance.

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value for Rounded

RETURNS

Returns the current CheckBoxBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<CheckBoxEventBuilder>

The client events action.

RETURNS

Returns the current CheckBoxBuilder instance.

Example

Razor
 
            @(Html.Kendo().CheckBox()
                  .Name("CheckBox")
                  .Events(events => events
                      .Change("onChange")
                  )
            )
             

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

RETURNS

Returns the current instance.

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

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

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.