GC.Spread.Sheets.Events

Class: Events

Spread.Sheets.Events

Constructors

constructor

Events

Constructors

constructor

• new Events()

定义SpreadJS支持的事件。

Events

ActiveSheetChanged

• Static ActiveSheetChanged: string

当用户更改活动工作表时发生。

name GC.Spread.Sheets.Workbook#ActiveSheetChanged

param GC.Spread.Sheets.Worksheet oldSheet 旧工作表。

param GC.Spread.Sheets.Worksheet newSheet 新工作表。

example

//此示例为ActiveSheetChanged事件创建日志文本。
//使用浏览器查看控制台日志文本
spread.bind(GC.Spread.Sheets.Events.ActiveSheetChanged, function (sender, args) {
    console.log("Active sheet has been switched.");
});

ActiveSheetChanging

• Static ActiveSheetChanging: string

当用户正在更改活动工作表时发生。

name GC.Spread.Sheets.Workbook#ActiveSheetChanging

param GC.Spread.Sheets.Worksheet oldSheet 旧工作表。

param GC.Spread.Sheets.Worksheet newSheet 新工作表。

param boolean cancel 指示是否应取消操作的值。

example

//此示例阻止活动工作表更改。
spread.bind(GC.Spread.Sheets.Events.ActiveSheetChanging, function (sender, args) {
    //取消工作表切换。
    args.cancel = true;
});

BeforePrint

• Static BeforePrint: string

在打印之前发生。

name GC.Spread.Sheets.WorkBook.BeforePrint

param Object iframe 打印的DOM。

param boolean cancel 是否取消打印。

example

//此示例使用BeforePrint事件。
window.onload = function(){
     var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
     spread.bind(GC.Spread.Sheets.Events.BeforePrint, function (e, data) {
         alert(data.iframe + '\n' + 'cancel: ' + data.cancel);
     });
}

ButtonClicked

• Static ButtonClicked: string

当用户点击单元格中的按钮、复选框或超链接时发生。

name GC.Spread.Sheets.Workbook#ButtonClicked

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 单元格的行索引。

param number col 单元格的列索引。

param GC.Spread.Sheets.SheetArea sheetArea 包含单元格的工作表区域。

example

//此示例创建一个按钮单元格。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
activeSheet.setCellType(1,1,cellType);
//绑定
spread.bind(GC.Spread.Sheets.Events.ButtonClicked, function (e, args) {
    var sheet = args.sheet, row = args.row, col = args.col;
    var cellType = activeSheet.getCellType(row, col);
    if (cellType instanceof GC.Spread.Sheets.CellTypes.Button) {
        alert("Button Clicked");
    }
});

CalculationProgress

• Static CalculationProgress: string

在使用增量计算时发生。

name GC.Spread.Sheets.Workbook#CalculationProgress

param number totalCells 需要计算的总单元格数。

param number pendingCells 待计算的单元格数。

param number iterate 已完成的迭代计算次数，仅在迭代计算时可用。

example

//此示例使用CalculationProgress事件记录计算进度。
spread.options.incrementalCalculation = true;
spread.bind(GC.Spread.Sheets.Events.CalculationProgress, function (e, info) {
     var msg = "Calculate ";
     if (info.pendingCells === 0) {
         msg += "finished";
     } else if (info.iterate >= 0) {
         msg += info.pendingCells + " cells in iterative calculation round " + info.iterate;
     } else {
         msg += (info.totalCells - info.pendingCells) + "/" + info.totalCells + "cells";
     }
     console.log(msg)
});

CellChanged

• Static CellChanged: string

当对工作表中的单元格进行更改且可能需要重新绘制单元格时发生。

name GC.Spread.Sheets.Worksheet#CellChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 单元格的行索引。

param number col 单元格的列索引。

param GC.Spread.Sheets.SheetArea sheetArea 单元格的工作表区域。

param string propertyName 已更改的单元格属性名称。

param boolean isUndo 此事件是否来自撤销操作。

example

//此示例使用CellChanged事件。
activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (e, info) {
    if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
        alert("Cell index (" + info.row + "," + info.col + ")");
    }
});

CellClick

• Static CellClick: string

当用户在单元格中按下鼠标左键时发生。

name GC.Spread.Sheets.Worksheet#CellClick

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.SheetArea sheetArea 被点击单元格所在的工作表区域。

param number row 被点击单元格的行索引。

param number col 被点击单元格的列索引。

example

//此示例使用CellClick事件。
// 使用网页浏览器查看控制台日志文本
activeSheet.bind(GC.Spread.Sheets.Events.CellClick, function (sender, args) {
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
        console.log("列标题被点击。");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
        console.log("行标题被点击。");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
        console.log("角落标题被点击。");
    }
    console.log("点击的列索引: " + args.col);
    console.log("点击的行索引: " + args.row);
});
//绑定
activeSheet.bind(GC.Spread.Sheets.Events.CellDoubleClick, function (sender, args) {
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
        console.log("列标题被双击。");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
        console.log("行标题被双击。");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
        console.log("角落标题被双击。");
    }
    console.log("双击的列索引: " + args.col);
    console.log("双击的行索引: " + args.row);
})

CellDoubleClick

• Static CellDoubleClick: string

当用户在单元格中连续按下鼠标左键两次（双击）时发生。

name GC.Spread.Sheets.Worksheet#CellDoubleClick

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.SheetArea sheetArea 被点击单元格所在的工作表区域。

param number row 被点击单元格的行索引。

param number col 被点击单元格的列索引。

example

//此示例使用CellDoubleClick事件。
// 使用网页浏览器查看控制台日志文本
activeSheet.bind(GC.Spread.Sheets.Events.CellClick, function (sender, args) {
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
        console.log("列标题被点击。");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
        console.log("行标题被点击。");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
        console.log("角落标题被点击。");
    }
    console.log("点击的列索引: " + args.col);
    console.log("点击的行索引: " + args.row);
});
//绑定
activeSheet.bind(GC.Spread.Sheets.Events.CellDoubleClick, function (sender, args) {
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
        console.log("列标题被双击。");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
        console.log("行标题被双击。");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
        console.log("角落标题被双击。");
    }
    console.log("双击的列索引: " + args.col);
    console.log("双击的行索引: " + args.row);
});

ClipboardChanged

• Static ClipboardChanged: string

当影响Spread.Sheets的剪贴板发生变化时发生。

name GC.Spread.Sheets.Worksheet#ClipboardChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param Object copyData 已设置到剪贴板的Spread.Sheets数据。

param string copyData.text 剪贴板的文本字符串。

param string copyData.html 剪贴板的HTML字符串。

param Array objects 复制的浮动对象，包含图片、自定义浮动对象、切片器、图表和形状。

example

//此示例使用ClipboardChanged事件。
spread.bind(GC.Spread.Sheets.Events.ClipboardChanged, function (sender, args) {
    console.log("剪贴板已更改。", args);
});

ClipboardChanging

• Static ClipboardChanging: string

当由于Spread.Sheets操作导致剪贴板正在变化时发生。

name GC.Spread.Sheets.Worksheet#ClipboardChanging

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param Object copyData 设置到剪贴板的Spread.Sheets数据。

param string copyData.text 剪贴板的文本字符串。

param string copyData.html 剪贴板的HTML字符串。

param {@link GC.Spread.Sheets.Range[]} ranges 当前剪切或复制操作的源工作表源范围。

param GC.Spread.Sheets.ClipboardActionType action 指示当前操作的类型。

param Array objects 正在复制的浮动对象，包含图片、自定义浮动对象、切片器、图表和形状。

param boolean cancel 指示是否应取消操作的值。

example

//此示例使用ClipboardChanging事件。
spread.bind(GC.Spread.Sheets.Events.ClipboardChanging, function (sender, args) {
    console.log("剪贴板正在更改", args);
});

ClipboardPasted

• Static ClipboardPasted: string

当用户从剪贴板粘贴时发生。

name GC.Spread.Sheets.Worksheet#ClipboardPasted

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Range cellRange 被粘贴的范围。

param GC.Spread.Sheets.ClipboardPasteOptions pasteOption 指示从剪贴板粘贴的数据类型：值、格式或公式。

param Object pasteData 从剪贴板粘贴到Spread.Sheets的数据。

param string pasteData.text 剪贴板的文本字符串。

param string pasteData.html 剪贴板的HTML字符串。

param string pasteData.image 剪贴板的图片源字符串。

param GC.Spread.Sheets.Worksheet fromSheet 数据范围的源工作表。

param GC.Spread.Sheets.Range [fromRange] 复制或剪切范围时粘贴的源范围。

param GC.Spread.Sheets.ClipboardActionType action 指示当前操作的类型。

param Array objects 粘贴的浮动对象，包含图片、自定义浮动对象、切片器、图表和形状。

param GC.Spread.Sheets.InsertShiftCell [shiftCells] 如果未移动单元格，则将未定义。

example

//此示例使用ClipboardPasted事件。
spread.bind(GC.Spread.Sheets.Events.ClipboardPasted, function (sender, args) {
    console.log("ClipboardPasted", args);
});

ClipboardPasting

• Static ClipboardPasting: string

当用户从剪贴板粘贴时发生。

name GC.Spread.Sheets.Worksheet#ClipboardPasting

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Range cellRange 要粘贴的范围。

param GC.Spread.Sheets.ClipboardPasteOptions pasteOption 指示从剪贴板粘贴的数据类型：值、格式或公式。

param Object pasteData 将从剪贴板粘贴到Spread.Sheets的数据。

