Excel.WorksheetAddedEventArgs interface

Gets the source of the event. See Excel.EventSource for details.

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

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Gets the type of the event. See Excel.EventType for details.

type: "WorksheetAdded";

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Gets the ID of the worksheet that is added to the workbook.

worksheetId: string;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Examples

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