Поделиться через

Excel.WorksheetChangedEventArgs interface

  • Ссылка
Пакет:
excel

Предоставляет сведения о листе, на который возникло событие изменения.

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

address

Получает адрес диапазона, представляющий измененную область конкретного листа.
changeType

Возвращает тип изменения, представляющий способ активации события изменения. Дополнительные сведения см. в этой Excel.DataChangeType статье.
details

Представляет сведения об изменениях. Это свойство можно получить при активации события изменения в одной ячейке. Если измененное событие активируется в нескольких ячейках, это свойство невозможно получить.
source

Получает источник события. Дополнительные сведения см. в этой Excel.EventSource статье.
type

Получает тип события. Дополнительные сведения см. в этой Excel.EventType статье.
worksheetId

Возвращает идентификатор листа, на котором были изменены данные.

Методы

getRange(ctx)

Получает диапазон, представляющий измененную область конкретного листа.

[ Набор API: ExcelApi 1.8 ]
getRangeOrNullObject(ctx)

Получает диапазон, представляющий измененную область конкретного листа. Может возвращать пустой объект.

[ Набор API: ExcelApi 1.8 ]

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

address

Получает адрес диапазона, представляющий измененную область конкретного листа.

address: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

changeType

Возвращает тип изменения, представляющий способ активации события изменения. Дополнительные сведения см. в этой Excel.DataChangeType статье.

changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted";

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

Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"

Комментарии

[ Набор API: ExcelApi 1.7 ]

details

Представляет сведения об изменениях. Это свойство можно получить при активации события изменения в одной ячейке. Если измененное событие активируется в нескольких ячейках, это свойство невозможно получить.

details: Excel.ChangedEventDetail;

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

Excel.ChangedEventDetail

Комментарии

[ Набор API: ExcelApi 1.9 ]

Примеры

// This function would be used as an event handler for the Worksheet.onChanged event.
async function onWorksheetChanged(eventArgs) {
    await Excel.run(async (context) => {
        const details = eventArgs.details;
        const address = eventArgs.address;

        // Print the before and after types and values to the console.
        console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),`
            + ` now is ${details.valueAfter}(${details.valueTypeAfter})`);
        await context.sync();
    });
}

source

Получает источник события. Дополнительные сведения см. в этой Excel.EventSource статье.

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

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

Excel.EventSource | "Local" | "Remote"

Комментарии

[ Набор API: ExcelApi 1.7 ]

type

Получает тип события. Дополнительные сведения см. в этой Excel.EventType статье.

type: "WorksheetChanged";

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

"WorksheetChanged"

Комментарии

[ Набор API: ExcelApi 1.7 ]

worksheetId

Возвращает идентификатор листа, на котором были изменены данные.

worksheetId: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

Сведения о методе

getRange(ctx)

Получает диапазон, представляющий измененную область конкретного листа.

[ Набор API: ExcelApi 1.8 ]

getRange(ctx: Excel.RequestContext): Excel.Range;

Параметры

ctx
Excel.RequestContext

Возвращаемое значение

Excel.Range

getRangeOrNullObject(ctx)

Получает диапазон, представляющий измененную область конкретного листа. Может возвращать пустой объект.

[ Набор API: ExcelApi 1.8 ]

getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;

Параметры

ctx
Excel.RequestContext

Возвращаемое значение

Excel.Range