param string pasteData.text 剪贴板的文本字符串。

param string pasteData.html 剪贴板的HTML字符串。

param string pasteData.image 剪贴板的图片源字符串。

param GC.Spread.Sheets.Worksheet fromSheet 数据范围的源工作表。

param GC.Spread.Sheets.Range [fromRange] 复制或剪切范围时粘贴的源范围。

param GC.Spread.Sheets.ClipboardActionType action 指示当前操作的类型。

param Array objects 粘贴的浮动对象，包含图片、自定义浮动对象、切片器、图表和形状。

param boolean cancel 指示是否应取消操作的值。

param GC.Spread.Sheets.InsertShiftCell [shiftCells] 如果未移动单元格，则将未定义。

example

//此示例使用ClipboardPasting事件。
spread.bind(GC.Spread.Sheets.Events.ClipboardPasting, function (sender, args) {
    console.log("ClipboardPasting", args);
});

CollaborationEndRedo

• Static CollaborationEndRedo: string

在协作中重做后发生。

name GC.Spread.Sheets.Worksheet#CollaborationEndRedo

param object changeSet 重做操作对象。

example

//此示例。
workbook.bind(GC.Spread.Sheets.Events.CollaborationEndRedo, (sender, args) => {
    const changeSet = args.changeSet;
    console.log('redo changeSet is:' changeSet);
});

CollaborationEndUndo

• Static CollaborationEndUndo: string

在协作中撤销后发生。

name GC.Spread.Sheets.Worksheet#CollaborationEndUndo

param object changeSet 撤销操作对象。

example

//此示例。
workbook.bind(GC.Spread.Sheets.Events.CollaborationEndUndo, (sender, args) => {
    const changeSet = args.changeSet;
    console.log('undo changeSet is:' changeSet);
});

CollaborationStartRedo

• Static CollaborationStartRedo: string

在协作中重做之前发生。

name GC.Spread.Sheets.Worksheet#CollaborationStartRedo

param object changeSet 重做操作对象。

example

//此示例。
workbook.bind(GC.Spread.Sheets.Events.CollaborationStartRedo, (sender, args) => {
    const changeSet = args.changeSet;
    console.log('redo changeSet is:' changeSet);
});

CollaborationStartUndo

• Static CollaborationStartUndo: string

在协作中撤销之前发生。

name GC.Spread.Sheets.Worksheet#CollaborationStartUndo

param object changeSet 撤销操作对象。

example

//此示例。
workbook.bind(GC.Spread.Sheets.Events.CollaborationStartUndo, (sender, args) => {
    const changeSet = args.changeSet;
    console.log('undo changeSet is:' changeSet);
});

ColumnChanged

• Static ColumnChanged: string

当对工作表中的列或列范围进行更改时发生，可能需要重新绘制列或列范围。

name GC.Spread.Sheets.Worksheet#ColumnChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number col 列索引。

param GC.Spread.Sheets.SheetArea sheetArea 列的工作表区域。

param string propertyName 列的属性名称。

param boolean isUndo 是否来自撤销操作。

example

//此示例使用ColumnChanged事件。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnChanged, function (e, info) {
    if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
        alert("Index (" + info.col + ")");
    }
});

ColumnChanging

• Static ColumnChanging: string

当对工作表中的列或列范围进行更改时发生，可能需要重新绘制列或列范围。

name GC.Spread.Sheets.Worksheet#ColumnChanging

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number col 列索引。

param GC.Spread.Sheets.SheetArea sheetArea 列的工作表区域。

param string propertyName 列的属性名称。

example

//此示例使用ColumnChanging事件。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnChanging, function (e, info) {
    if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
        alert("Index (" + info.col + ")");
    }
});

ColumnWidthChanged

• Static ColumnWidthChanged: string

当列宽度发生变化时触发。

name GC.Spread.Sheets.Worksheet#ColumnWidthChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param Array colList 列宽发生变化的列列表。

param boolean header 是否为行标题列。

example

//此示例使用ColumnWidthChanged事件。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnWidthChanged, function (e, info) {
        alert("Column (" + info.colList + ")");
});

ColumnWidthChanging

• Static ColumnWidthChanging: string

当列宽发生变化时触发。

name GC.Spread.Sheets.Worksheet#ColumnWidthChanging

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param Array colList 列宽发生变化的列列表。

param boolean header 是否为行标题列。

param boolean cancel 指示是否应取消操作的值。

example

//此示例使用ColumnWidthChanging事件。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnWidthChanging, function (e, info) {
        alert("Column (" + info.colList + ")");
});

CommentChanged

• Static CommentChanged: string

当任何注释发生变化时触发。

name GC.Spread.Sheets.Worksheet#CommentChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Comments.Comment comment 触发事件的注释。

param string propertyName 已更改的注释属性名称。

example

//此示例使用CommentChanged事件。
activeSheet.bind(GC.Spread.Sheets.Events.CommentChanged, function (e, info) {
    alert("changed");
});

CommentRemoved

• Static CommentRemoved: string

当用户删除注释时触发。

name GC.Spread.Sheets.Worksheet#CommentRemoved

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Comments.Comment comment 已删除的注释。

example

//此示例使用CommentRemoved事件。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("orange");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
activeSheet.bind(GC.Spread.Sheets.Events.CommentRemoved, function (e, info) {
       console.log("sheet name: " + info.sheetName);
});

CommentRemoving

• Static CommentRemoving: string

当用户正在删除任何注释时触发。

name GC.Spread.Sheets.Worksheet#CommentRemoving

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Comments.Comment comment 正在删除的注释。

param boolean cancel 指示是否应取消操作的值。

example

//此示例阻止注释被删除。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("orange");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
activeSheet.bind(GC.Spread.Sheets.Events.CommentRemoving, function (e, info) {
      info.cancel = true;
});

DataFetchCompleted

• Static DataFetchCompleted: string

当通过工作簿打开或导入sjs/json格式文件时，数据管理器中的所有表完全获取完成时触发。

name GC.Spread.Sheets.Worksheet#DataFetchCompleted

param GC.Spread.Sheets.Workbook spread 触发事件的工作簿。

example

//此示例使用DataFetchCompleted事件。
//通常，DataFetchCompleted事件在工作簿open方法的successCallback调用后触发。
//如果不使用数据管理器的任何表，并且工作簿包含大量工作表，则DataFetchCompleted事件可能在工作簿open方法的successCallback调用之前触发。
let isOpenFinished = false, isDataFetchCompleted = false;
spread.bind(GC.Spread.Sheets.Events.DataFetchCompleted, function () {
    isDataFetchCompleted = true;
    if (isOpenFinished) {
        // 对获取的数据执行操作
    }
});
spread.open(file, function () {
    isOpenFinished = true;
    if (isDataFetchCompleted) {
        // 对打开的文件执行操作
    }
}, function () { }, {});

DragDropBlock

• Static DragDropBlock: string

当用户正在拖放单元格范围时触发。

name GC.Spread.Sheets.Worksheet#DragDropBlock

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number fromRow 源范围（被拖动的范围）左上角单元格的行索引。

param number fromCol 源范围（被拖动的范围）左上角单元格的列索引。

param number toRow 目标范围（放置选择的位置）左上角单元格的行索引。

param number toCol 目标范围（放置选择的位置）右下角单元格的列索引。

param number rowCount 被拖动的单元格范围的行数。

param number colCount 被拖动的单元格范围的列数。

param boolean copy 源范围是否被复制。

param boolean insert 源范围是否被插入。

param GC.Spread.Sheets.CopyToOptions copyOption 拖放操作的CopyOption值。

param boolean cancel 指示是否应取消操作的值。

example

//此示例为DragDropBlock事件创建日志文本。
// 使用网页浏览器查看控制台日志文本
var activeSheet = spread.getActiveSheet();
activeSheet.bind(GC.Spread.Sheets.Events.DragDropBlock, function (e, args) {
        console.log("From Column:" + args.fromCol);
        console.log("From Row:" + args.fromRow);
        console.log("To Column:" + args.toCol);
        console.log("To Row:" + args.toRow);
    });

DragDropBlockCompleted

• Static DragDropBlockCompleted: string

当用户完成拖放单元格范围时触发。

name GC.Spread.Sheets.Worksheet#DragDropBlockCompleted

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number fromRow 源范围（被拖动的范围）左上角单元格的行索引。

param number fromCol 源范围（被拖动的范围）左上角单元格的列索引。

param number toRow 目标范围（放置选择的位置）左上角单元格的行索引。

param number toCol 目标范围（放置选择的位置）右下角单元格的列索引。

param number rowCount 被拖动的单元格范围的行数。

param number colCount 被拖动的单元格范围的列数。

param boolean copy 源范围是否被复制。

param boolean insert 源范围是否被插入。

param GC.Spread.Sheets.CopyToOptions copyOption 拖放操作的CopyOption值。

example

//此示例使用DragDropBlockCompleted事件。
activeSheet.bind(GC.Spread.Sheets.Events.DragDropBlockCompleted, function (e, args) {
        alert("From Column (" + args.fromCol + ")");
});

DragFillBlock

• Static DragFillBlock: string

当用户正在拖动填充单元格范围时触发。

name GC.Spread.Sheets.Worksheet#DragFillBlock

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Range fillRange 用于填充操作的范围。

param GC.Spread.Sheets.Fill.AutoFillType autoFillType 用于填充操作的AutoFillType值。

param GC.Spread.Sheets.Fill.FillDirection fillDirection 填充的方向。

param boolean cancel 指示是否应取消操作的值。

