SpreadJS 13
GC.Spread.Sheets Namespace / Events type / SheetNameChanging Event
The sheet that triggered the event.
The sheet's old name.
The sheet's new name.
A value that indicates whether the operation should be canceled.
In This Topic
    SheetNameChanging Event
    In This Topic
    Occurs when the user is changing the sheet name.
    Syntax
    var instance; // Type: Events
    instance.SheetNameChanging = function(sheet, oldValue, newValue, cancel) { };
    SheetNameChanging = function ( 
       sheet : Worksheet,
       oldValue : string,
       newValue : string,
       cancel : boolean
    ) { };

    Parameters

    sheet
    The sheet that triggered the event.
    oldValue
    The sheet's old name.
    newValue
    The sheet's new name.
    cancel
    A value that indicates whether the operation should be canceled.
    Example
    This example uses the SheetNameChanging event.
    // Use IE to see the console log text
    spread.bind(GC.Spread.Sheets.Events.SheetNameChanging, function (sender, args) {
       console.log(args.oldValue);
    });
    
    spread.bind(GC.Spread.Sheets.Events.SheetNameChanged, function (sender, args) {
       console.log(args.newValue);
    });
    See Also

    Reference

    Events type