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