example

//此示例使用DragFillBlock事件。
activeSheet.bind(GC.Spread.Sheets.Events.DragFillBlock, function (e, info) {
        alert("Direction (" + info.fillDirection + ")");
});

DragFillBlockCompleted

• Static DragFillBlockCompleted: string

当用户完成拖动填充单元格范围时触发。

name GC.Spread.Sheets.Worksheet#DragFillBlockCompleted

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Range fillRange 用于填充操作的范围。

param GC.Spread.Sheets.Fill.AutoFillType autoFillType 用于填充操作的AutoFillType值。

param GC.Spread.Sheets.Fill.FillDirection fillDirection 填充的方向。

example

//此示例使用DragFillBlockCompleted事件。
activeSheet.bind(GC.Spread.Sheets.Events.DragFillBlockCompleted, function (e, info) {
        alert("Type (" + info.autoFillType + ")");
});

DragMerged

• Static DragMerged: string

在用户拖动合并单元格后触发。

name GC.Spread.Sheets.Worksheet#DragMerged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Range mergeRange 将要合并的范围。

example

//此示例返回行索引。
// 按Ctrl键进行合并
$(document).keydown(function (e) {
     if (e.keyCode === 17) {
        spread.options.allowUserDragMerge = true;
     }
});
$(document).keyup(function (e) {
     if (e.keyCode === 17) {
        spread.options.allowUserDragMerge = false;
     }
});
activeSheet.bind(GC.Spread.Sheets.Events.DragMerging, function (e, data) {
     var mergeRange = data.mergeRange;
     alert(mergeRange.row);
});
activeSheet.bind(GC.Spread.Sheets.Events.DragMerged, function (e, data) {
     var mergeRange = data.mergeRange;
     alert(mergeRange.row);
});

DragMerging

• Static DragMerging: string

在用户拖动合并单元格之前触发。

name GC.Spread.Sheets.Worksheet#DragMerging

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Range mergeRange 将要合并的范围。

param boolean cancel 指示是否应取消操作的值。

example

//此示例返回行索引。
// 按Ctrl键进行合并
$(document).keydown(function (e) {
     if (e.keyCode === 17) {
         spread.options.allowUserDragMerge = true;
     }
});
$(document).keyup(function (e) {
     if (e.keyCode === 17) {
         spread.options.allowUserDragMerge = false;
     }
});
activeSheet.bind(GC.Spread.Sheets.Events.DragMerging, function (e, data) {
     var mergeRange = data.mergeRange;
     alert(mergeRange.row);
});
activeSheet.bind(GC.Spread.Sheets.Events.DragMerged, function (e, data) {
     var mergeRange = data.mergeRange;
     alert(mergeRange.row);
});

EditChange

• Static EditChange: string

当单元格处于编辑模式且文本发生更改时触发。

name GC.Spread.Sheets.Worksheet#EditChange

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 单元格的行索引。

param number col 单元格的列索引。

param Object editingText 当前编辑器的值。

example

//此示例为EditChange事件创建日志文本。
// 使用网页浏览器查看控制台日志文本
activeSheet.bind(GC.Spread.Sheets.Events.EditChange, function (sender, args) {
    console.log("单元格 (" + args.row + ", " + args.col + ") 的数据已更改。")
});

EditEnded

• Static EditEnded: string

当单元格退出编辑模式时触发。

name GC.Spread.Sheets.Worksheet#EditEnded

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 单元格的行索引。

param number col 单元格的列索引。

param Object editingText 当前编辑器的值。

param boolean committed 值更改是否已提交。

example

