Intersoft WebGrid Documentation
WebGridClientSideEvents
Send comments on this topic.
Intersoft WebGrid > Client-side References > WebGridClientSideEvents

Glossary Item Box

 WebGridClientSideEvents Properties

OnBeforeRequest Description
Specifies the client-side function to be invoked when a request action to server is about to be made.

ValueType
string

Default Value
-
OnResponse Description
Specifies the client-side function to be invoked when a response from server is returned, irregardless of a successful response or error response (see also: OnActionDispatched).

ValueType
string

Default Value
-
OnColumnMove Description
Specifies the client-side function to be invoked when a column is being moved.

ValueType
string

Default Value
-
OnColumnResize Description
Specifies the client-side function to be invoked when a column is being resized.

ValueType
string

Default Value
-
OnColumnChanged Description
Specifies the client-side function to be invoked when a column is being removed or added directly from WebGrid client UI.

ValueType
string

Default Value
-
OnRowSelect Description
Specifies the client-side function to be invoked when a row is selected.

ValueType
string

Default Value
-
OnCellSelect Description
Specifies the client-side function to be invoked when a cell is selected.

ValueType
string

Default Value
-
OnCellClick Description
Specifies the client-side function to be invoked when a cell is clicked.

ValueType
string

Default Value
-
OnCellDblClick Description
Specifies the client-side function to be invoked when a cell is double clicked.

ValueType
string

Default Value

OnGroupExpand Description
Specifies the client-side function to be invoked when a group is being expanded.

ValueType
string

Default Value
-
OnGroupCollapse Description
Specifies the client-side function to be invoked when a group is being collapsed.

ValueType
string

Default Value

OnChildRowExpand Description
Specifies the client-side function to be invoked when a child row is being expanded.

ValueType
string

Default Value
-
OnChildRowCollapse Description
Specifies the client-side function to be invoked when a child row is being collapsed.

ValueType
string

Default Value
-
OnKeyDown Description
Specifies the client-side function to be invoked when a keystroke is being made.

ValueType
string

Default Value
-
OnRowSelectorClick Description
Specifies the client-side function to be invoked when a row selector is clicked.

ValueType
string

Default Value
-
OnEnterEditMode Description
Specifies the client-side function to be invoked when edit mode is about to be activated.

ValueType
string

Default Value
-
OnExitEditMode Description
Specifies the client-side function to be invoked when edit mode is being ended.

ValueType
string

Default Value
-
OnBeforeAdd Description
Specifies the client-side function to be invoked before a new row request is made.

ValueType
string

Default Value
-
OnAfterAdd Description
Specifies the client-side function to be invoked after a new row has been added.

ValueType
string

Default Value
-
OnBeforeUpdate Description
Specifies the client-side function to be invoked before the update request is made.

ValueType
string

Default Value
-
OnAfterUpdate Description
Specifies the client-side function to be invoked after the update process is done.

ValueType
string

Default Value
-
OnBeforeDelete Description
Specifies the client-side function to be invoked before a delete request is made.

ValueType
string

Default Value
-
OnAfterDelete Description
Specifies the client-side function to be invoked after a delete process is complete.

ValueType
string

Default Value
-
OnAfterResponseProcess Description
Specifies the client-side function to be invoked after the response of a request has been received.

ValueType
string

Default Value
-
OnUnhandledError Description
Specifies the client-side function to be invoked when an unhandled error occured.

ValueType
string

Default Value
-
OnRowValidate Description
Specifies the client-side function to be invoked when a row is being validated.

ValueType
string

Default Value
-
OnCalendarSelect Description
Specifies the client-side function to be invoked when selection is made from Calendar popup.

ValueType
string

Default Value
-
OnInitialize Description
Specifies the client-side function to be invoked when the grid is in initialization process.

ValueType
string

Default Value
-
OnRowContextMenu Description
Specifies the client-side function to be invoked when the row context menu is about to be displayed.

ValueType
string

Default Value
-
OnEditKeyDown Description
Specifies the client-side function to be invoked when a keypress is made while in edit mode (edit control is in focus).

ValueType
string

Default Value
-
OnFocus Description
Specifies the client-side function to be invoked when focus is set to the grid.

ValueType
string

Default Value
-
OnLostFocus Description
Specifies the client-side function to be invoked when the grid loses focus.

ValueType
string

Default Value
-
OnButtonClick Description
Specifies the client-side function to be invoked when a button cell is clicked.

ValueType
string

Default Value
-
OnCheckBoxClick Description
Specifies the client-side function to be invoked when a checkbox of a row-checker column or checkbox column-typed column is clicked.

ValueType
string

Default Value
-
OnActionDispatched Description
Specifies the client-side function to be invoked when a successful response is received from the server (no errors occured), similar to OnResponse.

ValueType
string

Default Value
-
OnSelfRefRowExpand Description
Specifies the client-side function to be invoked when a self-referencing row is being expanded.

ValueType
string

Default Value
-
OnSelfRefRowCollapse Description
Specifies the client-side function to be invoked when a self-referencing row is being collapsed.

ValueType
string

Default Value
-
OnColumnGroup Description
Specifies the client-side function to be invoked when a column is being grouped.

ValueType
string

Default Value
-
OnColumnUngroup Description
Specifies the client-side function to be invoked when a column is being ungrouped.

ValueType
string

