Excel.WorksheetAddedEventArgs interface

  • リファレンス
パッケージ:
excel

追加されたイベントを発生させたワークシートに関する情報を提供します。

注釈

[ API セット: ExcelApi 1.7 ]

プロパティ

source

イベントのソースを取得します。 詳細は「Excel.EventSource」をご覧ください。
type

イベントの種類を取得します。 詳細は「Excel.EventType」をご覧ください。
worksheetId

ブックに追加されるワークシートの ID を取得します。

プロパティの詳細

source

イベントのソースを取得します。 詳細は「Excel.EventSource」をご覧ください。

source: Excel.EventSource | "Local" | "Remote";

プロパティ値

Excel.EventSource | "Local" | "Remote"

注釈

[ API セット: ExcelApi 1.7 ]

type

イベントの種類を取得します。 詳細は「Excel.EventType」をご覧ください。

type: "WorksheetAdded";

プロパティ値

"WorksheetAdded"

注釈

[ API セット: ExcelApi 1.7 ]

worksheetId

ブックに追加されるワークシートの ID を取得します。

worksheetId: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml

async function onWorksheetAdd(event) {
    await Excel.run(async (context) => {
        console.log(
            "Handler for worksheet onAdded event has been triggered. Newly added worksheet Id : " +
            event.worksheetId
        );
    });
}