//此示例为EditStarting和EditEnded事件创建日志文本。
// 使用网页浏览器查看控制台日志文本
var activeSheet = spread.getActiveSheet();
activeSheet.bind(GC.Spread.Sheets.Events.EditStarting, function (sender, args) {
    console.log("开始单元格编辑。");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnded, function (sender, args) {
    console.log("完成单元格编辑。");
});

EditEnding

• Static EditEnding: string

当单元格正在退出编辑模式时触发。

name GC.Spread.Sheets.Worksheet#EditEnding

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 单元格的行索引。

param number col 单元格的列索引。

param Object editor 当前编辑器。

param Object editingText 当前编辑器的值。

param boolean cancel 指示是否应取消操作的值。

param boolean committed 值更改是否已提交。

example

//此示例使用EditEnding事件。
activeSheet.bind(GC.Spread.Sheets.Events.EditStarting, function (sender, args) {
    console.log("开始单元格编辑。");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnding, function (sender, args) {
    console.log("EditEnding事件。");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnded, function (sender, args) {
    console.log("EditEnded事件。");
});

EditStarting

• Static EditStarting: string

当单元格进入编辑模式时触发。

name GC.Spread.Sheets.Worksheet#EditStarting

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 单元格的行索引。

param number col 单元格的列索引。

param boolean cancel 指示是否应取消操作的值。

example

//此示例为EditStarting和EditEnded事件创建日志文本。
// 使用网页浏览器查看控制台日志文本
var activeSheet = spread.getActiveSheet();
activeSheet.bind(GC.Spread.Sheets.Events.EditStarting, function (sender, args) {
    console.log("开始单元格编辑。");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnded, function (sender, args) {
    console.log("完成单元格编辑。");
});

EditorStatusChanged

• Static EditorStatusChanged: string

当编辑器的状态发生更改时触发。

name GC.Spread.Sheets.Worksheet#EditorStatusChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.EditorStatus oldStatus 编辑器的旧状态。

param GC.Spread.Sheets.EditorStatus newStatus 编辑器的新状态。

example

//此示例使用EditorStatusChanged事件。
activeSheet.bind(GC.Spread.Sheets.Events.EditorStatusChanged, function (e, info) {
        alert("列 (" + info.newStatus + ")");
});

EnterCell

• Static EnterCell: string

当焦点进入单元格时触发。

name GC.Spread.Sheets.Worksheet#EnterCell

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 正在进入的单元格的行索引。

param number col 正在进入的单元格的列索引。

example

//此示例使用EnterCell事件。
activeSheet.bind(GC.Spread.Sheets.Events.EnterCell, function (e, info) {
        alert("单元格 (" + info.row + ", " + info.col +")");
});

FloatingObjectChanged

• Static FloatingObjectChanged: string

当任何浮动对象发生变化时触发。

name GC.Spread.Sheets.Worksheet#FloatingObjectsChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject 触发事件的浮动对象。

param string propertyName 已更改的浮动对象属性的名称。

example

//此示例使用FloatingObjectChanged事件。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
activeSheet.bind(GC.Spread.Sheets.Events.FloatingObjectChanged, function (e, info) {
       alert("已更改");
});

FloatingObjectLoaded

• Static FloatingObjectLoaded: string

当自定义浮动对象内容加载完成时触发。

name GC.Spread.Sheets.Worksheet#FloatingObjectLoaded

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject 触发事件的自定义浮动对象。

param HTMLElement element 自定义浮动对象的HTMLElement。

FloatingObjectRemoved

• Static FloatingObjectRemoved: string

当用户已移除浮动对象时触发。

name GC.Spread.Sheets.Worksheet#FloatingObjectRemoved

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject 已被移除的浮动对象。

example

//此示例使用FloatingObjectRemoved事件。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
activeSheet.bind(GC.Spread.Sheets.Events.FloatingObjectRemoved, function (e, info) {
        alert(info.sheetName);
});

FloatingObjectRemoving

• Static FloatingObjectRemoving: string

当用户正在移除任何浮动对象时触发。

name GC.Spread.Sheets.Worksheet#FloatingObjectRemoving

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject 正在被移除的浮动对象。

param boolean cancel 指示是否应取消操作的值。

example

//此示例使用FloatingObjectRemoving事件。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
activeSheet.bind(GC.Spread.Sheets.Events.FloatingObjectRemoving, function (e, info) {
        info.cancel = true;
});

FloatingObjectSelectionChanged

• Static FloatingObjectSelectionChanged: string

当浮动对象的选择发生变化时触发。

name GC.Spread.Sheets.Worksheet#FloatingObjectsSelectionChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject 触发事件的浮动对象。

example

//此示例使用FloatingObjectSelectionChanged事件。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
// Use web browser to see the console log text
activeSheet.bind(GC.Spread.Sheets.Events.FloatingObjectSelectionChanged, function (e, info) {
       console.log("sheet name: " + info.sheetName);
});

FormControlButtonClicked

• Static FormControlButtonClicked: string

当按钮表单控件被点击时触发。

name GC.Spread.Sheets.Worksheet#FormControlButtonClicked

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Shapes.Shape shape 触发事件的形状。

example

//此示例使用FormControlButtonClicked事件。
var shape = sheet.shapes.addFormControl("button", GC.Spread.Sheets.Shapes.FormControlType.button, 50, 50, 150, 100);
activeSheet.bind(GC.Spread.Sheets.Events.FormControlButtonClicked, function (e, info) {
       console.log("event info: " + info);
});

FormControlValueChanged

• Static FormControlValueChanged: string

当表单控件的值发生变化时触发。

name GC.Spread.Sheets.Worksheet#FormControlValueChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Shapes.Shape shape 触发事件的形状。

param any newValue 表单控件的新值。

param any oldValue 表单控件的旧值。

example

//此示例使用FormControlValueChanged事件。
var shape = sheet.shapes.addFormControl('spin', GC.Spread.Sheets.Shapes.FormControlType.spinButton, 50, 50, 150, 100);
activeSheet.bind(GC.Spread.Sheets.Events.FormControlValueChanged, function (e, info) {
       console.log("event info: " + info);
});

InvalidOperation

• Static InvalidOperation: string

当执行无效操作时触发。

name GC.Spread.Sheets.Worksheet#InvalidOperation

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.InvalidOperationType invalidType 指示哪个操作无效。

param string message 无效操作的描述。

param GC.Spread.Sheets.Range [fillRange] 当invalidType为dragFill时，用于填充操作的范围。

example

//此示例使用InvalidOperation事件。
activeSheet.bind(GC.Spread.Sheets.Events.InvalidOperation, function (e, info) {
        alert("Message (" + info.message + ")");
});

LeaveCell

• Static LeaveCell: string

当焦点离开单元格时触发。

name GC.Spread.Sheets.Worksheet#LeaveCell

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 正在离开的单元格的行索引。

param number col 正在离开的单元格的列索引。

param boolean cancel 是否应取消操作。

example

//此示例为LeaveCell事件创建日志文本。
// 使用网页浏览器查看控制台日志文本
activeSheet.bind(GC.Spread.Sheets.Events.LeaveCell, function (sender, args) {
    console.log("The column index before moving: " + args.col);
    console.log("The row index before moving: " + args.row);
});

LeftColumnChanged

• Static LeftColumnChanged: string

当左侧列发生变化时触发。

name GC.Spread.Sheets.Worksheet#LeftColumnChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number oldLeftCol 旧的左侧列索引。

param number newLeftCol 新的左侧列索引。

param number oldOffset 旧的左侧列偏移量。

param number newOffset 新的左侧列偏移量。

example

//此示例同步sheet 1和sheet 2的垂直和水平滚动。
var sheet1 = spread.getSheet(0),
sheet2 = spread.getSheet(1);
sheet1.bind(GC.Spread.Sheets.Events.TopRowChanged, function (sender, args) {
    //将sheet1的显示顶部行设置为sheet2（垂直滚动同步）。
    sheet2.showRow(args.newTopRow, GC.Spread.Sheets.VerticalPosition.top);
});
sheet1.bind(GC.Spread.Sheets.Events.LeftColumnChanged, function (sender, args) {
    //将sheet1的显示左侧列设置为sheet2（水平滚动同步）。
    sheet2.showColumn(args.newLeftCol, GC.Spread.Sheets.HorizontalPosition.left);
});

OutlineColumnCheckStatusChanged

• Static OutlineColumnCheckStatusChanged: string

当大纲列的检查状态发生变化时触发。

name GC.Spread.Sheets.Worksheet#OutlineColumnCheckStatusChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 大纲列的更改行索引。

param number col 大纲列的更改列索引。

param boolean status 大纲列的更改状态

example

//删除迷你图会导致变更。
activeSheet.bind(GC.Spread.Sheets.Events.OutlineColumnCheckStatusChanged, function (e, info) {
     console.log("状态: " + info.status);
});

PictureChanged

• Static PictureChanged: string

当任何图片发生变化时触发。

name GC.Spread.Sheets.Worksheet#PictureChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.FloatingObjects.Picture picture 触发事件的图片。

param string propertyName 已更改的图片属性名称。

example

var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
var activeSheet = spread.getActiveSheet();
activeSheet.pictures.add("f2","Event.png",2,2,6,6);
activeSheet.pictures.add("f1","tsoutline.png",3,0,6,6);
// 使用网页浏览器查看控制台日志文本
activeSheet.bind(GC.Spread.Sheets.Events.PictureChanged, function (e, info) {
console.log("工作表: " + info.sheetName);
console.log("属性: " + info.propertyName);
});

PictureSelectionChanged

• Static PictureSelectionChanged: string

当图片的选择发生变化时触发。

name GC.Spread.Sheets.Worksheet#PictureSelectionChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.FloatingObjects.Picture picture 触发事件的图片。

example

//此示例使用PictureSelectionChanged事件。
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
var activeSheet = spread.getActiveSheet();
activeSheet.pictures.add("f2","Event.png",2,2,6,6);
activeSheet.pictures.add("f1","tsoutline.png",3,0,6,6);
// 使用网页浏览器查看控制台日志文本
activeSheet.bind(GC.Spread.Sheets.Events.PictureSelectionChanged, function (e, info) {
console.log("工作表: " + info.sheetName);
});

PivotTableChanged

• Static PivotTableChanged: string

数据透视表筛选/排序/折叠/字段更改/总计/显示无数据/分组后触发。

name GC.Spread.Sheets.Worksheet#PivotTableChanged

param string pivotTableName 数据透视表的名称。

param string [fieldName] 更改的字段名称。

param string [sourceName] 更改的字段源名称。

param boolean [oldValue] 数据透视表更改的前一个属性值(collapse, summarizedValueBy, showValueAs)。

param boolean [newValue] 数据透视表更改的前一个属性值(collapse, summarizedValueBy, showValueAs)。

param number [sortType] 数据透视表排序更改的属性值(sort)。

param Object [filterInfo] 数据透视表筛选更改的属性值(filter)。

param number [clearType] 数据透视表清除筛选更改的属性值(filter)。

param number [oldArea] 旧的数据透视表字段类型(fieldChanged)。

param number [oldIndex] 旧的数据透视表字段索引(fieldChanged)。

param number [newArea] 新的数据透视表字段类型(fieldChanged)。

param number [newIndex] 新的数据透视表字段索引(fieldChanged)。

param string [viewName] 应用的数据透视表视图名称(viewChanged)。

example

//此示例。
sheet.bind(GC.Spread.Sheets.Events.PivotTableChanged, function (sender, args) {
    alert("数据透视表名称: " + args.pivotTableName + "更改类型: " + args.type);
});

RangeChanged

• Static RangeChanged: string

当单元格范围发生变化时触发。

name GC.Spread.Sheets.Worksheet#RangeChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 范围的行索引。

param number col 范围的列索引。

param number rowCount 范围的行数。

param number colCount 范围的列数。

param string[] tableNames 表名集合。

param Object[] changedCells 数据已更改的单元格位置，每个位置都有行和列。

param GC.Spread.Sheets.RangeChangedAction action 引发RangeChanged事件的操作类型。

param boolean isUndo 此事件是否来自撤销操作。

example

//此示例在Microsoft Internet Explorer中更改单元格范围时返回工作表名称和操作。
 activeSheet.bind(GC.Spread.Sheets.Events.RangeChanged, function (sender, args) {
  console.log(args.sheetName, args.action);
});

RangeFilterCleared

• Static RangeFilterCleared: string

当范围列刚刚被清除筛选时触发。

name GC.Spread.Sheets.Worksheet#RangeFilterCleared

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number col 刚刚被清除筛选的工作表列索引。

example

//此示例使用RangeFilterCleared事件。
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
var cellRange =new GC.Spread.Sheets.Range(0, 0, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellRange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeFilterCleared, function (e, info) {
        alert("Col (" + info.col + ")");
});

RangeFilterClearing

• Static RangeFilterClearing: string

当范围列即将被自动清除筛选时触发。

name GC.Spread.Sheets.Worksheet#RangeFilterClearing

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number col 即将被自动清除筛选的工作表列索引。

example

//此示例使用RangeFilterClearing事件。
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
var cellRange =new GC.Spread.Sheets.Range(0, 0, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellRange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeFilterClearing, function (e, info) {
        alert("Col (" + info.col + ")");
});

RangeFiltered

• Static RangeFiltered: string

当列刚刚被自动筛选时触发。

name GC.Spread.Sheets.Worksheet#RangeFiltered

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number col 被自动筛选的列索引。

param Array filterValues 用于筛选列的值。

param Array conditionInfo 用于筛选列的条件规则信息。

example

//此示例使用RangeFiltered事件。
var cellrange =new GC.Spread.Sheets.Range(0, 2, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeFiltered, function (e, info) {
        alert("Col (" + info.col + ")");
});

RangeFiltering

• Static RangeFiltering: string

当列即将被自动筛选时触发。

name GC.Spread.Sheets.Worksheet#RangeFiltering

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number col 即将被自动筛选的列索引。

param Array filterValues 用于筛选列的值。

param Object conditionInfo 用于筛选列的条件规则信息。

example

//此示例使用RangeFiltering事件。
var cellrange =new GC.Spread.Sheets.Range(0, 2, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeFiltering, function (e, info) {
       alert("Col (" + info.col + ")");
});

RangeGroupStateChanged

• Static RangeGroupStateChanged: string

当用户更改行或列的大纲状态（范围组）时触发。

name GC.Spread.Sheets.Worksheet#RangeGroupStateChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param boolean isRowGroup 大纲（范围组）是否为行组。

param number index 状态已更改的RangeGroupInfo对象的索引。

param number level 状态已更改的RangeGroupInfo对象的级别。

example

//此示例使用RangeGroupStateChanged事件。
activeSheet.suspendPaint();
activeSheet.setRowCount(34);
activeSheet.setValue(0,0,"Western");
activeSheet.setValue(0,1,"Western");
activeSheet.setValue(0,2,"Western");
activeSheet.setValue(1,0,"A");
activeSheet.setValue(1,1,"B");
activeSheet.setValue(1,2,"C");
activeSheet.setValue(2,0,"A");
activeSheet.setValue(2,1,"B");
activeSheet.setValue(2,2,"C");
activeSheet.rowOutlines.group(0,2);
activeSheet.columnOutlines.group(0,1);
activeSheet.resumePaint();
activeSheet.bind(GC.Spread.Sheets.Events.RangeGroupStateChanged, function (e, info) {
        alert("Level (" + info.level + ")");
});

RangeGroupStateChanging

• Static RangeGroupStateChanging: string

当用户即将更改行或列的大纲状态（范围组）时触发。

name GC.Spread.Sheets.Worksheet#RangeGroupStateChanging

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param boolean isRowGroup 大纲（范围组）是否为行组。

param number index 状态正在更改的RangeGroupInfo对象的索引。

param number level 状态正在更改的RangeGroupInfo对象的级别。

param boolean cancel 指示是否应取消操作的值。

example

//此示例使用RangeGroupStateChanging事件。
activeSheet.suspendPaint();
activeSheet.setRowCount(34);
activeSheet.setValue(0,0,"Western");
activeSheet.setValue(0,1,"Western");
activeSheet.setValue(0,2,"Western");
activeSheet.setValue(1,0,"A");
activeSheet.setValue(1,1,"B");
activeSheet.setValue(1,2,"C");
activeSheet.setValue(2,0,"A");
activeSheet.setValue(2,1,"B");
activeSheet.setValue(2,2,"C");
activeSheet.rowOutlines.group(0,2);
activeSheet.columnOutlines.group(0,1);
activeSheet.resumePaint();
activeSheet.bind(GC.Spread.Sheets.Events.RangeGroupStateChanging, function (e, info) {
        alert("Level (" + info.level + ")");
});

RangeSorted

• Static RangeSorted: string

当列刚刚被自动排序时触发。

name GC.Spread.Sheets.Worksheet#RangeSorted

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number col 被自动排序的列索引。

param boolean ascending 自动排序是否为升序。

example

//此示例使用RangeSorted事件。
activeSheet.setValue(0, 0, 10);
activeSheet.setValue(1, 0, 100);
activeSheet.setValue(2, 0, 50);
activeSheet.setValue(3, 0, 40);
activeSheet.setValue(4, 0, 80);
activeSheet.setValue(5, 0, 1);
activeSheet.setValue(6, 0, 65);
activeSheet.setValue(7, 0, 20);
activeSheet.setValue(8, 0, 30);
activeSheet.setValue(9, 0, 35);
var cellrange =new GC.Spread.Sheets.Range(0, 0, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeSorted, function (e, info) {
        alert("Col (" + info.col + ", " + info.ascending +")");
});

RangeSorting

• Static RangeSorting: string

当列即将被自动排序时触发。

name GC.Spread.Sheets.Worksheet#RangeSorting

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number col 即将被自动排序的列索引。

param boolean ascending 自动排序是否为升序。

param boolean cancel 是否应取消操作。

param GC.Spread.Sheets.Range range 自动排序的范围。

param GC.Spread.Sheets.GroupSort groupSort 排序时使用的groupSort级别，默认情况下如果包含组则使用组级别，如果不包含组则使用平面级别。

param boolean ignoreHidden 是否忽略隐藏值并仅对可见值进行排序。

param Function compareFunction 排序时使用的自定义函数，用于值排序。function (value1, value2) {return 0;}

example

//此示例使用RangeSorting事件。
activeSheet.setValue(0, 0, 10);
activeSheet.setValue(1, 0, 100);
activeSheet.setValue(2, 0, 50);
activeSheet.setValue(3, 0, 40);
activeSheet.setValue(4, 0, 80);
activeSheet.setValue(5, 0, 1);
activeSheet.setValue(6, 0, 65);
activeSheet.setValue(7, 0, 20);
activeSheet.setValue(8, 0, 30);
activeSheet.setValue(9, 0, 35);
var cellrange =new GC.Spread.Sheets.Range(0, 0, 10, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeSorting, function (e, info) {
        alert("Col (" + info.col + ", " + info.ascending +")");
        info.groupSort = GC.Spread.Sheets.GroupSort.full; //使用完整级别排序。
        info.ignoreHidden = false; // 对隐藏值进行排序。
        info.compareFunction = (obj1, obj2)=>{return obj1.toString().localeCompare(obj2.toString())};
});

ReportSheetDataChanged

• Static ReportSheetDataChanged: string

当报表数据通过更新、插入或删除发生更改时触发。允许将数据更改提交到服务器。

name GC.Spread.Report.ReportSheet#ReportSheetDataChanged

param GC.Spread.Report.ReportSheet sheet 触发事件的报表。

param string sheetName 报表的名称。

param string type 报表更改类型。insert、update 或 delete。

param number row 更改的行索引。

param number col 更改的列索引。

example

//此示例使用 ReportSheetDataChanged 事件。
const report = spread.addSheetTab(0, "Report", GC.Spread.Sheets.SheetType.reportSheet);
report.renderMode("Design");
const templateSheet = report.getTemplate();
templateSheet.setTemplateCell(0, 0, {
   binding: "Orders[orderId]",
   type: "Group",
});
templateSheet.setTemplateCell(0, 1, {
   binding: "Orders[customerId]",
   type: "Group",
});
templateSheet.setDataEntrySetting([ {
   name: "Write Back Rule 1",
   tableName: "Orders",
   fields: [
       { dbColumnName: "orderId", formula: "A1", isPrimary: true },
       { dbColumnName: "customerId", formula: "B1" },
   ],
   includeUnmodified: false,
   skipRecordWithEmptyValue: false
} ]);
report.renderMode("Preview");
report.bind(GC.Spread.Sheets.Events.ReportSheetDataChanged, (event, args) => {
    let reportsheet = args.sheet, changes = reportsheet.getChanges();
    if (allowSubmit(changes)) { // 用户可以提交或放弃此更改。
         reportsheet.submit(); // 提交更改。
    } else {
         reportsheet.refresh(); // 放弃更改。
    }
});
// 在 UI 中编辑/更新/删除报表记录后将触发 ReportSheetDataChanged 事件。
// 用户可以在此刻提交到服务器或放弃此更改。

ReportSheetDataChanging

• Static ReportSheetDataChanging: string

当报表通过更新、插入或删除进行更改时触发。允许验证或取消数据操作。

name GC.Spread.Report.ReportSheet#ReportSheetDataChanging

param GC.Spread.Report.ReportSheet sheet 触发事件的报表。

param string sheetName 报表的名称。

param string type 报表更改类型。insert、update 或 delete。

param number row 正在更改的行索引。

param number col 正在更改的列索引。

param any oldValue 更新更改的旧值。

param any newValue 更新更改的新值。

param boolean cancel 是否应取消报表更改操作。

example

//此示例使用 ReportSheetDataChanging 事件。
const report = spread.addSheetTab(0, "Report", GC.Spread.Sheets.SheetType.reportSheet);
report.renderMode("Design");
const templateSheet = report.getTemplate();
templateSheet.setTemplateCell(0, 0, {
   binding: "Orders[orderId]",
   type: "Group",
});
templateSheet.setTemplateCell(0, 1, {
   binding: "Orders[customerId]",
   type: "Group",
});
templateSheet.setDataEntrySetting([ {
   name: "Write Back Rule 1",
   tableName: "Orders",
   fields: [
       { dbColumnName: "orderId", formula: "A1", isPrimary: true },
       { dbColumnName: "customerId", formula: "B1" },
   ],
   includeUnmodified: false,
   skipRecordWithEmptyValue: false
} ]);
report.renderMode("Preview");
report.bind(GC.Spread.Sheets.Events.ReportSheetDataChanging, (event, args) => {
    let { type, row, col, oldValue, newValue } = args;
    if (allowChange(type, row, col, oldValue, newValue)) { // 用户在此处验证此更改操作。
        console.log(`${type} row: ${row}, col: ${col} from ${oldValue} to ${newValue}`);
    } else {
        args.cancel = true;
    }
});
// 在 UI 中编辑/更新/删除报表记录后将触发 ReportSheetDataChanging 事件。
// 如果更改无效，用户也可以在此处取消操作。

ReportSheetRecordsSubmitted

• Static ReportSheetRecordsSubmitted: string

在报表将更改提交到服务器后触发。允许用户提供来自服务器的提交结果的 UI 反馈。

name GC.Spread.Report.ReportSheet#ReportSheetRecordsSubmitted

param GC.Spread.Report.ReportSheet sheet 触发事件的报表。

param string sheetName 报表的名称。

param {@link GC.Spread.Report.IRecord[]} updateSuccessRecords 成功更新或插入的记录。

param {@link GC.Spread.Report.IFailedRecord[]} updateFailedRecords 更新或插入失败的记录。

param {@link GC.Spread.Report.IRecord[]} deleteSuccessRecords 成功删除的记录。

param {@link GC.Spread.Report.IFailedRecord[]} deleteFailedRecords 删除失败的记录。

example

//此示例使用 ReportSheetDataChanged 事件。
const report = spread.addSheetTab(0, "Report", GC.Spread.Sheets.SheetType.reportSheet);
report.renderMode("Design");
const templateSheet = report.getTemplate();
templateSheet.setTemplateCell(0, 0, {
   binding: "Orders[orderId]",
   type: "Group",
});
templateSheet.setTemplateCell(0, 1, {
   binding: "Orders[customerId]",
   type: "Group",
});
templateSheet.setDataEntrySetting([ {
   name: "Write Back Rule 1",
   tableName: "Orders",
   fields: [
       { dbColumnName: "orderId", formula: "A1", isPrimary: true },
       { dbColumnName: "customerId", formula: "B1" },
   ],
   includeUnmodified: false,
   skipRecordWithEmptyValue: false
} ]);
report.renderMode("Preview");
report.bind(GC.Spread.Sheets.Events.ReportSheetRecordsSubmitted, (event, args) => {
    let { updateSuccessRecords, deleteSuccessRecords, updateFailedRecords, deleteFailedRecords } = args;
    for (let record of updateFailedRecords) {
        for (let fieldKey in record.info) {
            if (record.info.hasOwnproperty(fieldKey)) {
                let recordDetail = record.info[fieldKey];
                if (recordDetail.state === "updated") {
                    // 用户控制台输出失败详细信息。
                    console.log(`Updated failed in row: ${recordDetail.row} col: ${recordDetail.col}, oldValue: ${recordDetail.oldValue}, reason is ${record.reason}`);
                }
            }
        }
    }
});
// 提交到服务器后，用户可以获取所有成功和失败的记录结果。

ReportSheetRecordsSubmitting

• Static ReportSheetRecordsSubmitting: string

在报表向服务器提交更改之前发生。允许对所有数据更改进行最终验证或取消操作。

name GC.Spread.Report.ReportSheet#ReportSheetRecordsSubmitting

param GC.Spread.Report.ReportSheet sheet 触发事件的报表。

param string sheetName 报表的名称。

param boolean cancel 是否应取消报表提交操作。

example

//此示例使用 ReportSheetDataChanged 事件。
const report = spread.addSheetTab(0, "Report", GC.Spread.Sheets.SheetType.reportSheet);
report.renderMode("Design");
const templateSheet = report.getTemplate();
templateSheet.setTemplateCell(0, 0, {
   binding: "Orders[orderId]",
   type: "Group",
});
templateSheet.setTemplateCell(0, 1, {
   binding: "Orders[customerId]",
   type: "Group",
});
templateSheet.setDataEntrySetting([ {
   name: "Write Back Rule 1",
   tableName: "Orders",
   fields: [
       { dbColumnName: "orderId", formula: "A1", isPrimary: true },
       { dbColumnName: "customerId", formula: "B1" },
   ],
   includeUnmodified: false,
   skipRecordWithEmptyValue: false
} ]);
report.renderMode("Preview");
report.bind(GC.Spread.Sheets.Events.ReportSheetRecordsSubmitting, (event, args) => {
    let reportsheet = args.sheet, changes = reportsheet.getChanges();
    if (isInvalidate(changes)) {
        args.cancel = true;
    }
});
// 提交报表更改后，用户可以验证更改并取消此提交。

RowChanged

• Static RowChanged: string

当对工作表中的行或行范围进行更改且可能需要重新绘制该行或行范围时发生。

name GC.Spread.Sheets.Worksheet#RowChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 行索引。

param GC.Spread.Sheets.SheetArea sheetArea 行所在的工作表区域。

param string propertyName 已更改的行属性名称。

param boolean isUndo 此事件是否来自撤销操作。

example

//此示例使用 RowChanged 事件。
activeSheet.bind(GC.Spread.Sheets.Events.RowChanged, function (e, info) {
        alert("行 (" + info.row + ")");
});

RowChanging

• Static RowChanging: string

在对工作表中的行或行范围进行更改且可能需要重新绘制该行或行范围之前发生。

name GC.Spread.Sheets.Worksheet#RowChanging

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 行索引。

param GC.Spread.Sheets.SheetArea sheetArea 行所在的工作表区域。

param string propertyName 已更改的行属性名称。

example

//此示例使用 RowChanging 事件。
activeSheet.bind(GC.Spread.Sheets.Events.RowChanging, function (e, info) {
        alert("行 (" + info.row + ")");
});

RowHeightChanged

• Static RowHeightChanged: string

当行高发生变化时发生。

name GC.Spread.Sheets.Worksheet#RowHeightChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param Array rowList 高度已更改的行列表。

param boolean header 这些列是否为列标题列。

example

//此示例使用 RowHeightChanged 事件。
activeSheet.bind(GC.Spread.Sheets.Events.RowHeightChanged, function (e, info) {
        alert("行列表 (" + info.rowList + ")");
});

RowHeightChanging

• Static RowHeightChanging: string

当行高正在改变时发生。

name GC.Spread.Sheets.Worksheet#RowHeightChanging

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param Array rowList 高度正在改变的行列表。

param boolean header 这些列是否为列标题列。

param boolean cancel 指示是否应取消操作的值。

example

//此示例使用 RowHeightChanging 事件。
activeSheet.bind(GC.Spread.Sheets.Events.RowHeightChanging, function (e, info) {
        alert("行列表 (" + info.rowList + ")");
});

RowOperation

• Static RowOperation: string

当应用的行操作被执行时发生。

name GC.Spread.Sheets.TableSheet.TableSheet#RowOperation

param GC.Spread.Sheets.TableSheet.TableSheet sheet 触发事件的计算表。

param string sheetName 计算表的名称。

param GC.Spread.Sheets.TableSheet.ActionType actionType 行操作类型。

param number row 行索引。

example

//此示例使用 RowOperation 事件。
workbook.bind(GC.Spread.Sheets.Events.RowOperation, function (e, info) {
    console.log(info.sheetName, info.actionType, info.row);
});

SelectionChanged

• Static SelectionChanged: string

当工作表中的单元格选择已更改时发生。

name GC.Spread.Sheets.Worksheet#SelectionChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param {@link GC.Spread.Sheets.Range[]} oldSelections 旧的选择范围。

param {@link GC.Spread.Sheets.Range[]} newSelections 新的选择范围。

example

//此示例使用 SelectionChanged 事件。
activeSheet.bind(GC.Spread.Sheets.Events.SelectionChanged, function (e, info) {
        alert("名称 (" + info.sheetName + ")");
});

SelectionChanging

• Static SelectionChanging: string

当工作表中的单元格选择正在改变时发生。

name GC.Spread.Sheets.Worksheet#SelectionChanging

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param {@link GC.Spread.Sheets.Range[]} oldSelections 旧的选择范围。

param {@link GC.Spread.Sheets.Range[]} newSelections 新的选择范围。

example

//此示例使用 SelectionChanging 事件。
activeSheet.bind(GC.Spread.Sheets.Events.SelectionChanging, function (e, info) {
//使用 IE 查看控制台
        console.log("名称 (" + info.sheetName + ")");
});

ShapeChanged

• Static ShapeChanged: string

当任何形状发生变化时发生。

name GC.Spread.Sheets.Worksheet#ShapeChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Shapes.Shape shape 触发事件的形状。

param string propertyName 已更改的形状属性名称。

example

//此示例使用 ShapeChanged 事件。
var shape1 = activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 20, 20, 200, 200);
activeSheet.bind(GC.Spread.Sheets.Events.ShapeChanged, function (e, info) {
       alert("changed");
});

ShapeRemoved

• Static ShapeRemoved: string

当用户已移除形状时发生。

name GC.Spread.Sheets.Worksheet#ShapeRemoved

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Shapes.Shape shape 已被移除的形状。

example

//此示例使用 ShapeRemoved 事件。
var shape = activeSheet.shapes.add("myShape", GC.Spread.Sheets.Shapes.AutoShapeType.diamond, 0, 90, 200, 200);
activeSheet.bind(GC.Spread.Sheets.Events.ShapeRemoved, function (e, info) {
        alert(info.shape.name());
});

ShapeRemoving

• Static ShapeRemoving: string

当用户正在移除任何形状时发生。

name GC.Spread.Sheets.Worksheet#ShapeRemoving

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Shapes.Shape shape 正在被移除的形状。

param boolean cancel 指示是否应取消操作的值。

example

//此示例使用 ShapeRemoving 事件。
var shape = sheet.shapes.add("myShape", GC.Spread.Sheets.Shapes.AutoShapeType.diamond, 0, 90, 200, 200);
activeSheet.bind(GC.Spread.Sheets.Events.ShapeRemoving, function (e, info) {
        info.cancel = true;// 形状将不会被移除
});

ShapeSelectionChanged

• Static ShapeSelectionChanged: string

当形状的选择发生变化时发生。

name GC.Spread.Sheets.Worksheet#ShapeSelectionChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Shapes.Shape shape 触发事件的形状。

example

//此示例使用 ShapeSelectionChanged 事件。
var shape = sheet.shapes.add("myShape", GC.Spread.Sheets.Shapes.AutoShapeType.diamond, 0, 90, 200, 200);
activeSheet.bind(GC.Spread.Sheets.Events.ShapeSelectionChanged, function (e, info) {
       console.log("event info: " + info);
});

SheetChanged

• Static SheetChanged: string

工作表更改后。

name GC.Spread.Sheets.Worksheet#SheetChanged

param string sheetName 工作表的名称。

param string propertyName 特定操作名称。

param number sheetIndex 工作表索引，与 Worksheet 集合或 SheetTab 集合相关。

param number sheetPosition 工作表位置，与包含所有 Worksheet 和 SheetTab 的组合集合相关。

param boolean oldValue 工作表更改的前一个属性值(isVisible, isSelected...)。

param boolean newValue 工作表更改的属性值(isVisible, isSelected...)。

example

//此示例。
spread.bind(GC.Spread.Sheets.Events.SheetChanged, function (sender, args) {
    var sheet = args.sheet;
});

SheetChanging

• Static SheetChanging: string

Before sheet changed.

name GC.Spread.Sheets.Worksheet#SheetChanging

param string sheetName The sheet's name.

param string propertyName The specific operation name .

param number sheetIndex The sheet index, related to the Worksheet collection or SheetTab collection.

param number sheetPosition The sheet position, related to the combined collection which contains all Worksheet and SheetTab.

param boolean oldValue Sheet changes the value of the previous attribute(isVisible, isSelected...).

param boolean newValue Sheet changes the value of the attribute(isVisible, isSelected...).

param boolean cancel Cancel the current operation.

example

//This example.
spread.bind(GC.Spread.Sheets.Events.SheetChanging, function (sender, args) {
    var sheetIndex = args.sheetIndex;
    args.cancel = true;
});

SheetMoved

• Static SheetMoved: string

用户拖动并移动工作表后发生。

name GC.Spread.Sheets.Worksheet#SheetMoved

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number oldIndex 工作表的前一个索引。

param number newIndex 工作表的新索引。

example

//此示例使用 SheetMoved 事件。
window.onload = function(){
     var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
     var activeSheet = spread.getActiveSheet();
     spread.bind(GC.Spread.Sheets.Events.SheetMoving, function (e, data) {
         alert(data.sheetName + '\n' +  'oldIndex: ' + data.oldIndex + '\n' +  'newIndex: ' + data.newIndex + '\n' +  'cancel: ' + data.cancel);
     });
     spread.bind(GC.Spread.Sheets.Events.SheetMoved, function (e, data) {
         alert(data.sheetName + '\n' +  'oldIndex: ' + data.oldIndex + '\n' +  'newIndex: ' + data.newIndex);
     });
}

SheetMoving

• Static SheetMoving: string

用户拖动并移动工作表前发生。

name GC.Spread.Sheets.Worksheet#SheetMoving

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number oldIndex 工作表的旧索引。

param number newIndex 表示将要移动到的索引值。

param boolean cancel 表示是否应该取消操作的值。

example

//此示例使用 SheetMoving 事件。
window.onload = function(){
     var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
     var activeSheet = spread.getActiveSheet();
     spread.bind(GC.Spread.Sheets.Events.SheetMoving, function (e, data) {
         alert(data.sheetName + '\n' +  'oldIndex: ' + data.oldIndex + '\n' +  'newIndex: ' + data.newIndex + '\n' +  'cancel: ' + data.cancel);
     });
     spread.bind(GC.Spread.Sheets.Events.SheetMoved, function (e, data) {
         alert(data.sheetName + '\n' +  'oldIndex: ' + data.oldIndex + '\n' +  'newIndex: ' + data.newIndex);
     });
}

SheetNameChanged

• Static SheetNameChanged: string

用户更改工作表名称后发生。

name GC.Spread.Sheets.Worksheet#SheetNameChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string oldValue 工作表的旧名称。

param string newValue 工作表的新名称。

example

//此示例使用 SheetNameChanged 事件。
// 使用网页浏览器查看控制台日志文本
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);
});