Default Value
-
OnColumnGroupChange Description
Specifies the client-side function to be invoked when the order of a grouped column is changed by dragging the column to a new position.

ValueType
string

Default Value
-
OnColumnSort Description
Specifies the client-side function to be invoked when a column sorting request is being made.

ValueType
string

Default Value
-
OnColumnFilter Description
Specifies the client-side function to be invoked when a column filtering request is being made.

ValueType
string

Default Value
-
OnBeforeRowSelect Description
Specifies the client-side function to be invoked before a row is selected as current.

ValueType
string

Default Value
-
OnUndoChanges Description
Fired when a row changes is about to be undo'ed

Parameters
controlId
The Id of WebGrid control. 

rowObject
The row to be undo'ed.

ValueType
String

Default Value
-

OnUndoallChanges Description
Fired when undo all changes command is performed.

Parameters
controlId
The Id of WebGrid control.  

ValueType
String

Default Value
-

OnAcceptAllChanges Description
Fired when accept all changes command is performed.

Parameters
controlId
The Id of WebGrid control. 

ValueType
String

Default Value
-

OnAddPendingChanges Description
Fired when a pending changes is about to be added.

Parameters
controlId
The Id of WebGrid control. 

table
The table on which pending changes is added to.

rowChange
The row change object.

ValueType
String

Default Value
-

OnRemovePendingChanges Description
Fired when a pending changes is about to be removed.

Parameters
controlId
The Id of WebGrid control. 

table
The table on which pending changes is added to.

rowChange
The row change object.

ValueType
String

Default Value
-

OnBatchUpdateSuccess Description
Fired when batch update operation has been successfully completed.

Parameters
controlId
The Id of WebGrid control. 

hasPartialErrors
Whether the batch update contains one or more errors. 

partialErrorsXml
The xml document contains partial errors data.

ValueType
String

Default Value
-

OnCustomAggregate Description
Fired when WebGrid needs to perform custom aggregation for column which AggregateType is set to Custom.

Parameters
controlId
The Id of WebGrid control. 

column

rows

type

ValueType
String

Default Value
-

OnInitializeRow Description
Fired when a row is initialized.

Parameters
controlId
The Id of WebGrid control. 

row

ValueType
String

Default Value
-

OnInitializeCell Description
Fired when a cell is initialized.

Parameters
controlId
The Id of WebGrid control. 

cell

ValueType
String

Default Value
-

OnSynchronizeRow Description
Fired when a row requires synchronization.

Parameters
controlId
The Id of WebGrid control. 

row

ValueType
String

Default Value
-

OnSynchronizeCell Description
Fired when a cell required synchronization.

Parameters
controlId
The Id of WebGrid control. 

cell

ValueType
String

Default Value
-

OnDataSourceChanged Description
Fired when data source has been changed.

Parameters
controlId
The Id of WebGrid control. 

ValueType
String

Default Value
-
OnDataBound Description
Fired when data binding process is completed.

Parameters
controlId
The Id of WebGrid control. 

hasPartialErrors
Whether the batch update contains one or more errors. 

partialErrorsXml
The xml document contains partial errors data.

ValueType
String

Default Value
-

OnPreRender Description
Fired when WebGrid enters rendering phase.

Parameters
controlId
The Id of WebGrid control. 

ValueType
String

Default Value
-
OnPostRender Description
Fired after rendering operation is completed.

Parameters
controlId
The Id of WebGrid control. 

ValueType
String

Default Value
-

OnAfterExitEditMode Description
This event is invoked after user exits cell-level editing.

Parameters
controlId
The Id of WebGrid control. 

tableName

editObject

ValueType
String

Default Value
-

OnBeginRowEditing Description
This event is invoked when user begins to edit a row.

Parameters
controlId
The Id of WebGrid control. 

row

ValueType
String

Default Value
-

OnEndRowEditing Description
This event is invoked when user ended row editing completely.

Parameters
controlId
The Id of WebGrid control. 

row

ValueType
String

Default Value
-

OnCancelRowEditing Description
This event is invoked when user canceled row editing.

Parameters
controlId
The Id of WebGrid control. 

row

ValueType
String

Default Value
-

OnInitializeCustomEditor Description
Specifies the client side (JavaScript) function that will be invoked when a custom editor is about to be initialized.

Parameters
controlId
The Id of WebGrid control.

editorName


editorObject


customEditor

ValueType
string

Default Value
-
OnColumnContextMenu Description
Specifies the client side (JavaScript) function that will be invoked when the column's context menu is about to be displayed.

Parameters
controlId
The Id of WebGrid control.

col


menu


isGroup


location

ValueType

string

Default Value
-
OnExportContextMenu Description
Specifies the client-side function to be invoked when a request action to server is about to be made.

Parameters
controlID
The Id of WebGrid control.

table


menu


location


ValueType

string

Default Value
-
OnBatchUpdateError Description
Specifies the client side (JavaScript) function that will be invoked when one or more records are failed to be updated during batch update process.

Parameters
controlId
The Id of WebGrid control.

errorXml

ValueType

string

Default Value
-
OnColumnAction Description
Specifies the client side (JavaScript) function that will be invoked when users click on the column action indicator.

Parameters
controlId
The Id of WebGrid control.

column

ValueType

string

Default Value
-
©2012 Intersoft Solutions Corp. All Rights Reserved.