Events

The action to take on an event is set as a property of the grid, e.g.

See also jqGrid Methods

var lastSel;
jQuery("#gridid").jqGrid({
...
   onSelectRow: function(id){ 
      if(id && id!==lastSel){ 
         jQuery('#gridid').restoreRow(lastSel); 
         lastSel=id; 
      } 
      jQuery('#gridid').editRow(id, true); 
   },
...
});

The above example specifies the action to take when a row is selected. The events that you can use to perform some additional action are listed here, in alphabetic order:

var lastSel;
jQuery("#gridid").jqGrid({
...
   onSelectRow: function(id){ 
      if(id && id!==lastSel){ 
         jQuery(this).restoreRow(lastSel); 
         lastSel=id; 
      } 
      jQuery(this).editRow(id, true); 
   },
...
});

Additional Events specific to Cell Editing, subGrid are found in their respective topics.

Some from events in the above list should or have to return events. One should take in the consideration that one can register multiple event handles. The event handle should use result property of the event object to know the value returned from the previously invoked event handler. Depend on the type of returned value one should combine the results which one plan to return with the results returned by previous handler.

For example one implements jqGridBeforeSelectRow event handler which can return boolean true/false or “stop” string. The event will be called on click inside of the grid. jqGrid trigger jqGridBeforeSelectRow event before making selection of the clicked row. If the returned value is false or “stop”, jqGrid will don't make selection. So it should be clear that jqGridBeforeSelectRow event handler can return false if one decide to suppress row selection, but one couldn't just return true if the selection should be permitted. It will force selection even if previously invoked event handler returns false. So one have to test result property of e parameter. If it's undefined then there are no other event handler which was invoked previously. On the other side if the value e.result is false or “stop” then the previously invoked event handler decide to suppress selection. In the case one have to return the value e.result (false) instead of true. It means that we don't want to force the selection. We just don't protest the selection and we want to follow the decision of previously invoked event handler about the selection. The corresponding code could be the following:

$("gridid").bind("jqGridBeforeSelectRow", function (e, rowid, orgClickEvent) {
    ...
    // if we want to return true, we should test e.result additionally
    return e.result === undefined ? true : e.result;
});

Alternatively one can test explicitly for for false or “stop”:

$("gridid").bind("jqGridBeforeSelectRow", function (e, rowid, orgClickEvent) {
    ...
    // if we want to return true, we should test e.result additionally
    return e.result === false || e.result === "stop" ? false : true;
});

Below is the execution order of the events when a ajax request is made

1. beforeRequest
2. loadBeforeSend
3. serializeGridData
4. loadError (if a error from the request occur - the event from steps 5 till 7 do not execute. If there is no error the event 4. does not execute and we continue to with the step 5.)
5. beforeProcessing
6. gridComplete
7. loadComplete