Partager via

Excel.TableChangedEventArgs interface

  • Référence
Paquet:
excel

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

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Propriétés

address

Obtient l’adresse qui représente la zone modifiée d’un tableau figurant dans une feuille de calcul spécifique.
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

Obtient 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 .
tableId

Obtient l’ID de la table dans laquelle les données ont été modifiées.
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 la plage qui représente la zone modifiée d’un tableau sur une feuille de calcul spécifique.

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

Obtient la plage qui représente la zone modifiée d’un tableau sur 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 qui représente la zone modifiée d’un tableau figurant dans une feuille de calcul spécifique.

address: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

Obtient 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

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-change-event-details.yaml

async function onTableChanged(eventArgs: Excel.TableChangedEventArgs) {
    await Excel.run(async (context) => {
        const details = eventArgs.details;
        const address = eventArgs.address;

        console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),`
          + ` now is ${details.valueAfter}(${details.valueTypeAfter})`);
    });
}

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 ]

tableId

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

tableId: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml

async function onChange(event) {
    await Excel.run(async (context) => {
        let table = context.workbook.tables.getItem(event.tableId);
        let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
        worksheet.load("name");

        await context.sync();

        console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
        console.log("Table Id : " + event.tableId);
        console.log("Worksheet Id : " + worksheet.name);
    });
}

type

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

type: "TableChanged";

Valeur de propriété

"TableChanged"

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 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml

async function onChange(event) {
    await Excel.run(async (context) => {
        let table = context.workbook.tables.getItem(event.tableId);
        let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
        worksheet.load("name");

        await context.sync();

        console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
        console.log("Table Id : " + event.tableId);
        console.log("Worksheet Id : " + worksheet.name);
    });
}

Détails de la méthode

getRange(ctx)

Obtient la plage qui représente la zone modifiée d’un tableau sur 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 la plage qui représente la zone modifiée d’un tableau sur 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