Excel.TableChangedEventArgs interface

Пакет:

excel

Содержит сведения о таблице, которая вызвала событие "изменено".

Комментарии

Набор API: ExcelApi 1.7

Используется

• Excel.Таблица: onChanged
• Excel.TableCollection: onChanged

Свойства

address	Получает адрес, представляющий измененную область таблицы на конкретном листе.
changeType	Получает тип изменения, представляющий способ запуска события изменения. См. Excel.DataChangeType дополнительные сведения.
details	Получает сведения об изменениях. Это свойство можно получить, когда событие изменения запускается в одной ячейке. Если событие изменения запускается в нескольких ячейках, это свойство невозможно получить.
source	Получает источник события. См. Excel.EventSource дополнительные сведения.
tableId	Получает идентификатор таблицы, в которой были изменены данные.
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

Примеры

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

async function onTableChanged(eventArgs: Excel.TableChangedEventArgs) {
    await Excel.run(async (context) => {
        const details = eventArgs.details;
        const address = eventArgs.address;

        console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),`
          + ` now is ${details.valueAfter}(${details.valueTypeAfter})`);
    });
}

source

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

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

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

Excel.EventSource | "Local" | "Remote"

Комментарии

Набор API: ExcelApi 1.7

tableId

Получает идентификатор таблицы, в которой были изменены данные.

tableId: string;

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

string

Комментарии

Набор API: ExcelApi 1.7

Примеры

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

async function onChange(event) {
    await Excel.run(async (context) => {
        let table = context.workbook.tables.getItem(event.tableId);
        let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
        worksheet.load("name");

        await context.sync();

        console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
        console.log("Table Id : " + event.tableId);
        console.log("Worksheet Id : " + worksheet.name);
    });
}

type

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

type: "TableChanged";

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

"TableChanged"

Комментарии

Набор API: ExcelApi 1.7

worksheetId

Получает идентификатор листа, на котором изменены данные.

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-tablecollection-changed.yaml

async function onChange(event) {
    await Excel.run(async (context) => {
        let table = context.workbook.tables.getItem(event.tableId);
        let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
        worksheet.load("name");

        await context.sync();

        console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
        console.log("Table Id : " + event.tableId);
        console.log("Worksheet Id : " + worksheet.name);
    });
}

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

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