Events Overview

This article lists the clients-side events of the RadSpreadsheet and how to use them. Apart from the OnClientChange event, all other events are available as of R3 2019.

All events follow the MS AJAX client events convention and receive two arguments:

1. sender - the RadSpreadsheet instance that raised the event
2. event arguments - event-specific data provided to the developer

All the exposed events are wrappers over the Kendo UI events but are corresponding to the above convention. For instance, all Cancellable events can be canceled as shown below:

JS

function ClientInsertSheet(sender, args) {
    args.set_cancel(true);
}

RadSpreadsheet is a wrapper over the Kendo UI Spreadsheet widget and so it exposes the client events and data it does. You can find a list below.

• OnClientInsertSheet — Triggered when a sheet is inserted. Cancellable.
• OnClientRemoveSheet — Triggered when a sheet will be removed. Cancellable.
• OnClientRenameSheet — Triggered when a sheet will be renamed. Cancellable.
• OnClientSelectSheet — Triggered when a sheet will be activated. Cancellable.
• OnClientHideColumn — Triggered when a column will be hidden. Cancellable.
• OnClientHideRow — Triggered when a row will be hidden. Cancellable.
• OnClientUnhideColumn — Triggered when a column will be shown. Cancellable.
• OnClientUnhideRow — Triggered when a row will be shown. Cancellable.
• OnClientInsertColumn — Triggered when a column will be inserted. Cancellable.
• OnClientInsertRow — Triggered when a row will be inserted. Cancellable.
• OnClientDeleteColumn — Triggered when a column will be deleted. Cancellable.
• OnClientDeleteRow — Triggered when a row will be deleted. Cancellable.
• OnClientSelect — Triggered when the Spreadsheet selection is changed. Non-cancellable.
• OnClientChanging — Triggered when a value or validation in the Spreadsheet is about to be changed upon user interaction. Cancellable.
• OnClientChange — Triggered when a value in the Spreadsheet has been changed. Non-cancellable.
• OnClientChangeFormat — Triggered when the range format is changed from the UI. Non-cancellable.
• OnClientRender — Triggered after the widget has completed rendering. Non-cancellable.
• OnClientExcelExport — Fires when the user clicks the Export to Excel toolbar button. Cancellable.
• OnClientExcelImport — Fired when the user clicks the Open toolbar button. Cancellable.
• OnClientPdfExport — Fired when the user initiates the export to PDF. Cancellable.
• OnClientCopy — Fired when a range of a sheet is about to be copied. Cancellable.
• OnClientCut — Fired when a range of a sheet is about to be cut. Cancellable.
• OnClientPaste — Fired when a data is about to be pasted in a sheet. Cancellable.

To get some intellisense inside the event handlers and check what methods are available in the arguments and values they contain, the browser's developer tools can be used. Here is a blog post article that shows one way to do it: Improve Your Debugging Skills with Chrome DevTools, section Get IntelliSense for the Client-Side Object.