Excel.WorksheetFormulaChangedEventArgs interface

Пакет:

excel

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

Комментарии

Набор API: ExcelApi 1.13

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

• Excel.Worksheet: onFormulaChanged
• Excel.WorksheetCollection: onFormulaChanged

Примеры

async function registerFormulaChangeHandler() {
    await Excel.run(async (context) => {
        // Register the formula changed event handler for the Sample worksheet.
        let sheet = context.workbook.worksheets.getItem("Sample");
        sheet.onFormulaChanged.add(formulaChangeHandler);
        await context.sync();
    });
}

async function formulaChangeHandler(event: Excel.WorksheetFormulaChangedEventArgs) {
    await Excel.run(async (context) => {
        // Retrieve details about the formula change event.
        const cellAddress = event.formulaDetails[0].cellAddress;
        const previousFormula = event.formulaDetails[0].previousFormula;
        const source = event.source;
        
        // Print out the change event details.
        console.log(
            `The formula in cell ${cellAddress} changed. 
            The previous formula was: ${previousFormula}. 
            The source of the change was: ${source}.`
        );
    });
}

Свойства

formulaDetails	Возвращает массив FormulaChangedEventDetail объектов, содержащих сведения обо всех измененных формулах. Если количество измененных формул или размер измененного текста формул превышает предельный размер, formulaDetails возвращает значение undefined. Это означает, что что-то на листе изменилось, но сведения не могут быть сообщены.
source	Источник события. Он может быть локальным или удаленным (с помощью совместного редактирования).
type	Получает тип события. Дополнительные сведения см. в этой Excel.EventType статье.
worksheetId	Возвращает идентификатор листа, на котором была изменена формула.

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

formulaDetails

Возвращает массив FormulaChangedEventDetail объектов, содержащих сведения обо всех измененных формулах.

Если количество измененных формул или размер измененного текста формул превышает предельный размер, formulaDetails возвращает значение undefined. Это означает, что что-то на листе изменилось, но сведения не могут быть сообщены.

formulaDetails: Excel.FormulaChangedEventDetail[];

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

Excel.FormulaChangedEventDetail[]

Комментарии

Набор API: ExcelApi 1.13

source

Источник события. Он может быть локальным или удаленным (с помощью совместного редактирования).

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

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

Excel.EventSource | "Local" | "Remote"

Комментарии

Набор API: ExcelApi 1.13

type

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

type: "WorksheetFormulaChanged";

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

"WorksheetFormulaChanged"

Комментарии

Набор API: ExcelApi 1.13

worksheetId

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

worksheetId: string;

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

string

Комментарии

Набор API: ExcelApi 1.13