isReservedKey Method

Whether the cell type handles the keyboard event itself.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.BaseCellType();
var value; // Type: boolean
value = instance.isReservedKey(e, context);

function isReservedKey( 
   e : KeyboardEvent,
   context : object
) : boolean;

Parameters

e: The KeyboardEvent.
context: The context associated with the cell type. See the Remarks for more information.

Return Value

Returns true if the cell type handles the keyboard event itself; otherwise, false.

Remarks

You can override the isReservedKey method to customize the reserved key. In display mode, once isReservedKey returns True, the sheet will not handle the reserved key event. The event is handled by the processKeyDown and processKeyUp methods.

The context parameter can include the following items:

Item	Type	Description
context.isEditing	boolean	Whether the cell is being edited.
context.sheet	GcSpread.Sheets.Sheet instance	Indicates the current sheet.
context.row	number	The row index.
context.col	number	The column index.
context.sheetArea	GcSpread.Sheets.SheetArea	The current sheet area.

Reference

BaseCellType type
processKeyDown Method
processKeyUp Method