Event related API

The following events are available in dhtmlxGrid:

• Drag-and-Drop Events:
  • onBeforeDrag Event - occurs when drag operation is started; the event can be blocked (dhtmlxgrid 1.5.1 +);
  • onDragIn/onDragOut Events - occur when an item is dragged to another potential target (the event can be blocked) or out of the potential target (dhtmlxgrid 1.5.1 +);
  • onDrag Event - occurs when an item is dragged to another target and the mouse is released, the event can be blocked;
  • onDrop Event - occurs when drag-and-drop operation is finished.
• Editing Events:
  • onEditCell Event - occurs 1-3 times depending on cell's editability;
  • onRowDblClicked Event - occurs right after a row was double clicked, before a cell editor is opened by a dbl click. If retuns false, the event is canceled;
  • onCellChanged Event - occurs when a cell value was changed;
  • onCheckbox Event - the event is deprecated, use onCheck event instead; occurs after the state was changed;
  • onCheck Event - occurs after the state of a checkbox was changed;
  • onRowPaste Event - occurs for each row that was pasted from the clipboard (block selection extension);
• Grid Reconstruction Events:
  • onGridReconstructed Event - occurs immediately after a row was added/deleted or the grid was reordered;
  • onRowAdded Event - occurs right after a row was added to the grid;
  • onRowCreated Event - occurs after a row was created in the grid, and was filled with data;
  • onBeforeRowDeleted Event - occurs right before a row was deleted;
  • onAfterRowDeleted Event - occurs exactly after row was deleted;
  • onSubRowOpen - occurs when sub-row( sub-grid) was opened(closed)
• Loading Events:
  • onXLS Event - occurs before the request for a new XML was sent to the server;
  • onXLE Event - occurs simultaneously with ending XML of parsing, new items are already available in the grid;
  • onDynXLS - start of dynamic loading request;
  • onDistributedEnd - end of distributed parsing;
  • onSubGridCreated Event - occurs when creation of a sub-grid was initiated;
  • onSubGridLoaded Event- occurs after data from the sub-grid is loaded and parsed;
  • onSubAjaxLoad Event- occurs when sub-row-ajax cell loads its data
• Moving Events:
  • onBeforeCMove Event - occurs when column moving operation starts;
  • onAfterCMove Event - occurs after a column was moved;
• Paging Events:
  • onBeforePageChanged Event - occurs before the active page in the grid was changed (paging extension);
  • onPageChanged Event - occurs after the active page in the grid was changed (paging extension);
  • onPaging Event - occurs each time when paging settings are changed (paging extension);
• Resizing Events:
  • onResize Event - occurs on each resize iteration;
  • onResizeEnd Event - occurs when resizing of a column is finished;
• Selection Events:
  • onBeforeSelect Event - occurs a moment before a row in the grid is selected;
  • onRowSelect Event - occurs immediately after a row in the grid was clicked;
  • onSelectStateChanged Event - occurs immediately when selection state was changed;
  • onBlockSelected Event - occurs when some area is selected in the grid (block selection extension);

• Sorting Events:
  • onBeforeSorting Event - occurs before starting data sorting;
  • onAfterSorting Event - occurs after sorting took place in the grid;
• Context Menu Events:
  • onBeforeContextMenu Event - occurs immediately before showing the context menu;
  • onRightClick Event - occurs immediately after the right mouse button was clicked on a grid row;
• Grouping
  • onGroup - grid was grouped
  • onGroupStateChanged - group was opened|closed
  • onUnGroup - grid was ungrouped
• Filtering
  • FilterStart Event - occurs when filtering is activated but before real filtering starts;
  • onFilterEnd Event - occurs when filtering is completed (filtering extension);
  • onCollectValues - occurs when values collected to fill select filter
• Other Events:
  • onEnter Event - occurs immediately after the Enter key is pressed;
  • onStatReady Event - occurs when stat values were calculated;
  • onHeaderClick Event - occurs right after a header was clicked, before sorting or any other actions;
  • onKeyPress Event - occurs after a key was pressed but before the default key processing starts;
  • onTab Event - tabulation in grid occurs;
  • onMouseOver Event - occurs when the mouse is moved over a cell;
  • onScroll Event - occurs immediately after scrolling took place.

• Inner events
  • onRowIdChange - occurs when row ID was changed;
  • onClearAll Event - occurs when the grid is cleared (reloaded);
  • onColumnHidden - occurs when hidden state of column was changed;

The user can add any user-defined handler to any of the available events. To do this, the user can use attachEvent() method with the following parameters:

• evName - name of the event;
• evHandler - user-defined event handler.

        grid.attachEvent(evName, evHandler);

Several handlers can be attached to one and the same event, and all of them will be executed. Note: the names of the events are case-sensitive.

There is a simple way of removing an event-handler:

        grid.detachEvent(id); // unique id of the event handler