Excel.TableCollection class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Renvoie le nombre de tableaux dans le classeur.

readonly count: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.Table[];

Valeur de propriété

Crée une table. L’objet de plage ou l’adresse source détermine la feuille de calcul sous laquelle la table sera ajoutée. Si la table ne peut pas être ajoutée (par exemple, parce que l’adresse n’est pas valide ou que la table chevaucherait une autre table), une erreur est générée.

add(address: Range | string, hasHeaders: boolean): Excel.Table;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const table = context.workbook.tables.add('Sheet1!A1:E7', true);
    table.load('name');
    await context.sync();
    
    console.log(table.name);
});

Obtient le nombre de tableaux de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

Jeu d’API : ExcelApi 1.4

Obtient un tableau à l’aide de son nom ou de son ID.

getItem(key: string): Excel.Table;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml

// Remove checkboxes from the table.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Get the second column in the table, without the header.
  const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

  // Change the checkboxes back to boolean values.
  range.control = {
    type: Excel.CellControlType.empty
  };
  await context.sync();
});

Obtient un tableau en fonction de sa position dans la collection.

getItemAt(index: number): Excel.Table;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const table = context.workbook.tables.getItemAt(0);
    table.load('name');
    await context.sync();
    
    console.log(table.name);
});

Obtient un tableau à l’aide de son nom ou de son ID. Si la table n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getItemOrNullObject(key: string): Excel.Table;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.4

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.TableCollection;

Paramètres

Retours

Exemples

// Get the number of tables.
await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    tables.load('count');
    await context.sync();
    
    console.log(tables.count);
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableCollection;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.TableCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.TableCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.TableCollectionData;

Retours

Se produit lorsqu’une nouvelle table est ajoutée à un classeur.

readonly onAdded: OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.9

Se produit lorsque des données changent dans une table d’un classeur ou d’une feuille de calcul.

readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;

Type d’événement

Remarques

Jeu 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

await Excel.run(async (context) => {
    let tables = context.workbook.tables;
    tables.onChanged.add(onChange);

    await context.sync();
    console.log("A handler has been registered for the table collection onChanged event");
});

Se produit lorsque le tableau spécifié est supprimé dans un classeur.

readonly onDeleted: OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.9

Se produit lorsqu’un filtre est appliqué à une table d’un classeur ou d’une feuille de calcul.

readonly onFiltered: OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)