SheetNameChanging

• Static SheetNameChanging: string

用户正在更改工作表名称时发生。

name GC.Spread.Sheets.Worksheet#SheetNameChanging

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string oldValue 工作表的旧名称。

param string newValue 工作表的新名称。

param boolean cancel 表示是否应该取消操作的值。

example

//此示例使用 SheetNameChanging 事件。
// 使用网页浏览器查看控制台日志文本
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);
});

SheetTabClick

• Static SheetTabClick: string

用户点击工作表标签时发生。

name GC.Spread.Sheets.Worksheet#SheetTabClick

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number sheetTabIndex 用户点击的工作表标签的索引。

example

//此示例使用 SheetTabClick 事件。
spread.bind(GC.Spread.Sheets.Events.SheetTabClick, function (e, info) {
        alert("Index (" + info.sheetTabIndex + ")");
});

SheetTabDoubleClick

• Static SheetTabDoubleClick: string

用户双击工作表标签时发生。

name GC.Spread.Sheets.Worksheet#SheetTabDoubleClick

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number sheetTabIndex 用户双击的工作表标签的索引。

example

//此示例使用 SheetTabDoubleClick 事件。
spread.bind(GC.Spread.Sheets.Events.SheetTabDoubleClick, function (e, info) {
        alert("Index (" + info.sheetTabIndex + ")");
});

