GC.Spread.Sheets.Events

クラス: Events

Spread.Sheets.Events

コンストラクタ

constructor

Events

コンストラクタ

constructor

• new Events()

SpreadJSでサポートされているイベントを定義します。

Events

ActiveSheetChanged

• 静的 ActiveSheetChanged: string

ユーザーがアクティブシートを変更したときに発生します。

名前 GC.Spread.Sheets.Workbook#ActiveSheetChanged

パラメータ GC.Spread.Sheets.Worksheet oldSheet 古いシート。

パラメータ GC.Spread.Sheets.Worksheet newSheet 新しいシート。

実例

// 次のサンプルコードは、ActiveSheetChangedイベントのログテキストを作成します。
// IEを使用してログテキストをコンソールに表示します。
spread.bind(GC.Spread.Sheets.Events.ActiveSheetChanged, function (sender, args) {
    console.log("Active sheet has been switched.");
});

ActiveSheetChanging

• 静的 ActiveSheetChanging: string

ユーザーがアクティブなシートを変更するときに発生します。

名前 GC.Spread.Sheets.Workbook#ActiveSheetChanging

パラメータ GC.Spread.Sheets.Worksheet oldSheet 古いシート。

パラメータ GC.Spread.Sheets.Worksheet newSheet 新しいシート。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

実例

// 次のサンプルコードは、アクティブシートが変更されないようにします。
spread.bind(GC.Spread.Sheets.Events.ActiveSheetChanging, function (sender, args) {
    // シートの切り替えをキャンセルします。
    args.cancel = true;
});

BeforePrint

• 静的 BeforePrint: string

印刷の前に発生します。

名前 GC.Spread.Sheets.WorkBook.BeforePrint

パラメータ Object iframe 印刷用の Dom。

パラメータ boolean cancel 印刷をキャンセルするかどうか。

実例

// 次のサンプルコードは、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

• 静的 ButtonClicked: string

ユーザーがセルのボタン、コンボボックス、ハイパーリンクのいずれかをクリックするときに発生します。

名前 GC.Spread.Sheets.Workbook#ButtonClicked

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row セルの行インデックス。

パラメータ number col セルの列インデックス。

パラメータ GC.Spread.Sheets.SheetArea sheetArea セルを含むシート領域。

実例

// 次のサンプルコードは、ボタン型セルを作成します。
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");
    }
});

CellChanged

• 静的 CellChanged: string

このシートのセルに、そのセルの再描画が必要となるような変更が加えられたときに発生します。

名前 GC.Spread.Sheets.Worksheet#CellChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row セルの行インデックス。

パラメータ number col セルの列インデックス。

パラメータ GC.Spread.Sheets.SheetArea sheetArea セルのシート領域。

パラメータ string propertyName 変更されたセルのプロパティの名前。

パラメータ boolean isUndo このイベントが「元に戻す」操作から発生しましたかどうか。

実例

// 次のサンプルコードは、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

• 静的 CellClick: string

ユーザーがセルの上でマウス左ボタンを押したときに発生します。

名前 GC.Spread.Sheets.Worksheet#CellClick

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.SheetArea sheetArea クリックされたセルが存在するシート領域。

パラメータ number row クリックされたセルの行インデックス。

パラメータ number col クリックされたセルの列インデックス。

実例

// 次のサンプルコードは、CellClickイベントを使用します。
// IEを使用してログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.CellClick, function (sender, args) {
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
        console.log("The column header was clicked.");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
        console.log("The row header was clicked.");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
        console.log("The corner header was clicked.");
    }
    console.log("Clicked column index: " + args.col);
    console.log("Clicked row index: " + args.row);
});
// 連結
activeSheet.bind(GC.Spread.Sheets.Events.CellDoubleClick, function (sender, args) {
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
        console.log("The column header was double clicked.");
   }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
        console.log("The row header was double clicked.");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
        console.log("The corner header was double clicked.");
    }
    console.log("Double clicked column index: " + args.col);
    console.log("Double clicked row index: " + args.row);
})

CellDoubleClick

• 静的 CellDoubleClick: string

ユーザーがセルの上でマウス左ボタンを2回押したとき（ダブルクリックしたとき）に発生します。

