Excel.WorksheetMovedEventArgs interface

Пакет:

excel

Уведомляет о перемещении листа в книгу.

Если лист перемещается из одной позиции книги в другую с помощью пользовательского интерфейса Excel, этот API активирует событие. Обратите внимание, что если положение листа изменяется в результате перемещения другого листа, это событие не будет активироваться для обоих изменений положения. Это событие активирует только основное перемещение листа, а не любые изменения положения листа, которые происходят в результате этого основного перемещения.

Комментарии

[ Набор API: ExcelApi 1.17 ]

Примеры

// 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 onWorksheetMoved(event) {
    await Excel.run(async (context) => {
        console.log("Handler for worksheet onMoved event has been triggered.");
        console.log(`    Worksheet ID: ${event.worksheetId}`);
        console.log(`    Position before move: ${event.positionBefore}`);
        console.log(`    Position after move: ${event.positionAfter}`);
        console.log(`    Event source: ${event.source}`);
    });
}

Свойства

positionAfter	Возвращает новое положение листа после перемещения.
positionBefore	Возвращает предыдущее положение листа перед перемещением.
source	Источник события. Он может быть локальным или удаленным (с помощью совместного редактирования).
type	Получает тип события.
worksheetId	Возвращает идентификатор перемещенного листа.

Сведения о свойстве

positionAfter

Возвращает новое положение листа после перемещения.

positionAfter: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi 1.17 ]

positionBefore

Возвращает предыдущее положение листа перед перемещением.

positionBefore: number;

Значение свойства

number

Комментарии

[ Набор 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

Возвращает идентификатор перемещенного листа.

worksheetId: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.17 ]