Event Reference (igHierarchicalGrid)

Topic Overview

Purpose

This topic explains the events that are specific to the igHierarchicalGrid™.

In this topic

This topic contains the following sections:

• Events Overview
• Attaching Handlers to Events in jQuery and MVC
• Events Reference Chart
• Related Topics

Events Overview

There are a couple of events that are specific to the igHierarchicalGrid. (See the Events Reference Chart block below). They are triggered when expanding or collapsing a row. In addition to that, there are also events for populating a child grid. They are fired only when the igHierarchicalGrid has Load On Demand feature enabled.

All events with the -ing suffix are cancelable. Event canceling is enabled when in the handler is set to return false.

In Javascript:

$("#grid1").igHierarchicalGrid({
    rowExpanding: function (e, args) {
           return  false;
    }
}

Most of the argument methods and properties contain- row specific data, as well as the grid they belong to. For more information about events,refer to the the Events Reference Chart below and the API help.

Attaching Handlers to Events in jQuery and MVC

To attach to an event, just define a handler for it in the same way you define property. Now if the event is triggered the handler will be called.

In Javascript:

$("#grid1").igHierarchicalGrid({
    rowExpanding: function (e, args) {
           // Handle event  
    }
}

When you attach a handler in MVC, use the jQuery User Interface (UI) pattern for attaching handlers to widget events. This means you should use jQuery’s bind or live functions and pass the event’s name to them. The event name should be a lowercase string that is a concatenation of the name of the control and the event. You can do the same with the jQuery widget as well, but this would not be necessary because you can attach the event handlers directly when initializing the control. For more information, see jQuery widget factory. The code bellow demonstrates how to attach handlers to igHierarchicalGrid events when implementing a MVC solution.

In Javascript:

$("#grid1").live({ ighierarchicalgridrowexpanding: function (e, args) {
     // Handle event  
}
});

Note: The jQuery live function is used in case some DOM elements are added after attaching the event to the handler.

Events Reference Chart

Related Topics

Following are some other topics you may find useful.

• igHierarchicalGrid Overview
• Initializing the igHierarchicalGrid
• igHierarchicalGrid Properties Reference