SpreadJS 13
GC.Spread.Sheets Namespace / CellRange type / locked Method
Set to true to lock the cell.
In This Topic
    locked Method
    In This Topic
    Gets or sets whether the cell is locked. When the sheet is protected, the locked cell cannot be edited.
    Syntax
    var instance = new GC.Spread.Sheets.CellRange(sheet, row, col, rowCount, colCount, sheetArea);
    var returnValue; // Type: any
    returnValue = instance.locked(value);
    function locked( 
       (optional) value : boolean
    ) : any;

    Parameters

    value
    Set to true to lock the cell.

    Return Value

    If no value is set, returns whether the cell is locked; otherwise, returns the cell.
    Example
    The following examples lock the column.
    activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).locked(false);
    activeSheet.getCell(1,1).locked(true);
    activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).locked(true);
    Remarks
    The default value is true.
    See Also

    Reference

    CellRange type