Edit this page

ColorPicker HtmlHelper Overview

The ColorPicker HtmlHelper extension is a server-side wrapper for the Kendo UI ColorPicker widget.

Configuration

Below are listed the steps for you to follow when configuring the Kendo UI ColorPicker.

  1. Make sure you followed all the steps from the introductory article on Telerik UI for ASP.NET MVC.

  2. Create a new action method which renders the view.

    Example
        public ActionResult Index()
        {
            return View();
        }
    
  3. Add a ColorPicker.

    Example
    
            <%: Html.Kendo().ColorPicker()
                    .Name("colorpicker") //The name of the ColorPicker is mandatory. It specifies the "id" attribute of the widget.
                    .Value("#ff0000") //Set the value of the ColorPicker.
            %>
    
    
            @(Html.Kendo().ColorPicker()
                  .Name("colorpicker") //The name of the ColorPicker is mandatory. It specifies the "id" attribute of the widget.
                  .Value("#ff0000") //Set the value of the ColorPicker.
            )
    

Event Handling

You can subscribe to all ColorPicker events.

By Handler Name

The following example demonstrates how to subscribe to events by a handler name.

Example

    <%: Html.Kendo().ColorPicker()
            .Name("colorpicker")
            .Events(e => e
                .Open("colorpicker_open")
                .Close("colorpicker_close")
                .Select("colorpicker_select")
                .Change("colorpicker_change")
            )
    %>
    <script>
        function colorpicker_open() {
            //Handle the open event.
        }

        function colorpicker_close() {
            //Handle the close event.
        }

        function colorpicker_select() {
            //Handle the select event.
        }

        function colorpicker_change() {
            //Handle the change event.
        }
    </script>

    @(Html.Kendo().ColorPicker()
          .Name("colorpicker")
          .Events(e => e
                .Open("colorpicker_open")
                .Close("colorpicker_close")
                .Select("colorpicker_select")
                .Change("colorpicker_change")
          )
    )
    <script>
        function colorpicker_open() {
            //Handle the open event.
        }

        function colorpicker_close() {
            //Handle the close event.
        }

        function colorpicker_select() {
            //Handle the select event.
        }

        function colorpicker_change() {
            //Handle the change event.
        }
    </script>

By Template Delegate

The following example demonstrates how to subscribe to events by a template delegate.

Example

    @(Html.Kendo().ColorPicker()
          .Name("colorpicker")
          .Events(e => e
              .Open(@<text>
                function() {
                    //Handle the open event inline.
                }
              </text>)
              .Close(@<text>
                function() {
                    //Handle the close event inline.
                }
                </text>)
              .Select(@<text>
                function() {
                    //Handle the select event inline.
                }
                </text>)
              .Change(@<text>
                function() {
                    //Handle the change event inline.
                }
                </text>)
          )
    )

Reference

Existing Instances

To reference an existing Kendo UI ColorPicker instance, use the jQuery.data() configuration option. Once a reference is established, use the ColorPicker API to control its behavior.

Example
    //Put this after your Kendo UI ColorPicker for ASP.NET MVC declaration.
    <script>
    $(function() {
        //Notice that the Name() of the ColorPicker is used to get its client-side instance.
        var colorpicker = $("#colorpicker").data("kendoColorPicker");
    });
    </script>

See Also