Excel.WorksheetNameChangedEventArgs interface

包:
excel

提供名称已更改的工作表的相关信息。

注解

API 集：ExcelApi 1.17

使用方

示例

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

async function onNameChanged(event: Excel.WorksheetNameChangedEventArgs) {
    await Excel.run(async (context) => {
        console.log(`Handler for worksheet onNameChanged event has been triggered.`);
        console.log(`    Name before change: ` + event.nameBefore);
        console.log(`    Name after change: ` + event.nameAfter);
    });
}

属性

nameAfter

在名称更改后获取工作表的新名称。
nameBefore

获取名称更改之前的工作表的先前名称。
source

事件的源。 它可以是本地的，也可以通过共同创作) 远程 (。
type

获取事件的类型。
worksheetId

获取具有新名称的工作表的 ID。

属性详细信息

nameAfter

在名称更改后获取工作表的新名称。

nameAfter: string;

属性值

string

注解

API 集：ExcelApi 1.17

nameBefore

获取名称更改之前的工作表的先前名称。

nameBefore: string;

属性值

string

注解

API 集：ExcelApi 1.17

source

事件的源。 它可以是本地的，也可以通过共同创作) 远程 (。

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

属性值

Excel.EventSource | "Local" | "Remote"

注解

API 集：ExcelApi 1.17

type

获取事件的类型。

type: string;

属性值

string

注解

API 集：ExcelApi 1.17

worksheetId

获取具有新名称的工作表的 ID。

worksheetId: string;

属性值

string

注解

API 集：ExcelApi 1.17