SlicerChanged

• Static SlicerChanged: string

当任何切片器发生变化时发生。

name GC.Spread.Sheets.Worksheet#SlicerChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Slicers.ISlicer slicer 触发事件的切片器。

param string propertyName 已更改的切片器属性的名称。

example

//此示例使用 SlicerChanged 事件。
//创建表格
datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
//向工作表添加切片器并返回切片器实例。
var slicer = activeSheet.slicers.add("slicer1",table.name(),"Name");
//更改切片器属性。
slicer.width(200);
slicer.height(200);
slicer.position(new GC.Spread.Sheets.Point(100, 200));
slicer.style(GC.Spread.Sheets.Slicers.SlicerStyles.dark4());
// 使用网页浏览器查看控制台日志文本
activeSheet.bind(GC.Spread.Sheets.Events.SlicerChanged, function (e, info) {
console.log("name: " + info.propertyName);
});

SparklineChanged

• Static SparklineChanged: string

当迷你图发生变化时发生。

name GC.Spread.Sheets.Worksheet#SparklineChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Sparklines.Sparkline sparkline 属性已更改的迷你图。

example

//删除迷你图会导致变化。
var data = new GC.Spread.Sheets.Range(1, 0, 8, 1);
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();
setting.options.showMarkers = true;
setting.options.lineWeight = 3;
setting.options.displayXAxis = true;
setting.options.showFirst = true;
setting.options.showLast = true;
setting.options.showLow = true;
setting.options.showHigh = true;
setting.options.showNegative = true;
setting.options.seriesColor = "Text 2 1";
setting.options.firstMarkerColor = "Text 2 3";
setting.options.negativeColor = "Accent 2 1";
setting.options.markersColor = "Accent 3 1";
setting.options.lowMarkerColor = "Accent 4 1";
setting.options.highMarkerColor = "Accent 6 1";
setting.options.lastMarkerColor = "Accent 6 6";
setting.options.axisColor = "Text 1 1";
activeSheet.addSpan(13, 0, 4, 3, null);
activeSheet.setSparkline(13, 0, data, GC.Spread.Sheets.Sparklines.DataOrientation.vertical, GC.Spread.Sheets.Sparklines.SparklineType.line, setting);
activeSheet.setValue(1, 0, 1);
activeSheet.setValue(2, 0, -2);
activeSheet.setValue(3, 0, -1);
activeSheet.setValue(4, 0, 6);
activeSheet.setValue(5, 0, 4);
activeSheet.setValue(6, 0, -4);
activeSheet.setValue(7, 0, 3);
activeSheet.setValue(8, 0, 8);
// 使用网页浏览器查看控制台日志文本
activeSheet.bind(GC.Spread.Sheets.Events.SparklineChanged, function (e, info) {
     console.log("name: " + info.sheetName);
});
$("#button1").click(function () {
     activeSheet.removeSparkline(13, 0);
});

