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

ToggleButton

Class

Kendo UI ToggleButton component

Definition

Namespace:Kendo.Mvc.UI

Assembly:Kendo.Mvc.dll

Syntax:

public class ToggleButton : WidgetBase, IWidget, IHtmlAttributesContainer, IScriptableComponent

Inheritance: objectWidgetBaseToggleButton

Implements: IHtmlAttributesContainerIScriptableComponentIWidget

Inherited Members WidgetBase.Render()WidgetBase.VerifySettings()WidgetBase.ToHtmlString()WidgetBase.GetHtml(bool)WidgetBase.GetInitializator()WidgetBase.WriteLicensingScript(TextWriter)WidgetBase.SerializeSettings()WidgetBase.WriteDeferredStyles(TextWriter)WidgetBase.DeferStyles()WidgetBase.ToClientTemplate()WidgetBase.WriteTrialMessage(HtmlTextWriter)WidgetBase.InitializerWidgetBase.EventsWidgetBase.NameWidgetBase.IdWidgetBase.ShouldSanitezeIdWidgetBase.ModelMetadataWidgetBase.HtmlAttributesWidgetBase.ScriptAttributesWidgetBase.ViewContextWidgetBase.ViewDataWidgetBase.IsSelfInitializedWidgetBase.IsInClientTemplateWidgetBase.HasDeferredInitializationWidgetBase.SelectorWidgetBase.HasClientComponentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ToggleButton(ViewContext, IJavaScriptInitializer, IUrlGenerator)

Initializes a new instance of the ToggleButton class.

public ToggleButton(ViewContext viewContext, IJavaScriptInitializer initializer, IUrlGenerator urlGenerator)

Parameters:viewContextViewContext

The view context

initializerIJavaScriptInitializer

The JavaScriptInitializer

urlGeneratorIUrlGenerator

The URL generator.

If set to true a default overlay badge will be displayed. If set to a string, an overlay with content set to the specified string will be displayed. Can be set to a JavaScript object which represents the configuration of the Badge widget.

public ToggleButtonBadgeSettings Badge { get; set; }

Enable

bool?

Sets whether the component should be enabled or disabled.

public bool? Enable { get; set; }

FillMode

FillMode?

Sets a value controlling how the color is applied.

public FillMode? FillMode { get; set; }

Group

string

Specifies a group of ToggleButtons the current instance belongs to. The string will be rendered as a value of the data-group attribute of the widget's element.

public string Group { get; set; }

Icon

string

Sets the icon of the component.

public string Icon { get; set; }

IconClass

string

Sets the icon class of the component.

public string IconClass { get; set; }

ImageUrl

string

Sets the image url for the and img element inside the component.

public string ImageUrl { get; set; }

Rounded

Rounded?

Sets a value controlling the border radius.

public Rounded? Rounded { get; set; }

Selected

bool?

Specifies the selected state of the ToggleButtons. If set to true the widget will be initially selected.

public bool? Selected { get; set; }

Size

ButtonSize?

Sets the size of the component.

public ButtonSize? Size { get; set; }

SpriteCssClass

string

Sets the CSS class, which will be used for applying a background image to a span element inside the component.

public string SpriteCssClass { get; set; }

Tag

string

Specifies the ToggleButton HTML tag.

public string Tag { get; set; }

Template

HtmlTemplate

Specifies the button content.

public HtmlTemplate Template { get; set; }

ThemeColor

ThemeColor?

Sets the color of the component according to the applied theme.

public ThemeColor? ThemeColor { get; set; }

Methods

Serialize()

public override IDictionary<string, object> Serialize()

Returns:

IDictionary<string, object>

Overrides: WidgetBase.Serialize()

WriteHtml(HtmlTextWriter)

Writes the HTML.

protected override void WriteHtml(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

The HtmlTextWriter.

Overrides: WidgetBase.WriteHtml(HtmlTextWriter)

WriteInitializationScript(TextWriter)

Writes the initialization script.

public override void WriteInitializationScript(TextWriter writer)

Parameters:writerTextWriter

The TextWriter.

Overrides: WidgetBase.WriteInitializationScript(TextWriter)