名前 GC.Spread.Sheets.Worksheet#CellDoubleClick

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.SheetArea sheetArea クリックされたセルが存在するシート領域。

パラメータ number row クリックされたセルの行インデックス。

パラメータ number col クリックされたセルの列インデックス。

実例

// 次のサンプルコードは、CellDoubleClickイベントを使用します。
// IEを使用してログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.CellClick, function (sender, args) {
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
        console.log("The column header was clicked.");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
        console.log("The row header was clicked.");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
        console.log("The corner header was clicked.");
    }
    console.log("Clicked column index: " + args.col);
    console.log("Clicked row index: " + args.row);
});
// 連結
activeSheet.bind(GC.Spread.Sheets.Events.CellDoubleClick, function (sender, args) {
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
        console.log("The column header was double clicked.");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
        console.log("The row header was double clicked.");
    }
    if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
        console.log("The corner header was double clicked.");
    }
    console.log("Double clicked column index: " + args.col);
    console.log("Double clicked row index: " + args.row);
});

ClipboardChanged

• 静的 ClipboardChanged: string

Spread.Sheetsに影響を与えるクリップボードの変更が起こったときに発生します。

名前 GC.Spread.Sheets.Worksheet#ClipboardChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ Object copyData クリップボードに設定されたSpread.Sheetsのデータ。

パラメータ string copyData.text クリップボードのテキスト文字列。

パラメータ string copyData.html クリップボードのhtml文字列。

パラメータ Array objects コピーされたフローティングオブジェクト。ピクチャ、カスタムフローティングオブジェクト、スライサー、チャート、シェイプが含まれています。

実例

// 次のサンプルコードは、ClipboardChangedイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.ClipboardChanged, function (sender, args) {
    console.log("ClipboardChanged.", args);
});

ClipboardChanging

• 静的 ClipboardChanging: string

Spread.Sheetsのアクションによってクリップボードが変更されるときに発生します。

名前 GC.Spread.Sheets.Worksheet#ClipboardChanging

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ Object copyData クリップボードに設定するSpread.Sheetsのデータ。

パラメータ string copyData.text クリップボードのテキスト文字列。

パラメータ string copyData.html クリップボードのhtml文字列。

パラメータ Array.<GC.Spread.Sheets.Range> ranges 現在の切り取るまたはコピー操作のソースシートのソース範囲。

パラメータ {@link GC.Spread.Sheet.ClipboardActionType} action 現在のアクションのタイプを示します。

パラメータ Array objects コピー中のフローティングオブジェクト。ピクチャ、カスタムフローティングオブジェクト、スライサー、チャート、シェイプが含まれています。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

実例

// 次のサンプルコードは、ClipboardChangingイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.ClipboardChanging, function (sender, args) {
    console.log("ClipboardChanging", args);
});

ClipboardPasted

• 静的 ClipboardPasted: string

ユーザーがクリップボードから貼り付けたときに発生します。

名前 GC.Spread.Sheets.Worksheet#ClipboardPasted

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Range cellRange 貼り付けられた範囲。

パラメータ GC.Spread.Sheets.ClipboardPasteOptions pasteOption クリップボードからどのデータ（値、書式、数式）が貼り付けられるかを示す貼り付けオプション。

パラメータ Object pasteData Spread.Sheetsに貼り付けられるクリップボードのデータ。

パラメータ string pasteData.text クリップボードのテキスト文字列。

パラメータ string pasteData.html クリップボードのhtml文字列。

パラメータ string pasteData.image クリップボードの画像src文字列。

パラメータ GC.Spread.Sheets.Worksheet fromSheet データ範囲の元シート。

パラメータ GC.Spread.Sheets.Range [fromRange] 範囲をコピーまたは切り取るときの貼り付けのソース範囲。

パラメータ {@link GC.Spread.Sheet.ClipboardActionType} action 現在のアクションのタイプを示します。

パラメータ Array objects 貼り付けたフローティングオブジェクト。画像、カスタムフローティングオブジェクト、スライサー、チャート、シェイプが含まれています。

パラメータ GC.Spread.Sheets.InsertShiftCell [shiftCells] セルの移動オプション。セルを移動しない場合、undefinedになります。