TableColumnsChanged

• Static TableColumnsChanged: string

当用户在表格中插入/删除列时发生。

name GC.Spread.Sheets.Worksheet#TableColumnsChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param GC.Spread.Sheets.Tables.Table table 插入/删除行的表格。

param string propertyName 触发事件的操作名称。

param number col 基于表格索引的起始列索引。

param number count 要插入/删除的列数。

param boolean isAfter 是否在指定列索引之后插入列。默认为false，表示在之前插入。

example

//此示例使用 TableColumnsChanged 事件。
window.onload = function(){
     var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
     var activeSheet = spread.getActiveSheet();
     spread.bind(GC.Spread.Sheets.Events.TableColumnsChanged, function (e, data) {});
}

TableFilterCleared

• Static TableFilterCleared: string

当表格列刚刚清除筛选时发生。

name GC.Spread.Sheets.Worksheet#TableFilterCleared

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Tables.Table table 要自动筛选的表格列。

param number tableCol 刚刚清除筛选的表格列索引。

example

//此示例使用 TableFilterCleared 事件。
activeSheet.tables.add("Table1", 0, 0, 3, 3, GC.Spread.Sheets.Tables.TableThemes.dark1);
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
activeSheet.bind(GC.Spread.Sheets.Events.TableFilterCleared, function (e, info) {
       alert("Sheet (" + info.sheetName + ")");
});

TableFilterClearing

• Static TableFilterClearing: string

当表格列即将自动清除筛选时发生。

name GC.Spread.Sheets.Worksheet#TableFilterCleared

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Tables.Table table 要自动筛选的表格列。

param number tableCol 即将自动清除筛选的表格列索引。

example

//此示例使用 TableFilterClearing 事件。
activeSheet.tables.add("Table1", 0, 0, 3, 3, GC.Spread.Sheets.Tables.TableThemes.dark1);
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
activeSheet.bind(GC.Spread.Sheets.Events.TableFilterClearing, function (e, info) {
       alert("Sheet (" + info.sheetName + ")");
});

TableFiltered

• Static TableFiltered: string

当表格列刚刚自动筛选时发生。

name GC.Spread.Sheets.Worksheet#TableFiltered

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Tables.Table table 要自动筛选的表格列。

param number col 要自动筛选的表格列索引。

param Array filterValues 用于筛选列的值。

param Object conditionInfo 用于筛选列的条件规则信息。

example

//此示例使用 TableFiltered 事件。
activeSheet.tables.add("Table1", 0, 0, 3, 3, GC.Spread.Sheets.Tables.TableThemes.dark1);
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
activeSheet.bind(GC.Spread.Sheets.Events.TableFiltered, function (e, info) {
       alert("Sheet (" + info.sheetName + ")");
});

TableFiltering

• Static TableFiltering: string

