Class SpreadsheetClientSideEventsBuilder<T>

Represents a class for client side events which includes load, action begin, create, before open, pager click and etc events.

Inheritance

System.Object

SpreadsheetClientSideEventsBuilder<T>

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class SpreadsheetClientSideEventsBuilder<T>
    where T : class

Type Parameters

Name	Description
T

Constructors

SpreadsheetClientSideEventsBuilder(WorkbookProperties)

Initializes a new instance of the SpreadsheetClientSideEventsBuilder<T> with the specified spreadsheet properties.

Declaration

public SpreadsheetClientSideEventsBuilder(WorkbookProperties spreadsheetProp)

Parameters

Type	Name	Description
WorkbookProperties	spreadsheetProp	The worksheet properties.

Methods

ActionBegin(String)

Declaration

public SpreadsheetClientSideEventsBuilder<T> ActionBegin(string actionBegin)

Parameters

Type	Name	Description
System.String	actionBegin

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

ActionComplete(String)

Occurs after Spreadsheet actions completed.

Declaration

public SpreadsheetClientSideEventsBuilder<T> ActionComplete(string actionComplete)

Parameters

Type	Name	Description
System.String	actionComplete	Name of the actioncomplete event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

AutoFillBegin(String)

Occurs when autofill starts.

Declaration

public SpreadsheetClientSideEventsBuilder<T> AutoFillBegin(string autoFillBegin)

Parameters

Type	Name	Description
System.String	autoFillBegin	Name of the autofillbegin event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

AutoFillComplete(String)

Occurs when autofill gets completed.

Declaration

public SpreadsheetClientSideEventsBuilder<T> AutoFillComplete(string autoFillComplete)

Parameters

Type	Name	Description
System.String	autoFillComplete	Name of the autofillcomplete event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforeBatchSave(String)

Occurs when the batch save.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforeBatchSave(string beforeBatchSave)

Parameters

Type	Name	Description
System.String	beforeBatchSave

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforeCellFormat(String)

Occurs before cell formatting applied.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforeCellFormat(string beforeCellFormat)

Parameters

Type	Name	Description
System.String	beforeCellFormat	Name of the beforecellformat event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforeCellSelect(String)

Occurs before cell select.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforeCellSelect(string beforeCellSelect)

Parameters

Type	Name	Description
System.String	beforeCellSelect	Name of the beforecellselect event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforeDrop(String)

Occurs before cell has dropped.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforeDrop(string beforeDrop)

Parameters

Type	Name	Description
System.String	beforeDrop

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforeEditComment(String)

Occurs when before cell edit event.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforeEditComment(string beforeEditComment)

Parameters

Type	Name	Description
System.String	beforeEditComment	Name of the beforeEditComment event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforeImport(String)

Occurs on before file importing.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforeImport(string beforeImport)

Parameters

Type	Name	Description
System.String	beforeImport	Name of the beforeImport event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforeOpen(String)

Occurs before open for import.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforeOpen(string beforeOpen)

Parameters

Type	Name	Description
System.String	beforeOpen	Name of the beforeopen event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforePanelOpen(String)

Occurs before activation panel opened.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforePanelOpen(string beforePanelOpen)

Parameters

Type	Name	Description
System.String	beforePanelOpen	Name of the beforepanelopen event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforePrint(String)

Occurs before print.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforePrint(string beforePrint)

Parameters

Type	Name	Description
System.String	beforePrint	Name of the beforeprint event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

BeforeTabClick(String)

Occurs when before click a ribbon tab.

Declaration

public SpreadsheetClientSideEventsBuilder<T> BeforeTabClick(string beforeTabClick)

Parameters

Type	Name	Description
System.String	beforeTabClick	Name of the beforeTabClick event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

CellClick(String)

Occurs when click a cell.

Declaration

public SpreadsheetClientSideEventsBuilder<T> CellClick(string cellClick)

Parameters

Type	Name	Description
System.String	cellClick	Name of the cellclick event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

CellEdit(String)

Occurs when edit a cell.

Declaration

public SpreadsheetClientSideEventsBuilder<T> CellEdit(string cellEdit)

Parameters

Type	Name	Description
System.String	cellEdit	Name of the celledit event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

CellFormatting(String)

Occurs when cell formatting is applied.

Declaration

public SpreadsheetClientSideEventsBuilder<T> CellFormatting(string cellFormatting)

Parameters

Type	Name	Description
System.String	cellFormatting	Name of the cellformatting event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

CellHover(String)

Occurs when hovering a cell.

Declaration

public SpreadsheetClientSideEventsBuilder<T> CellHover(string cellHover)

Parameters

Type	Name	Description
System.String	cellHover	Name of the cellhover event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

CellSave(String)

Occurs when save the edited cell.

Declaration

public SpreadsheetClientSideEventsBuilder<T> CellSave(string cellSave)

Parameters

Type	Name	Description
System.String	cellSave	Name of the cellsave event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

CellSelected(String)

Occurs when cell selected.

Declaration

public SpreadsheetClientSideEventsBuilder<T> CellSelected(string cellSelected)

Parameters

Type	Name	Description
System.String	cellSelected

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

ContextMenuClick(String)

Occurs when click a context menu.

Declaration

public SpreadsheetClientSideEventsBuilder<T> ContextMenuClick(string contextMenuClick)

Parameters

Type	Name	Description
System.String	contextMenuClick	Name of the contextmenuclick event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

Create(String)

Occurs when the Spreadsheet is rendered completely.