実例

// 次のサンプルコードは、ClipboardPastedイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.ClipboardPasted, function (sender, args) {
    console.log("ClipboardPasted", args);
});

ClipboardPasting

• 静的 ClipboardPasting: string

ユーザーがクリップボードから貼り付けるときに発生します。

名前 GC.Spread.Sheets.Worksheet#ClipboardPasting

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Range cellRange 貼り付ける範囲。

パラメータ Object pasteData Spread.Sheetsに貼り付けられるクリップボードのデータ。

パラメータ string pasteData.text クリップボードのテキスト文字列。

パラメータ string pasteData.html クリップボードのhtml文字列。

パラメータ string pasteData.image クリップボードの画像src文字列。

パラメータ GC.Spread.Sheets.Worksheet fromSheet データ範囲の元シート。

パラメータ GC.Spread.Sheets.Range [fromRange] 範囲をコピーまたは切り取るときの貼り付けのソース範囲。

パラメータ {@link GC.Spread.Sheet.ClipboardActionType} action 現在のアクションのタイプを示します。

パラメータ Array objects 貼り付け中のフローティングオブジェクト。画像、カスタムフローティングオブジェクト、スライサー、チャート、シェイプが含まれています。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

パラメータ GC.Spread.Sheets.InsertShiftCell [shiftCells] セルの移動オプション。セルを移動しない場合、undefinedになります。

実例

// 次のサンプルコードは、ClipboardPastingイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.ClipboardPasting, function (sender, args) {
    console.log("ClipboardPasting", args);
});

ColumnChanged

• 静的 ColumnChanged: string

このシートの列または列範囲に、その列または列範囲の再描画が必要となるような変更が加えられたときに発生します。

名前 GC.Spread.Sheets.Worksheet#ColumnChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number col 列インデックス。

パラメータ GC.Spread.Sheets.SheetArea sheetArea 列のシート領域。

パラメータ string propertyName 変更された列のプロパティの名前。

パラメータ boolean isUndo このイベントが「元に戻す」操作から発生しましたかどうか。

実例

// 次のサンプルコードは、ColumnChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnChanged, function (e, info) {
    if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
        alert("Index (" + info.col + ")");
    }
});

ColumnChanging

• 静的 ColumnChanging: string

このシートの列または列範囲を変更する前にに、その列または列範囲の再描画が必要となるような変更が加えられたときに発生します。

名前 GC.Spread.Sheets.Worksheet#ColumnChanging

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number col 列インデックス。

パラメータ GC.Spread.Sheets.SheetArea sheetArea 列のシート領域。

パラメータ string propertyName 変更された列のプロパティの名前。

実例

// 次のサンプルコードは、ColumnChangingイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnChanging, function (e, info) {
    if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
        alert("Index (" + info.col + ")");
    }
});

ColumnWidthChanged

• 静的 ColumnWidthChanged: string

列の幅が変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#ColumnWidthChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ Array colList 幅が変更された列の配列リストを取得します。

パラメータ boolean header 列が行ヘッダ列かどうか。

実例

// 次のサンプルコードは、ColumnWidthChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnWidthChanged, function (e, info) {
        alert("Column (" + info.colList + ")");
});

ColumnWidthChanging

• 静的 ColumnWidthChanging: string

列の幅が変更されるときに発生します。

名前 GC.Spread.Sheets.Worksheet#ColumnWidthChanging

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ Array colList 幅が変更される列のリスト。

パラメータ boolean header 列が行ヘッダ列かどうか。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

実例

// 次のサンプルコードは、ColumnWidthChangingイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnWidthChanging, function (e, info) {
        alert("Column (" + info.colList + ")");
});

CommentChanged

• 静的 CommentChanged: string

いずれかのコメントが変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#CommentChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Comments.Comment comment イベントを発生させたコメント。

パラメータ string propertyName 変更されたコメントのプロパティの名前。

実例

// 次のサンプルコードは、CommentChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.CommentChanged, function (e, info) {
    alert("changed");
});

CommentRemoved

• 静的 CommentRemoved: string

ユーザーがコメントを削除した後に発生します。