当表格列即将自动筛选时发生。

name GC.Spread.Sheets.Worksheet#TableFiltering

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param GC.Spread.Sheets.Tables.Table table 要自动筛选的表格列。

param number col 要自动筛选的表格列索引。

param Array filterValues 用于筛选列的值。

param Object conditionInfo 用于筛选列的条件规则信息。

example

//此示例使用 TableFiltering 事件。
activeSheet.tables.add("Table1", 0, 0, 3, 3, GC.Spread.Sheets.Tables.TableThemes.dark1);
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
activeSheet.bind(GC.Spread.Sheets.Events.TableFiltering, function (e, info) {
       alert("Sheet (" + info.sheetName + ")");
});

TableResized

• Static TableResized: string

用户调整表格大小后发生。

name GC.Spread.Sheets.Worksheet#TableResized

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param GC.Spread.Sheets.Tables.Table table 被调整大小的表格。

param GC.Spread.Sheets.Range oldRange 调整前的表格范围。

param GC.Spread.Sheets.Range newRange 调整后的表格范围。

TableResizing

• Static TableResizing: string

用户通过调整手柄调整表格大小时发生。

name GC.Spread.Sheets.Worksheet#TableResizing

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param GC.Spread.Sheets.Tables.Table table 正在调整大小的表格。

param GC.Spread.Sheets.Range oldRange 调整前的表格范围。

param GC.Spread.Sheets.Range newRange 调整后的表格范围。

param boolean cancel 是否取消当前调整行为。默认值为 false。

example

//此示例使用 TableResizing 和 TableResized 事件。
window.onload = function(){
     var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
     var activeSheet = spread.getActiveSheet();
     spread.bind(GC.Spread.Sheets.Events.TableResizing, function (e, data) {
         if (data.newRange.rowCount > 10) {
             args.cancel = true;
         }
     });
     spread.bind(GC.Spread.Sheets.Events.TableResizing, function (e, data) {});
     spread.bind(GC.Spread.Sheets.Events.TableResized, function (e, data) {});
}

TableRowsChanged

• Static TableRowsChanged: string

用户在表格中插入/删除行时发生。

name GC.Spread.Sheets.Worksheet#TableRowsChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param GC.Spread.Sheets.Tables.Table table 插入/删除行的表格。

param string propertyName 触发事件的操作名称。

param number row 基于表格索引的起始行索引。

param number count 要插入/删除的行数。

param boolean isAfter 是否在指定行索引之后插入行。默认为 false，表示在之前插入。

param Object[] deletedItem 绑定中删除的行集合。数组中的每个项指定已删除的数据项。

example

//此示例使用 TableRowsChanged 事件。
window.onload = function(){
     var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
     var activeSheet = spread.getActiveSheet();
     spread.bind(GC.Spread.Sheets.Events.TableRowsChanged, function (e, data) {});
}

TopRowChanged

• Static TopRowChanged: string

当顶部行发生变化时发生。

name GC.Spread.Sheets.Worksheet#TopRowChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number oldTopRow 旧的顶部行索引。

param number newTopRow 新的顶部行索引。

param number oldOffset 旧的顶部行偏移量。

param number newOffset 新的顶部行偏移量。

example

//此示例同步工作表1和工作表2的垂直和水平滚动。
var sheet1 = spread.getSheet(0),
sheet2 = spread.getSheet(1);
sheet1.bind(GC.Spread.Sheets.Events.TopRowChanged, function (sender, args) {
    //将工作表1的显示顶部行设置到工作表2（垂直滚动同步）。
    sheet2.showRow(args.newTopRow, GC.Spread.Sheets.VerticalPosition.top);
});
sheet1.bind(GC.Spread.Sheets.Events.LeftColumnChanged, function (sender, args) {
    //将工作表1的显示左列设置到工作表2（水平滚动同步）。
    sheet2.showColumn(args.newLeftCol, GC.Spread.Sheets.HorizontalPosition.left);
});

TouchToolStripOpening

• Static TouchToolStripOpening: string

在触摸工具栏弹出之前发生。

name GC.Spread.Sheets.Worksheet#TouchToolStripOpening

param number x 水平位置的x坐标。

param number y 垂直位置的y坐标。

param boolean handled 如果为true，则阻止触摸工具栏弹出；否则，工具栏将显示在默认位置。

example

//此示例使用TouchToolStripOpening事件。
 activeSheet.bind(GC.Spread.Sheets.Events.TouchToolStripOpening, function (e, info) {
        alert(info.x);
});

UserFormulaEntered

• Static UserFormulaEntered: string

当用户输入公式时发生。

name GC.Spread.Sheets.Worksheet#UserFormulaEntered

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 用户输入公式的单元格的行索引。

param number col 用户输入公式的单元格的列索引。

param string formula 用户输入的公式。

param boolean isCircularReference 输入的公式是否为循环引用。

example

//此示例使用UserFormulaEntered事件。
 activeSheet.bind(GC.Spread.Sheets.Events.UserFormulaEntered, function (e, info) {
        alert("Formula (" + info.formula + ")");
});

ValidationError

• Static ValidationError: string

当应用的单元格值无效时发生。

name GC.Spread.Sheets.Worksheet#ValidationError

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 单元格的行索引。

param number col 单元格的列索引。

param Object editingValue 单元格的编辑值。

param GC.Spread.Sheets.DataValidation.DefaultDataValidator validator 导致错误的数据验证器。

param GC.Spread.Sheets.DataValidation.DataValidationResult validationResult 用户可以设置的处理错误的策略。

example

//此示例使用ValidationError事件。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.cellValueCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.equalsTo);
nCondition.expected(0);
//当选项为false时，验证失败并显示红色警告。
//当选项为true时，空白单元格被视为零且验证成功。
nCondition.treatNullValueAsZero(false);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition)
validator.ignoreBlank(false);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.wholeNumber)
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, null);
//在单元格(0,0)中输入不同的值。如果用户输入无效值，此事件将触发。
activeSheet.bind("ValidationError", vError);
function vError(sender, args) {
    alert("error");
}

ValueChanged

• Static ValueChanged: string

当子编辑器中的值发生变化时发生。

name GC.Spread.Sheets.Worksheet#ValueChanged

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number row 单元格的行索引。

param number col 单元格的列索引。

param Object oldValue 单元格的旧值。

param Object newValue 单元格的新值。

example

//此示例使用ValueChanged事件。
activeSheet.bind(GC.Spread.Sheets.Events.ValueChanged, function (e, info) {
        alert("Value (" + info.newValue + ")");
});

ViewZoomed

• Static ViewZoomed: string

用户缩放后发生。

name GC.Spread.Sheets.Worksheet#ViewZoomed

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number newZoomFactor 新的缩放因子。

param number oldZoomFactor 旧的缩放因子。

example

//此示例使用 ViewZoomed 事件。
spread.options.allowUserZoom = true;
activeSheet.bind(GC.Spread.Sheets.Events.ViewZoomed, function (e, info) {
     alert("Zoom (" + info.newZoomFactor + ")");
});

ViewZooming

• Static ViewZooming: string

用户缩放时发生。

name GC.Spread.Sheets.Worksheet#ViewZooming

param GC.Spread.Sheets.Worksheet sheet 触发事件的工作表。

param string sheetName 工作表的名称。

param number newZoomFactor 新的缩放因子，用户可以修改此值来干预实际的缩放操作。

param number oldZoomFactor 旧的缩放因子。

param boolean cancel 表示是否应该取消操作的值。

example

//此示例使用 ViewZooming 事件来限制最大缩放因子。
spread.options.allowUserZoom = true;
activeSheet.bind(GC.Spread.Sheets.Events.ViewZooming, function (e, info) {
     if (info.newZoomFactor >= 2) {
         info.newZoomFactor = 2;
     }
});

GC.Spread.Sheets.Events

Class: Events

Table of contents

Constructors

Events

Constructors

constructor

Events

ActiveSheetChanged

ActiveSheetChanging

BeforePrint

ButtonClicked

CalculationProgress

CellChanged

CellClick

CellDoubleClick

ClipboardChanged

ClipboardChanging

ClipboardPasted

ClipboardPasting

CollaborationEndRedo

CollaborationEndUndo

CollaborationStartRedo

CollaborationStartUndo

ColumnChanged

ColumnChanging

ColumnWidthChanged

ColumnWidthChanging

CommentChanged

CommentRemoved

CommentRemoving

DataFetchCompleted

DragDropBlock

DragDropBlockCompleted

DragFillBlock

DragFillBlockCompleted

DragMerged

DragMerging

EditChange

EditEnded

EditEnding

EditStarting

EditorStatusChanged

EnterCell

FloatingObjectChanged

FloatingObjectLoaded

FloatingObjectRemoved

FloatingObjectRemoving

FloatingObjectSelectionChanged

FormControlButtonClicked

FormControlValueChanged

InvalidOperation

LeaveCell

LeftColumnChanged

OutlineColumnCheckStatusChanged

PictureChanged

PictureSelectionChanged

PivotTableChanged

RangeChanged

RangeFilterCleared

RangeFilterClearing

RangeFiltered

RangeFiltering

RangeGroupStateChanged

RangeGroupStateChanging

RangeSorted

RangeSorting

ReportSheetDataChanged

ReportSheetDataChanging

ReportSheetRecordsSubmitted

ReportSheetRecordsSubmitting

RowChanged

RowChanging

RowHeightChanged

RowHeightChanging

RowOperation

SelectionChanged

SelectionChanging

ShapeChanged

ShapeRemoved