Excel.WorksheetChangedEventArgs interface

  • Référence
Paquet:
excel

Fournit des informations sur la feuille de calcul qui a déclenché l’événement modifié.

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Propriétés

address

Obtient l’adresse de plage qui représente la zone modifiée dans une feuille de calcul spécifique.
changeDirectionState

Représente une modification de la direction dans laquelle les cellules d’une feuille de calcul changent lorsqu’une ou plusieurs cellules sont supprimées ou insérées. Cela inclut les deux scénarios suivants. 1. Direction (par exemple, vers le bas ou vers la droite) que les cellules existantes changent lorsqu’une ou plusieurs cellules sont insérées dans une feuille de calcul. 2. Direction (par exemple vers le haut ou vers la gauche) que les cellules restantes changent lorsqu’une ou plusieurs cellules sont supprimées d’une feuille de calcul.
changeType

Obtient le type de modification qui représente la façon dont l’événement modifié est déclenché. Pour plus d’informations, consultez Excel.DataChangeType .
details

Représente les informations sur le détail de la modification. Cette propriété peut être récupérée lorsque l’événement modifié est déclenché sur une seule cellule. Si l’événement modifié est déclenché sur plusieurs cellules, cette propriété ne peut pas être récupérée.
source

Obtient la source de l’événement. Pour plus d’informations, consultez Excel.EventSource .
triggerSource

Représente la source de déclencheur de l’événement. Par exemple, identifie si ce complément local déclenche l’événement.
type

Obtient le type de l’événement. Pour plus d’informations, consultez Excel.EventType .
worksheetId

Obtient l’ID de la feuille de calcul dans laquelle les données ont été modifiées.

Méthodes

getRange(ctx)

Obtient l’adresse de plage qui représente la zone modifiée dans une feuille de calcul spécifique.

[ Ensemble d’API : ExcelApi 1.8 ]
getRangeOrNullObject(ctx)

Obtient l’adresse de plage qui représente la zone modifiée dans une feuille de calcul spécifique. Il peut renvoyer un objet null.

[ Ensemble d’API : ExcelApi 1.8 ]

Détails de la propriété

address

Obtient l’adresse de plage qui représente la zone modifiée dans une feuille de calcul spécifique.

address: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

changeDirectionState

Représente une modification de la direction dans laquelle les cellules d’une feuille de calcul changent lorsqu’une ou plusieurs cellules sont supprimées ou insérées. Cela inclut les deux scénarios suivants. 1. Direction (par exemple, vers le bas ou vers la droite) que les cellules existantes changent lorsqu’une ou plusieurs cellules sont insérées dans une feuille de calcul. 2. Direction (par exemple vers le haut ou vers la gauche) que les cellules restantes changent lorsqu’une ou plusieurs cellules sont supprimées d’une feuille de calcul.

changeDirectionState: Excel.ChangeDirectionState;

Valeur de propriété

Excel.ChangeDirectionState

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

Exemples

// 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

Obtient le type de modification qui représente la façon dont l’événement modifié est déclenché. Pour plus d’informations, consultez Excel.DataChangeType .

changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted";

Valeur de propriété

Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

details

Représente les informations sur le détail de la modification. Cette propriété peut être récupérée lorsque l’événement modifié est déclenché sur une seule cellule. Si l’événement modifié est déclenché sur plusieurs cellules, cette propriété ne peut pas être récupérée.

details: Excel.ChangedEventDetail;

Valeur de propriété

Excel.ChangedEventDetail

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// 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

Obtient la source de l’événement. Pour plus d’informations, consultez Excel.EventSource .

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

Valeur de propriété

Excel.EventSource | "Local" | "Remote"

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

triggerSource

Représente la source de déclencheur de l’événement. Par exemple, identifie si ce complément local déclenche l’événement.

triggerSource: Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin";

Valeur de propriété

Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin"

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

Exemples

// 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

Obtient le type de l’événement. Pour plus d’informations, consultez Excel.EventType .

type: "WorksheetChanged";

Valeur de propriété

"WorksheetChanged"

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

worksheetId

Obtient l’ID de la feuille de calcul dans laquelle les données ont été modifiées.

worksheetId: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Détails de la méthode

getRange(ctx)

Obtient l’adresse de plage qui représente la zone modifiée dans une feuille de calcul spécifique.

[ Ensemble d’API : ExcelApi 1.8 ]

getRange(ctx: Excel.RequestContext): Excel.Range;

Paramètres

ctx
Excel.RequestContext

Retours

Excel.Range

getRangeOrNullObject(ctx)

Obtient l’adresse de plage qui représente la zone modifiée dans une feuille de calcul spécifique. Il peut renvoyer un objet null.

[ Ensemble d’API : ExcelApi 1.8 ]

getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;

Paramètres

ctx
Excel.RequestContext

Retours

Excel.Range