名前 GC.Spread.Sheets.Worksheet#CommentRemoved

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Comments.Comment comment 削除されたコメント。

実例

// 次のサンプルコードは、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

• 静的 CommentRemoving: string

ユーザーがいずれかのコメントを削除する前に発生します。

名前 GC.Spread.Sheets.Worksheet#CommentRemoving

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Comments.Comment comment 削除されるコメント。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

実例

//次のサンプルコードは、コメントが削除されないようにします。
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;
});

DragDropBlock

• 静的 DragDropBlock: string

ユーザーがセル範囲をドラッグ＆ドロップするときに発生します。

名前 GC.Spread.Sheets.Worksheet#DragDropBlock

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number fromRow ソース範囲（ドラッグされている範囲）の左上セルの行インデックス。

パラメータ number fromCol ソース範囲（ドラッグされている範囲）の左上セルの列インデックス。

パラメータ number toRow 宛先範囲（選択内容がドロップされる範囲）の左上セルの行インデックス。

パラメータ number toCol 宛先範囲（選択内容がドロップされる範囲）の左上セルの列インデックス。

パラメータ number rowCount ドラッグされているセル範囲の行数。

パラメータ number colCount ドラッグされているセル範囲の列数。

パラメータ boolean copy ソース範囲をコピーするかどうか。

パラメータ boolean insert ソース範囲を挿入するかどうか。

パラメータ GC.Spread.Sheets.CopyToOptions copyOption ドラッグ＆ドロップ操作のCopyOption値。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

実例

// 次のサンプルコードは、DragDropBlockイベントのログテキストを作成します。
// IEを使用してログテキストをコンソールに表示します。
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

• 静的 DragDropBlockCompleted: string

ユーザーがセル範囲のドラッグ＆ドロップを完了したときに発生します。

名前 GC.Spread.Sheets.Worksheet#DragDropBlockCompleted

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number fromRow ソース範囲（ドラッグされている範囲）の左上セルの行インデックス。

パラメータ number fromCol ソース範囲（ドラッグされている範囲）の左上セルの列インデックス。

パラメータ number toRow 宛先範囲（選択内容がドロップされる範囲）の左上セルの行インデックス。

パラメータ number toCol 宛先範囲（選択内容がドロップされる範囲）の左上セルの列インデックス。

パラメータ number rowCount ドラッグされているセル範囲の行数。

パラメータ number colCount ドラッグされているセル範囲の列数。

パラメータ boolean copy ソース範囲をコピーするかどうか。

パラメータ boolean insert ソース範囲を挿入するかどうか。

パラメータ GC.Spread.Sheets.CopyToOptions copyOption ドラッグ＆ドロップ操作のCopyOption値。

実例

// 次のサンプルコードは、DragDropBlockCompletedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.DragDropBlockCompleted, function (e, args) {
        alert("From Column (" + args.fromCol + ")");
});

DragFillBlock

• 静的 DragFillBlock: string

ユーザーがセル範囲をドラッグフィルするときに発生します。

名前 GC.Spread.Sheets.Worksheet#DragFillBlock

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Range fillRange フィル操作に使用する範囲。

パラメータ GC.Spread.Sheets.Fill.AutoFillType autoFillType フィル操作に使用するAutoFillType値。

パラメータ GC.Spread.Sheets.Fill.FillDirection fillDirection フィルの方向。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

実例

// 次のサンプルコードは、DragFillBlockイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.DragFillBlock, function (e, info) {
        alert("Direction (" + info.fillDirection + ")");
});

DragFillBlockCompleted

• 静的 DragFillBlockCompleted: string

ユーザーがセル範囲のドラッグフィルを完了したときに発生します。

名前 GC.Spread.Sheets.Worksheet#DragFillBlockCompleted

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Range fillRange フィル操作に使用する範囲。

パラメータ GC.Spread.Sheets.Fill.AutoFillType autoFillType フィル操作に使用するAutoFillType値。

パラメータ GC.Spread.Sheets.Fill.FillDirection fillDirection フィルの方向。

実例

// 次のサンプルコードは、DragFillBlockCompletedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.DragFillBlockCompleted, function (e, info) {
        alert("Type (" + info.autoFillType + ")");
});

DragMerged

