Getting Started with the Switch

This tutorial explains how to set up a basic Telerik UI for ASP.NET MVC Switch and highlights the major steps in the configuration of the component.

You will initialize a Switch component with explicitly defined messages depending on its check state, and then change its appearance. Finally, you will learn how to handle the events of the Switch.

Prerequisites

To successfully complete the tutorial, you need a project that is already configured to use the Telerik UI for ASP.NET MVC components:

• To create a new pre-configured project for the Telerik UI for ASP.NET MVC components, you can use a project template.

• To manually configure an existing project by using NuGet, see the Adding Telerik UI through NuGet.

1. Prepare the CSHTML File

The first step is to add the required directives at the top of the .cshtml document:

• To use the Telerik UI for ASP.NET MVC HtmlHelpers:

  @using Kendo.Mvc.UI
  

Optionally, you can structure the document by adding the desired HTML elements like headings, divs, and paragraphs.

    @using Kendo.Mvc.UI
    <h4>Switch with a placeholder</h4>
    <div>

    </div>

2. Initialize the Switch

Use the Switch HtmlHelper to add the component to a page:

• The Name() configuration method is mandatory as its value is used for the id and the name attributes of the Switch element.

    @(Html.Kendo().Switch()
        .Name("switch")
    )

3. Configure the Messages

The next step is to explicitly define the messages functionality for the Switch. The following example will configure the messages functionality based on the checked or unchecked state of the component.

    @(Html.Kendo().Switch()
        .Name("switch")
        .Messages(c => c.Checked("YES").Unchecked("NO"))
    )

4. Customize the Appearance of Switch

To change the appearance of the Switch, use any of its built-in styling options, for example, Size(), TrackRounded() and ThumbRounded().

    @(Html.Kendo().Switch()
        .Name("switch")
        .Messages(c => c.Checked("YES").Unchecked("NO"))
        .Size(ComponentSize.Medium)
        .TrackRounded(Rounded.Full)
        .ThumbRounded(Rounded.Full)
    )

5. Handle the Switch Events

The Switch component exposes various events that you can handle and further customize the functionality of the component. In this tutorial, you will use the Change event to display a popup message when the value of the Switch changes through user interaction.

    @(Html.Kendo().Switch()
        .Name("switch")
        .Messages(c => c.Checked("YES").Unchecked("NO"))
        .Events(events => events.Change("onChange"))
        .Size(ComponentSize.Medium)
        .TrackRounded(Rounded.Full)
        .ThumbRounded(Rounded.Full)
    )

    <script>
        function onChange(e){
            alert("Changed value: "+ e.sender.value());
        }
    </script>

6. (Optional) Reference Existing Switch Instances

You can reference the Switch instances that you have created and build on top of their existing configuration:

1. Use the .Name() (id attribute) of the component instance to get a reference.

        <script>
            $(document).ready(function() {
                var switchReference = $("#switch").data("kendoSwitch"); // switchReference is a reference to the existing Switch instance of the helper.
            })
        </script>
   

2. Set the check state of the component by using the check() client-side method.

       <script>
           $(document).ready(function() {
              var switchInstance = $("#switch").kendoSwitch().data("kendoSwitch");// switchReference is a reference to the existing Switch instance of the helper.
              switchInstance.check(true); // Set the initial check state of the component.
           })
       </script>
   

Next Steps

• Customizing the Appearance of the Switch

See Also

• Using the API of the Switch for ASP.NET MVC (Demo)
• Client-Side API of the Switch
• Server-Side API of the Switch for ASP.NET MVC
• Knowledge Base Section