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
        );
    });
}