The following tables list the members exposed by SpreadsheetClientEvents.
| Name | Description | |
|---|---|---|
 | ActionExecuted | Event which is raised when an action is executed on the Spreadsheet. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.action to obtain the action that was executed. |
| ActionExecuting | Event which is raised when an action is about to be executed by the Spreadsheet. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.action to obtain the action that is about to be executed. |
| ActiveCellChanged | Event which is raised when the activeCell of the Spreadsheet has changed. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.oldValue to obtain the previous active cell. Use ui.newValue to obtain the current active cell. |
| ActivePaneChanged | Event which is raised when the activePane of the Spreadsheet has changed. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.oldActivePane to obtain the previous active pane. Use ui.newActivePane to obtain the current active pane. Use ui.activeCell to obtain the active cell of the new active pane or null if there is no active pane. Use ui.visibleRange to obtain the current visible range of the new active pane or null if there is no active pane. |
| ActiveWorksheetChanged | Event which is raised when the activeWorksheet of the Spreadsheet has changed. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.oldActiveWorksheet to obtain the previous active worksheet. Use ui.oldActiveWorksheetName to obtain the name of the previous active worksheet or null if oldActiveWorksheet is null. Use ui.newActiveWorksheet to obtain the current active worksheet. Use ui.newActiveWorksheetName to obtain the name of the new active worksheet or null if newActiveWorksheet is null. |
| EditModeEntered | Event which is raised when the Spreadsheet has started in-place editing of the activeCell. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.cell to obtain the cell for which the control has entered edit mode. |
| EditModeEntering | Event which is raised when the Spreadsheet is about to start in-place editing of the activeCell. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.cell to obtain the cell for which the control is going into edit mode. |
| EditModeExited | Event which is raised when the Spreadsheet has ended the in-place editing of the activeCell. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.cell to obtain the cell for which the control has exited edit mode. |
| EditModeExiting | Event which is raised when the Spreadsheet is about to end the in-place editing of the activeCell. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.acceptChanges to obtain or set a boolean indicating whether the changes will be made to the cell's value when edit mode ends. Use ui.canCancel to obtain a boolean indicating if the edit mode is being forced to exit edit mode in which case it cannot be cancelled. Use ui.cell to obtain the cell for which the control is exiting edit mode. |
| EditModeValidationError | Event which is raised when the Spreadsheet is exiting edit mode and the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.action to obtain or set the action to take in response to the failed validation. Use ui.canStayInEditMode to obtain a boolean indicating whether the cell is allowed to stay in edit mode. Use ui.cell to obtain the cell for which the control is in edit mode. Use ui.validationRule to obtain the rule which failed validation. The EditModeValidationError is raised while exiting edit mode if the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. Since the rule needs to evaluate the value of the cell and potentially other cell's in the Worksheet, the value is first applied to the cell(s) and then is validated. By default if the event is not handled and the showErrorMessageForInvalidValue is true, a message box will be displayed to the end user to determine what action to take. One can handle this event and specify the action that should be taken using the action. Note: The validation rule will not be evaluated if edit mode is being cancelled such as when the user presses Escape to cancel edit. Note: The action will default to AcceptChange if the ShowErrorMessageForInvalidValue of the validationRule is false; otherwise it will default to ShowPrompt. Note: Like Microsoft Excel, only the validation rule of the active cell is considered even if the update is affecting other cells in the selection. |
| EditRangePasswordNeeded | Event which is raised when the Spreadsheet is performing an operation on a protected Worksheet and there is a single range that may be unlocked to allow the operation to be performed. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.ranges to obtain an array of protected range objects that should be unlocked. Use ui.unprotect to obtain a parameterless function that may be invoked to unlock the associated ranges. |
| HyperlinkExecuting | Event which is raised when the selection for a ig.spreadsheet.SpreadsheetPane of the Spreadsheet is changed. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.hyperlink to obtain the hyperlink to be executed. |
| SelectionChanged | Event which is raised when a hyperlink is being followed in the Spreadsheet. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.pane to obtain the pane for which the selection has changed. |
| UserPromptDisplaying | Event which is raised when the user will be prompted with a message regarding an operation that is being performed. Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. Use ui.canCancel to obtain a boolean indicating if the operation that triggered the prompt can be cancelled. Use ui.displayMessage to obtain a boolean indicating if a message will be displayed to the end user. Use ui.exception to obtain the exception for the error, if there was one. Use ui.message to obtain or set the message that will be displayed. Use ui.trigger to obtain the action that caused the prompt to be displayed. |
| WorkbookDirtied | Event which is raised when a change has been made to the workbook that might require a save. Note: This event is invoked asynchronously with regards to the change(s) that have occurred. Also some changes alone are not considered to dirty the Workbook even though it does change state on the Workbook or one of its subobjects. An example of that would be a zoom type operation (e.g. changing the magnificationInNormalView). Function takes arguments evt and ui. Use ui.owner to obtain reference to igSpreadsheet. |
View on GitHub