• 静的 DragMerged: string

ユーザーがセルをドラッグしてマージした後に発生します。

名前 GC.Spread.Sheets.Worksheet#DragMerged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Range mergeRange マージされる範囲。

実例

// 次のサンプルコードは、行インデックスを返します。
// マージするには［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

• 静的 DragMerging: string

ユーザーがセルをドラッグしてマージする前に発生します。

名前 GC.Spread.Sheets.Worksheet#DragMerging

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Range mergeRange マージされる範囲。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

実例

// 次のサンプルコードは、行インデックスを返します。
// マージするには［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

• 静的 EditChange: string

セルが編集モードのときにテキストが変更されると発生します。

名前 GC.Spread.Sheets.Worksheet#EditChange

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row セルの行インデックス。

パラメータ number col セルの列インデックス。

パラメータ Object editingText 現在のエディタの値。

実例

// 次のサンプルコードは、EditChangeイベントのログテキストを作成します。
// IEを使用してログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.EditChange, function (sender, args) {
    console.log("Cell (" + args.row + ", " + args.col + ") data has been changed.")
});

EditEnded

• 静的 EditEnded: string

セルが編集モードを終了したときに発生します。

名前 GC.Spread.Sheets.Worksheet#EditEnded

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row セルの行インデックス。

パラメータ number col セルの列インデックス。

パラメータ Object editingText 現在のエディタの値。

パラメータ boolean committed 値の変更がコミットされたかどうか。

実例

//次のサンプルコードは、EditStartingおよびEditEndedイベントのログテキストを作成します。
 // IEを使用してログテキストをコンソールに表示します。
var activeSheet = spread.getActiveSheet();
activeSheet.bind(GC.Spread.Sheets.Events.EditStarting, function (sender, args) {
    console.log("Start cell editing.");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnded, function (sender, args) {
    console.log("Finish cell editing.");
});

EditEnding

• 静的 EditEnding: string

セルが編集モードを終了するときに発生します。

名前 GC.Spread.Sheets.Worksheet#EditEnding

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row セルの行インデックス。

パラメータ number col セルの列インデックス。

パラメータ Object editor 現在のエディタ。

パラメータ Object editingText 現在のエディタの値。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

パラメータ boolean committed 値の変更がコミットされたかどうか。

実例

// 次のサンプルコードは、EditEndingイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.EditStarting, function (sender, args) {
    console.log("Start cell editing.");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnding, function (sender, args) {
    console.log("EditEnding event.");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnded, function (sender, args) {
    console.log("EditEnded event.");
});

EditStarting

• 静的 EditStarting: string

セルが編集モードに入るときに発生します。

名前 GC.Spread.Sheets.Worksheet#EditStarting

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row セルの行インデックス。

パラメータ number col セルの列インデックス。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

実例

//次のサンプルコードは、EditStartingおよびEditEndedイベントのログテキストを作成します。
// IEを使用してログテキストをコンソールに表示します。
var activeSheet = spread.getActiveSheet();
activeSheet.bind(GC.Spread.Sheets.Events.EditStarting, function (sender, args) {
    console.log("Start cell editing.");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnded, function (sender, args) {
    console.log("Finish cell editing.");
});

EditorStatusChanged

• 静的 EditorStatusChanged: string

エディタのステータスが変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#EditorStatusChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.EditorStatus oldStatus エディタの変更前のステータス。

パラメータ GC.Spread.Sheets.EditorStatus newStatus エディタの変更後のステータス。

実例

// 次のサンプルコードは、EditorStatusChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.EditorStatusChanged, function (e, info) {
        alert("Column (" + info.newStatus + ")");
});

EnterCell

• 静的 EnterCell: string

セルにフォーカスが入ると発生します。

名前 GC.Spread.Sheets.Worksheet#EnterCell

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row フォーカスが入るセルの行インデックス。

パラメータ number col フォーカスが入るセルの列インデックス。

実例

// 次のサンプルコードは、EnterCellイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.EnterCell, function (e, info) {
        alert("Cell (" + info.row + ", " + info.col +")");
});

FloatingObjectChanged

• 静的 FloatingObjectChanged: string

