Excel.WorksheetChangedEventArgs interface
Предоставляет сведения о листе, на котором возникло событие "Изменено".
Комментарии
Используется
Свойства
| address | Получает адрес диапазона, представляющий измененную область конкретного листа. |
| change |
Представляет собой изменение направления смещения ячеек листа при удалении или вставке одной или нескольких ячеек. Это включает следующие два сценария. 1. Направление (например, вниз или вправо), в котором будут смещаться существующие ячейки при вставке новой ячейки на лист. 2. Направление (например, вверх или влево), в котором будут смещаться остальные ячейки при удалении одной или нескольких ячеек с листа. |
| change |
Получает тип изменения, представляющий способ запуска события изменения. См. |
| details | Представляет сведения об изменениях. Это свойство можно получить, когда событие изменения запускается в одной ячейке. Если событие изменения запускается в нескольких ячейках, это свойство невозможно получить. |
| source | Получает источник события. См. |
| trigger |
Представляет источник триггера события. Например, определяет, вызывает ли эта локальная надстройка событие. |
| type | Получает тип события. См. |
| worksheet |
Получает идентификатор листа, на котором изменены данные. |
Методы
| get |
Получает диапазон, представляющий измененную область конкретного листа. |
| get |
Получает диапазон, представляющий измененную область конкретного листа. Может возвращать пустой объект. |
Сведения о свойстве
address
Получает адрес диапазона, представляющий измененную область конкретного листа.
address: string;Значение свойства
string
Комментарии
changeDirectionState
Представляет собой изменение направления смещения ячеек листа при удалении или вставке одной или нескольких ячеек. Это включает следующие два сценария. 1. Направление (например, вниз или вправо), в котором будут смещаться существующие ячейки при вставке новой ячейки на лист. 2. Направление (например, вверх или влево), в котором будут смещаться остальные ячейки при удалении одной или нескольких ячеек с листа.
changeDirectionState: Excel.ChangeDirectionState;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml
async function onChange(event: Excel.WorksheetChangedEventArgs) {
// This function is an event handler that returns the address, trigger source,
// and insert or delete shift directions of the change.
await Excel.run(async (context) => {
// Return the address where change occurred.
console.log(`Handler for worksheet onChanged event has been triggered.`);
console.log(` Data changed address: ` + event.address);
// Return the source of the event that triggered the change.
console.log(` Data change trigger source: ` + event.triggerSource);
// Note：insertShiftDirection and deleteShiftDirection are exclusive and both enums can't have a value at the same time.
// If one has a value, then the other will return undefined.
// If the insert shift direction is defined, return it.
if (event.changeDirectionState.insertShiftDirection) {
console.log(` Cells inserted shift direction: ` + event.changeDirectionState.insertShiftDirection);
}
// If the delete shift direction is defined, return it.
if (event.changeDirectionState.deleteShiftDirection) {
console.log(` Cells deleted shift direction: ` + event.changeDirectionState.deleteShiftDirection);
}
});
}
...
// This function deletes data from a range and sets the delete shift direction to "up".
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("A5:F5");
range.delete(Excel.DeleteShiftDirection.up);
});
changeType
Получает тип изменения, представляющий способ запуска события изменения. См. Excel.DataChangeType дополнительные сведения.
changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted";Значение свойства
Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"
Комментарии
details
Представляет сведения об изменениях. Это свойство можно получить, когда событие изменения запускается в одной ячейке. Если событие изменения запускается в нескольких ячейках, это свойство невозможно получить.
details: Excel.ChangedEventDetail;Значение свойства
Комментарии
Примеры
// 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"
Комментарии
triggerSource
Представляет источник триггера события. Например, определяет, вызывает ли эта локальная надстройка событие.
triggerSource: Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin";Значение свойства
Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin"
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml
async function onChange(event: Excel.WorksheetChangedEventArgs) {
// This function is an event handler that returns the address, trigger source,
// and insert or delete shift directions of the change.
await Excel.run(async (context) => {
// Return the address where change occurred.
console.log(`Handler for worksheet onChanged event has been triggered.`);
console.log(` Data changed address: ` + event.address);
// Return the source of the event that triggered the change.
console.log(` Data change trigger source: ` + event.triggerSource);
// Note：insertShiftDirection and deleteShiftDirection are exclusive and both enums can't have a value at the same time.
// If one has a value, then the other will return undefined.
// If the insert shift direction is defined, return it.
if (event.changeDirectionState.insertShiftDirection) {
console.log(` Cells inserted shift direction: ` + event.changeDirectionState.insertShiftDirection);
}
// If the delete shift direction is defined, return it.
if (event.changeDirectionState.deleteShiftDirection) {
console.log(` Cells deleted shift direction: ` + event.changeDirectionState.deleteShiftDirection);
}
});
}
type
Получает тип события. См. Excel.EventType дополнительные сведения.
type: "WorksheetChanged";Значение свойства
"WorksheetChanged"
Комментарии
worksheetId
Получает идентификатор листа, на котором изменены данные.
worksheetId: string;Значение свойства
string
Комментарии
Сведения о методе
getRange(ctx)
Получает диапазон, представляющий измененную область конкретного листа.
getRange(ctx: Excel.RequestContext): Excel.Range;Параметры
Возвращаемое значение
getRangeOrNullObject(ctx)
Получает диапазон, представляющий измененную область конкретного листа. Может возвращать пустой объект.
getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;