SpreadsheetEvent<TEventArgs> Class
The event object used for client-side events.
#Declaration
class SpreadsheetEvent<TEventArgs extends EventArgs>
#Type Parameters
Name | Type | Description |
---|---|---|
TEvent |
Event |
An object that contain an event argument. |
#Remarks
The SpreadsheetEvent class serves as the event object for events generated for web controls on the client-side.
#Methods
#addHandler(handler) Method
Dynamically connects the event with an appropriate event handler function.
#Declaration
addHandler(
handler: any
): void
#Parameters
Name | Type | Description |
---|---|---|
handler | any | An object that contains the event handler function. |
#Remarks
Use the addHandler method to connect an event with a specific handler function on the client-side.
#clearHandlers Method
Dynamically disconnects the event from all the associated event handler functions.
#Declaration
clearHandlers(): void
#Remarks
Use the clearHandlers method to remove all the handler functions associated with the client-side event.
#fireEvent(source, args) Method
For internal use only.
#Declaration
fireEvent(
source: Spreadsheet,
args: TEventArgs
): void
#Parameters
Name | Type | Description |
---|---|---|
source | Spreadsheet | The event source. |
args | TEvent |
THe event argument. |
#removeHandler(handler) Method
Dynamically disconnects the event from the associated event handler function.
#Declaration
removeHandler(
handler: any
): void
#Parameters
Name | Type | Description |
---|---|---|
handler | any | An object that contains the event handler function. |
#Remarks
Use the removeHandler method to disconnect an event from the associated handler.