いずれかのフローティングオブジェクトが変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#FloatingObjectsChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject イベントを発生させたフローティングオブジェクト。

パラメータ string propertyName 変更されたフローティングオブジェクトのプロパティの名前。

実例

// 次のサンプルコードは、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("changed");
});

FloatingObjectLoaded

• 静的 FloatingObjectLoaded: string

カスタムフローティングオブジェクトの内容がロードされたときに発生します。

名前 GC.Spread.Sheets.Worksheet#FloatingObjectLoaded

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject イベントを発生させたカスタムフローティングオブジェクト。

パラメータ HTMLElement element カスタムフローティングオブジェクトのHTMLElement。

FloatingObjectRemoved

• 静的 FloatingObjectRemoved: string

ユーザーがフローティングオブジェクトを削除した後に発生します。

名前 GC.Spread.Sheets.Worksheet#FloatingObjectRemoved

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject 削除されたフローティングオブジェクト。

実例

// 次のサンプルコードは、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

• 静的 FloatingObjectRemoving: string

ユーザーがいずれかのフローティングオブジェクトを削除する前に発生します。

名前 GC.Spread.Sheets.Worksheet#FloatingObjectRemoving

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject 削除されるフローティングオブジェクト。

パラメータ boolean cancel 操作をキャンセルするかどうかを示す値。

実例

// 次のサンプルコードは、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

• 静的 FloatingObjectSelectionChanged: string

フローティングオブジェクトの選択が変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#FloatingObjectsSelectionChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject イベントを発生させたフローティングオブジェクト。

実例

// 次のサンプルコードは、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);
// IEを使用してログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.FloatingObjectSelectionChanged, function (e, info) {
       console.log("sheet name: " + info.sheetName);
});

FormControlButtonClicked

• 静的 FormControlButtonClicked: string

ボタンフォームコントロールがクリックされたときに発生します。

名前 GC.Spread.Sheets.Worksheet#FormControlButtonClicked

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Shapes.Shape shape イベントを発生させたシェイプ。

実例

// 次のサンプルコードは、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

• 静的 FormControlValueChanged: string

フォームコントロールの値が変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#FormControlValueChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.Shapes.Shape shape イベントを発生させたシェイプ。

パラメータ any newValue フォームコントロールの新しい値。

パラメータ any oldValue フォームコントロールの古い値。

実例

// 次のサンプルコードは、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

• 静的 InvalidOperation: string

無効な操作が実行されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#InvalidOperation

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.InvalidOperationType invalidType どの操作が無効であったかを示します。

パラメータ string message 無効な操作の説明。

パラメータ GC.Spread.Sheets.Range [fillRange] invalidTypeがdragFillの場合、範囲はフィル操作に使用されます。

実例

// 次のサンプルコードは、InvalidOperationイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.InvalidOperation, function (e, info) {
        alert("Message (" + info.message + ")");
});

LeaveCell

• 静的 LeaveCell: string

セルからフォーカスが離れると発生します。

名前 GC.Spread.Sheets.Worksheet#LeaveCell

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row フォーカスが離れるセルの行インデックス。

パラメータ number col フォーカスが離れるセルの列インデックス。

パラメータ boolean cancel 操作をキャンセルするかどうか。

実例

// 次のサンプルコードは、LeaveCellイベントのログテキストを作成します。
// IEを使用してログテキストをコンソールに表示します。
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

• 静的 LeftColumnChanged: string

左列が変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#LeftColumnChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number oldLeftCol 変更前の左列のインデックス。

パラメータ number newLeftCol 変更後の左列のインデックス。

実例

//次のサンプルコードは、シート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);
});

OutlineColumnCheckStatusChanged

• 静的 OutlineColumnCheckStatusChanged: string

アウトライン列のチェックステータスが変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#OutlineColumnCheckStatusChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row アウトライン列の変更行インデックス。

パラメータ number col アウトライン列の変更列インデックス。

パラメータ boolean status アウトライン列の変更ステータス。

実例

// スパークラインを削除すると、変更が発生します。
activeSheet.bind(GC.Spread.Sheets.Events.OutlineColumnCheckStatusChanged, function (e, info) {
     console.log("status: " + info.status);
});

PictureChanged

