SpreadsheetEventBuilder

Methods

InsertSheet(System.String)

Triggered when a sheet is inserted. Introduced in the 2017 Q1 release.

For more information see InsertSheet event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the insertSheet event.

RemoveSheet(System.String)

Triggered when a sheet will be removed. Introduced in the 2017 Q1 release.

For more information see RemoveSheet event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the removeSheet event.

RenameSheet(System.String)

Triggered when a sheet will be renamed. Introduced in the 2017 Q1 release.

For more information see RenameSheet event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the renameSheet event.

SelectSheet(System.String)

Triggered when a sheet will be activated. Introduced in the 2017 Q1 release.

For more information see SelectSheet event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the selectSheet event.

UnhideColumn(System.String)

Triggered when a column will be shown. Introduced in the 2017 Q1 release.

For more information see UnhideColumn event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the unhideColumn event.

UnhideRow(System.String)

Triggered when a row will be shown. Introduced in the 2017 Q1 release.

For more information see UnhideRow event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the unhideRow event.

HideColumn(System.String)

Triggered when a column will be hidden. Introduced in the 2017 Q1 release.

For more information see HideColumn event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the hideColumn event.

HideRow(System.String)

Triggered when a row will be hidden. Introduced in the 2017 Q1 release.

For more information see HideRow event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the hideRow event.

DeleteColumn(System.String)

Triggered when a column will be deleted. Introduced in the 2017 Q1 release.

For more information see DeleteColumn event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the deleteColumn event.

DeleteRow(System.String)

Triggered when a row will be deleted. Introduced in the 2017 Q1 release.

For more information see DeleteRow event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the deleteRow event.

InsertColumn(System.String)

Triggered when a column will be inserted. Introduced in the 2017 Q1 release.

For more information see InsertColumn event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the insertColumn event.

InsertRow(System.String)

Triggered when a row will be inserted. Introduced in the 2017 Q1 release.

For more information see InsertRow event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the insertRow event.

Select(System.String)

Triggered when the Spreadsheet selection is changed. Introduced in the 2017 Q1 release.

For more information see Select event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the select event.

ChangeFormat(System.String)

Triggered when the range format is changed from the UI. Introduced in the 2017 Q1 release.

For more information see ChangeFormat event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the changeFormat event.

Changing(System.String)

Triggered when a value or validation in the Spreadsheet is about to be changed upon user interaction.

For more information see Changing event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the changing event.

Change(System.String)

Triggered when a value in the Spreadsheet has been changed. Introduced in the 2016.Q1.SP1 release.

For more information see Change event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the change event.

Render(System.String)

Triggered after the widget has completed rendering. The event will also fire when a cell is selected or when the Spreadsheet's tools (bold, italic) are used, as the target element is re-generated with new styles (e.g background-color, box-shadow, font-weight, etc.).

For more information see Render event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the render event.

ExcelExport(System.String)

Fires when the user clicks the Export to Excel toolbar button.

For more information see ExcelExport event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the excelExport event.

ExcelImport(System.String)

Fired when the user clicks the Open toolbar button.

For more information see ExcelImport event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the excelImport event.

PdfExport(System.String)

Fired when the user initiates the export to PDF.

For more information see PdfExport event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the pdfExport event.

Copy(System.String)

Fired when a range of a sheet is about to be copied.

For more information see Copy event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the copy event.

Cut(System.String)

Fired when a range of a sheet is about to be cut.

For more information see Cut event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the cut event.

Paste(System.String)

Fired when a data is about to be pasted in a sheet.

For more information see Paste event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the paste event.

DataBinding(System.String)

Fired when the data retrieved from a DataSource is about to be bound to a sheet. Available only if DataSource has been defined for at least one sheet.

For more information see DataBinding event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the dataBinding event.

DataBound(System.String)

Fired when the data from a DataSource is already populated in a sheet. Available only if DataSource has been defined for at least one sheet.

For more information see DataBound event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the dataBound event.