Declaration

public SpreadsheetClientSideEventsBuilder<T> Create(string create)

Parameters

Type	Name	Description
System.String	create

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

Drag(String)

Occurs when cell dragging.

Declaration

public SpreadsheetClientSideEventsBuilder<T> Drag(string drag)

Parameters

Type	Name	Description
System.String	drag	Name of the drag event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

DragShape(String)

Declaration

public SpreadsheetClientSideEventsBuilder<T> DragShape(string dragShape)

Parameters

Type	Name	Description
System.String	dragShape

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

DragStart(String)

Occurs when cell drag starts.

Declaration

public SpreadsheetClientSideEventsBuilder<T> DragStart(string dragStart)

Parameters

Type	Name	Description
System.String	dragStart	Name of the dragstart event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

Drop(String)

Occurs when cell has dropped.

Declaration

public SpreadsheetClientSideEventsBuilder<T> Drop(string drop)

Parameters

Type	Name	Description
System.String	drop	Name of the drop event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

EditRangeBegin(String)

Occurs when load data from range settings.

Declaration

public SpreadsheetClientSideEventsBuilder<T> EditRangeBegin(string editRangeBegin)

Parameters

Type	Name	Description
System.String	editRangeBegin	Name of the editrangebegin event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

EditRangeComplete(String)

Occurs after edit range gets completed.

Declaration

public SpreadsheetClientSideEventsBuilder<T> EditRangeComplete(string editRangeComplete)

Parameters

Type	Name	Description
System.String	editRangeComplete	Name of the editrangecomplete event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

KeyDown(String)

Occurs on key down actions.

Declaration

public SpreadsheetClientSideEventsBuilder<T> KeyDown(string keyDown)

Parameters

Type	Name	Description
System.String	keyDown

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

KeyUp(String)

Occurs on key up actions.

Declaration

public SpreadsheetClientSideEventsBuilder<T> KeyUp(string keyUp)

Parameters

Type	Name	Description
System.String	keyUp

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

Load(String)

Occurs when Spreadsheet load.

Declaration

public SpreadsheetClientSideEventsBuilder<T> Load(string load)

Parameters

Type	Name	Description
System.String	load	Name of load event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

LoadComplete(String)

Occurs after the Spreadsheet load has completed.

Declaration

public SpreadsheetClientSideEventsBuilder<T> LoadComplete(string loadComplete)

Parameters

Type	Name	Description
System.String	loadComplete	Name of the loadcomplete event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

MenuClick(String)

Occurs when click a menu.

Declaration

public SpreadsheetClientSideEventsBuilder<T> MenuClick(string menuClick)

Parameters

Type	Name	Description
System.String	menuClick	Name of the menuclick event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

OnExport(String)

Occurs on file exporting.

Declaration

public SpreadsheetClientSideEventsBuilder<T> OnExport(string onExport)

Parameters

Type	Name	Description
System.String	onExport

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

OnImport(String)

Occurs on file importing.

Declaration

public SpreadsheetClientSideEventsBuilder<T> OnImport(string onImport)

Parameters

Type	Name	Description
System.String	onImport

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

OpenFailure(String)

Occurs when failure the open method.

Declaration

public SpreadsheetClientSideEventsBuilder<T> OpenFailure(string openFailure)

Parameters

Type	Name	Description
System.String	openFailure

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

PagerClick(String)

Occurs when pager gets clicked.

Declaration

public SpreadsheetClientSideEventsBuilder<T> PagerClick(string pagerClick)

Parameters

Type	Name	Description
System.String	pagerClick	Name of the pagerclick event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

Refresh(String)

Occurs when resize the window.

Declaration

public SpreadsheetClientSideEventsBuilder<T> Refresh(string refresh)

Parameters

Type	Name	Description
System.String	refresh

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

ResizeEnd(String)

Declaration

public SpreadsheetClientSideEventsBuilder<T> ResizeEnd(string resizeEnd)

Parameters

Type	Name	Description
System.String	resizeEnd

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

ResizeStart(String)

Declaration

public SpreadsheetClientSideEventsBuilder<T> ResizeStart(string resizeStart)

Parameters

Type	Name	Description
System.String	resizeStart

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

RibbonClick(String)

Occurs when click a ribbon.

Declaration

public SpreadsheetClientSideEventsBuilder<T> RibbonClick(string ribbonClick)

Parameters

Type	Name	Description
System.String	ribbonClick	Name of the ribbonclick event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

ScrollStop(String)

Occurs when scroll operation is stops.

Declaration

public SpreadsheetClientSideEventsBuilder<T> ScrollStop(string scrollStop)

Parameters

Type	Name	Description
System.String	scrollStop

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

SeriesRendering(String)

Occurs when performing chart series rendering.

Declaration

public SpreadsheetClientSideEventsBuilder<T> SeriesRendering(string seriesRendering)

Parameters

Type	Name	Description
System.String	seriesRendering	Name of the seriesrendering event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

TabClick(String)

Occurs when click a ribbon tab.

Declaration

public SpreadsheetClientSideEventsBuilder<T> TabClick(string tabClick)

Parameters

Type	Name	Description
System.String	tabClick

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>

TabSelect(String)

Occurs when select a ribbon tab.

Declaration

public SpreadsheetClientSideEventsBuilder<T> TabSelect(string tabSelect)

Parameters

Type	Name	Description
System.String	tabSelect	Name of the tabselect event.

Returns

Type	Description
SpreadsheetClientSideEventsBuilder<T>