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

Excel.TableChangedEventArgs interface

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

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

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