New to Kendo UI for jQuery? Download free 30-day trial

Methods and Events

All Kendo UI widgets provide methods and events that you can use to query or modify their state at runtime.

Using the Methods

To start using the methods provided by Kendo UI widgets:

  1. Reference a specific widget instance
  2. Call the methods

Referencing Specific Widget Instances

To obtain a reference to the specific widget instance, either use the jQuery data method, or the getKendo<WidgetName> method.

  • The Kendo UI widgets are jQuery plugins. A common way to get a reference to a widget instance is to use the jQuery data method with the jQuery object of the widget element, and pass the plugin name as a string.

        <p>Animal: <input id="animal" /></p>
    
        <script>
            $(function() {
              // Create a new widget instance.
              $("#animal").kendoAutoComplete({ dataSource: [ "Ant", "Antilope", "Badger", "Beaver", "Bird" ] });
    
              // Retrieve the widget instance.
              var autoComplete = $("#animal").data("kendoAutoComplete");
    
              console.log(autoComplete);
            });
        </script>
    
  • To get a reference to a widget instance, you may also use the getKendo<WidgetName> method. Note that the jQuery convention of returning the selected DOM element applies to widget initialization plugin methods too. This means that the plugin method, for example kendoAutoComplete(), does not return the widget instance, but the jQuery object of the element.

        <p>Animal: <input id="animal" /></p>
    
        <script>
            $(function() {
              // Create a new widget instance.
              $("#animal").kendoAutoComplete({ dataSource: [ "Ant", "Antilope", "Badger", "Beaver", "Bird" ] });
    
              // Retrieve the widget instance.
              var autoComplete = $("#animal").getKendoAutoComplete();
    
              console.log(autoComplete);
            });
        </script>
    
  • If the code which will return a widget instance returns undefined, then the widget might still not be initialized or the selector can be wrong or missing. A common example is when a widget is created in a document.ready handler but the widget instance is referenced from code that was executed earlier.

Calling Methods

After the widget instance is available, you can call its methods by using the standard JavaScript method syntax. The complete list and examples of the widget methods and method parameters is available in the API reference section.

The following example demonstrates how to call the focus method of the AutoComplete.

        <p>Animal: <input id="animal" /></p>

        <script>
            $(function() {
              $("#animal").kendoAutoComplete({ dataSource: [ "Ant", "Antilope", "Badger", "Beaver", "Bird" ] });
              var autoComplete = $("#animal").data("kendoAutoComplete");

              // Focus the widget by calling the focus() method.
              autoComplete.focus();
            });
        </script>

Handling Widget Events

By design and as a good practice, Kendo UI does not fire an event when the corresponding method is invoked. For example, the select event of the Kendo UI PanelBar widget is not fired if you call the select method through the API.

You can bind events either during widget initialization or after widget initialization.

When you work with the events of the Kendo UI widgets, you can also:

Binding Events during Initialization

Event handlers which are attached during the initialization of the widget will be executed every time the event is fired. To execute the handler only once, attach it after the widget initialization with the one method.

The following example demonstrates how to bind events during widget initialization.

    <p>Animal: <input id="animal" /></p>

    <script>
        $(function() {

          $("#animal").kendoAutoComplete({
              dataSource: [ "Ant", "Antilope", "Badger", "Beaver", "Bird" ],
              change: function(e) {
                console.log("change event handler");
              }
          });

        });
    </script>

Binding Events after Initialization

All Kendo UI widgets provide the bind and the one method. Both methods attach event handlers to already existing widget instances but the event handlers that are attached with one will be executed only once.

    <p>Animal: <input id="animal" /></p>

    <script>
        $(function() {

          $("#animal").kendoAutoComplete({
              dataSource: [ "Ant", "Antilope", "Badger", "Beaver", "Bird" ]
          });

          // ...

          var autocomplete = $("#animal").data("kendoAutoComplete");

          // Attach an event handler that will be executed each time the event is fired.
          autocomplete.bind("change", function(e) {
                console.log("change event handler");
          });

          // Attach an event handler that will be executed only the first time the event is fired.
          autocomplete.one("open", function(e) {
                console.log("open event handler");
          });

        });
    </script>

Using Event Handler Arguments

Each Kendo UI widget passes a single argument to the event handler—the so-called "event object". Usually, it has one or more fields which contain specific information for the event. All event objects have a sender field which provides a reference to the widget instance that triggered the event. Passing additional custom event arguments to the handler is not supported. The full list and examples of the widget events and the fields in the event objects is available in the API reference section.

    <p>Animal: <input id="animal" /></p>

    <script>
        $(function() {

          $("#animal").kendoAutoComplete({
              dataSource: [ "Ant", "Antilope", "Badger", "Beaver", "Bird" ],
              open: function(e) {
                var autocomplete = e.sender;
              }
          });

        });
    </script>

Preventing Events

Certain widget events can be prevented by calling the preventDefault method of the event object. The effect of the event prevention is specific for each event and is documented in the API reference.

    <p>Animal: <input id="animal" /></p>

    <script>
        $(function() {
          $("#animal").kendoAutoComplete({
              dataSource: [ "Ant", "Antilope", "Badger", "Beaver", "Bird" ]
          });

          var autoComplete = $("#animal").data("kendoAutoComplete");

          // Prevent the AutoComplete from opening the suggestions list.
          autoComplete.bind('open', function(e) {
            e.preventDefault();
          });
        });
    </script>

Unbinding from Events

To unbind from a specific event, keep a reference to the event handler function and invoke the unbind method with it. Note that calling the unbind method without any argument unbinds all handlers for all events.

    <p>Animal: <input id="animal" /></p>

    <button id="unbindButton">Unbind event</button>

    <script>
        $(function() {
          var handler = function(e) { console.log(e); };
          $("#animal").kendoAutoComplete({ dataSource: [ "Ant", "Antilope", "Badger", "Beaver", "Bird" ] });

          var autoComplete = $("#animal").data("kendoAutoComplete");

          autoComplete.bind("open", handler);

          $("#unbindButton").on("click", function() {
              //unbind open event of the AutoComplete
              autoComplete.unbind("open", handler);
          });
        });
    </script>

See Also

In this article
Not finding the help you need? Improve this article