New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

SpreadsheetEventBuilder

Class

Defines the fluent API for configuring the Kendo Spreadsheet for ASP.NET MVC events.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class SpreadsheetEventBuilder : EventBuilder

Inheritance: objectEventBuilderSpreadsheetEventBuilder

Inherited Members EventBuilder.Handler(string, string)EventBuilder.Handler(string, Func<object, object>)EventBuilder.Eventsobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

SpreadsheetEventBuilder(IDictionary<string, object>)

public SpreadsheetEventBuilder(IDictionary<string, object> events)

Parameters:eventsIDictionary<string, object>

Methods

Change(string)

Defines the handler of the Change client-side event. Triggered when a value in the Spreadsheet has been changed. Introduced in the 2016.Q1.SP1 release.

public SpreadsheetEventBuilder Change(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.Change("onChange"))
)

ChangeFormat(string)

Defines the handler of the ChangeFormat client-side event. Triggered when the range format is changed from the UI. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder ChangeFormat(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.ChangeFormat("onChangeFormat"))
)

Changing(string)

Defines the handler of the Changing client-side event. Triggered when a value or validation in the Spreadsheet is about to be changed upon user interaction.

public SpreadsheetEventBuilder Changing(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.Changing("onChanging"))
)

Copy(string)

Defines the handler of the Copy client-side event. Fired when a range of a sheet is about to be copied.

public SpreadsheetEventBuilder Copy(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.Copy("onCopy"))
)

Cut(string)

Defines the handler of the Cut client-side event. Fired when a range of a sheet is about to be cut.

public SpreadsheetEventBuilder Cut(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.Cut("onCut"))
)

Defines the handler of the DataBinding client-side event. 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.

public SpreadsheetEventBuilder DataBinding(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.DataBinding("onDataBinding"))
)

DataBound(string)

Defines the handler of the DataBound client-side event. 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.

public SpreadsheetEventBuilder DataBound(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.DataBound("onDataBound"))
)

DeleteColumn(string)

Defines the handler of the DeleteColumn client-side event. Triggered when a column will be deleted. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder DeleteColumn(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.DeleteColumn("onDeleteColumn"))
)

DeleteRow(string)

Defines the handler of the DeleteRow client-side event. Triggered when a row will be deleted. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder DeleteRow(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.DeleteRow("onDeleteRow"))
)

ExcelExport(string)

Defines the handler of the ExcelExport client-side event. Fires when the user clicks the Export to Excel toolbar button.

public SpreadsheetEventBuilder ExcelExport(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.ExcelExport("onExcelExport"))
)

ExcelImport(string)

Defines the handler of the ExcelImport client-side event. Fired when the user imports a file after selecting it from the window prompt. The event is fired before the file importing has finished.

public SpreadsheetEventBuilder ExcelImport(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.ExcelImport("onExcelImport"))
)

HideColumn(string)

Defines the handler of the HideColumn client-side event. Triggered when a column will be hidden. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder HideColumn(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.HideColumn("onHideColumn"))
)

HideRow(string)

Defines the handler of the HideRow client-side event. Triggered when a row will be hidden. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder HideRow(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.HideRow("onHideRow"))
)

InsertColumn(string)

Defines the handler of the InsertColumn client-side event. Triggered when a column will be inserted. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder InsertColumn(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.InsertColumn("onInsertColumn"))
)

InsertRow(string)

Defines the handler of the InsertRow client-side event. Triggered when a row will be inserted. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder InsertRow(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.InsertRow("onInsertRow"))
)

InsertSheet(string)

Defines the handler of the InsertSheet client-side event. Triggered when a sheet is inserted. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder InsertSheet(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.InsertSheet("onInsertSheet"))
)

KendoKeydown(string)

Defines the handler of the KendoKeydown client-side event. Triggered when the user presses a keyboard key while the Spreadsheet is focused.The event handler function context (available via the this keyword) will be set to the widget instance.

public SpreadsheetEventBuilder KendoKeydown(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Paste(string)

Defines the handler of the Paste client-side event. Fired when a data is about to be pasted in a sheet.

public SpreadsheetEventBuilder Paste(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.Paste("onPaste"))
)

PdfExport(string)

Defines the handler of the PdfExport client-side event. Fired when the user initiates the export to PDF.

public SpreadsheetEventBuilder PdfExport(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.PdfExport("onPdfExport"))
)

RemoveSheet(string)

Defines the handler of the RemoveSheet client-side event. Triggered when a sheet will be removed. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder RemoveSheet(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.RemoveSheet("onRemoveSheet"))
)

RenameSheet(string)

Defines the handler of the RenameSheet client-side event. Triggered when a sheet will be renamed. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder RenameSheet(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.RenameSheet("onRenameSheet"))
)

Render(string)

Defines the handler of the Render client-side event. 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.).

public SpreadsheetEventBuilder Render(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.Render("onRender"))
)

Select(string)

Defines the handler of the Select client-side event. Triggered when the Spreadsheet selection is changed. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder Select(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.Select("onSelect"))
)

SelectSheet(string)

Defines the handler of the SelectSheet client-side event. Triggered when a sheet will be activated. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder SelectSheet(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.SelectSheet("onSelectSheet"))
)

UnhideColumn(string)

Defines the handler of the UnhideColumn client-side event. Triggered when a column will be shown. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder UnhideColumn(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.UnhideColumn("onUnhideColumn"))
)

UnhideRow(string)

Defines the handler of the UnhideRow client-side event. Triggered when a row will be shown. Introduced in the 2017 Q1 release.

public SpreadsheetEventBuilder UnhideRow(string handler)

Parameters:handlerstring

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

Returns:

SpreadsheetEventBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Events(events =&gt; events.UnhideRow("onUnhideRow"))
)