• 静的 PictureChanged: string

いずれかのピクチャが変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#PictureChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.FloatingObjects.Picture picture イベントを発生させたピクチャ。

パラメータ string propertyName 変更されたピクチャのプロパティの名前。

実例

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);
// IEを使用してログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.PictureChanged, function (e, info) {
console.log("Sheet: " + info.sheetName);
});

実例

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);
// IEを使用してログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.PictureChanged, function (e, info) {
console.log("Property: " + info.propertyName);
});

PictureSelectionChanged

• 静的 PictureSelectionChanged: string

ピクチャの選択が変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#PictureSelectionChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ GC.Spread.Sheets.FloatingObjects.Picture picture イベントを発生させたピクチャ。

実例

// 次のサンプルコードは、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);
// IEを使用してログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.PictureSelectionChanged, function (e, info) {
console.log("Sheet: " + info.sheetName);
});

PivotTableChanged

• 静的 PivotTableChanged: string

ピボットテーブルのフィルター/並べ替え/折りたたみ/フィールドが変更された後に発生します。

名前 GC.Spread.Sheets.Worksheet#PivotTableChanged

パラメータ string pivotTableName PivotTableの名前。

パラメータ string [fieldName] 変更されたフィールド名。

パラメータ string [sourceName] 変更されたフィールド名。

パラメータ boolean [oldValue] ピボットテーブルは、前の属性（collapse、summaryValueBy、showValueAs）の値を変更します。

パラメータ boolean [newValue] ピボットテーブルは、前の属性（collapse、summaryValueBy、showValueAs）の値を変更します。

パラメータ number [sortType] ピボットテーブルの並べ替えは、属性（sort）の値を変更します。

パラメータ Object [filterInfo] ピボットテーブルフィルターは、属性（filter）の値を変更します。

パラメータ number [clearType] ピボットテーブルクリアフィルターは、属性（filter）の値を変更します。

パラメータ number [oldArea] 古いピボットテーブルのフィールドの種類（fieldChanged）。

パラメータ number [oldIndex] 古いピボットテーブルのフィールドインデックス（fieldChanged）。

パラメータ number [newArea] 新しいピボットテーブルのフィールドの種類（fieldChanged）。

パラメータ number [newIndex] 新しいピボットテーブルのフィールドインデックス（fieldChanged）。

パラメータ string [viewName] ピボットテーブルのビュー名（viewChanged）を適用します。

実例

// 次のサンプルコードは、PivotTableChangedの使用方法を示します。
sheet.bind(GC.Spread.Sheets.Events.PivotTableChanged, function (sender, args) {
    alert("pivotTableName: " + args.pivotTableName + "changeType: " + args.type);
});

RangeChanged

• 静的 RangeChanged: string

セル範囲が変更されたときに発生します。

名前 GC.Spread.Sheets.Worksheet#RangeChanged

パラメータ GC.Spread.Sheets.Worksheet sheet イベントを発生させたシート。

パラメータ string sheetName シート名。

パラメータ number row 範囲の行インデックス。

パラメータ number col 範囲の列インデックス。

パラメータ number rowCount 範囲の行数。

パラメータ number colCount 範囲の列数。

パラメータ Array. tableNames テーブル名のコレクション。

パラメータ Array.

GC.Spread.Sheets.Events

クラス: Events

Table of contents

コンストラクタ

Events

コンストラクタ

constructor

Events

ActiveSheetChanged

ActiveSheetChanging

BeforePrint

ButtonClicked

CellChanged

CellClick

CellDoubleClick

ClipboardChanged

ClipboardChanging

ClipboardPasted

ClipboardPasting

ColumnChanged

ColumnChanging

ColumnWidthChanged

ColumnWidthChanging

CommentChanged

CommentRemoved

CommentRemoving

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

RowChanged

RowChanging

RowHeightChanged

RowHeightChanging

RowOperation

SelectionChanged

SelectionChanging

ShapeChanged

ShapeRemoved

ShapeRemoving

ShapeSelectionChanged

SheetChanged

SheetChanging

SheetMoved

SheetMoving

SheetNameChanged

SheetNameChanging

SheetTabClick

SheetTabDoubleClick