Excel.WorksheetFormulaChangedEventArgs interface

Package:

excel

Fournit des informations sur la feuille de calcul et les formules qui ont déclenché l’événement de modification de formule.

Remarques

Jeu d’API : ExcelApi 1.13

Utilisateur

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

Exemples

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}.`
        );
    });
}

Propriétés

formulaDetails	Obtient un tableau d’objets FormulaChangedEventDetail , qui contiennent les détails de toutes les formules modifiées. Si le nombre de formules modifiées ou la taille du texte de formule modifié dépasse une limite de taille, la formulaDetails valeur sera indéfinie, ce qui indique qu’un élément de la feuille a changé, mais les détails ne peuvent pas être signalés en raison de ces limites.
source	Source de l'événement. Il peut être local ou distant (par le biais de la co-édition).
type	Obtient le type de l’événement. Pour Excel.EventType plus de détails.
worksheetId	Obtient l’ID de la feuille de calcul dans laquelle la formule a changé.

Détails de la propriété

formulaDetails

Obtient un tableau d’objets FormulaChangedEventDetail , qui contiennent les détails de toutes les formules modifiées.

Si le nombre de formules modifiées ou la taille du texte de formule modifié dépasse une limite de taille, la formulaDetails valeur sera indéfinie, ce qui indique qu’un élément de la feuille a changé, mais les détails ne peuvent pas être signalés en raison de ces limites.

formulaDetails: Excel.FormulaChangedEventDetail[];

Valeur de propriété

Excel.FormulaChangedEventDetail[]

Remarques

Jeu d’API : ExcelApi 1.13

source

Source de l'événement. Il peut être local ou distant (par le biais de la co-édition).

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

Valeur de propriété

Excel.EventSource | "Local" | "Remote"

Remarques

Jeu d’API : ExcelApi 1.13

type

Obtient le type de l’événement. Pour Excel.EventType plus de détails.

type: "WorksheetFormulaChanged";

Valeur de propriété

"WorksheetFormulaChanged"

Remarques

Jeu d’API : ExcelApi 1.13

worksheetId

Obtient l’ID de la feuille de calcul dans laquelle la formule a changé.

worksheetId: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.13