endEdit Method

Stops editing the active cell.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.Sheet(name);
var value; // Type: boolean
value = instance.endEdit(ignoreValueChange);

function endEdit( 
   ignoreValueChange : boolean
) : boolean;

Parameters

ignoreValueChange: If set to true, does not apply the edited text to the cell.

Return Value

true when able to stop cell editing successfully; otherwise, false.

Example

This example removes the text "123" when typing in a cell.

Javascript

activeSheet.bind(GcSpread.Sheets.Events.EditChange, function (sender,args) {
                if (args.editingText === "123") {
                    activeSheet.endEdit(true);
                }
            });

Reference

Sheet type