Excel. Table class

Propriétés

autoFilter	Représente l’objet `AutoFilter` de la table.
columns	Représente une collection de toutes les colonnes du tableau.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
highlightFirstColumn	Spécifie si la première colonne contient une mise en forme spéciale.
highlightLastColumn	Spécifie si la dernière colonne contient une mise en forme spéciale.
id	Renvoie une valeur qui permet d’identifier le tableau dans un classeur donné. La valeur de l’identificateur reste identique, même lorsque le tableau est renommé.
legacyId	Retourne un ID numérique.
name	Nom du tableau. Le nom de l’ensemble du tableau doit suivre les instructions spécifiées dans l’article Renommer un tableau Excel .
rows	Représente une collection de toutes les lignes du tableau.
showBandedColumns	Spécifie si les colonnes affichent une mise en forme à bandes dans laquelle les colonnes impaires sont mises en surbrillance différemment des colonnes paires, pour faciliter la lecture du tableau.
showBandedRows	Spécifie si les lignes affichent une mise en forme à bandes dans laquelle les lignes impaires sont mises en surbrillance différemment des lignes paires, pour faciliter la lecture du tableau.
showFilterButton	Spécifie si les boutons de filtre sont visibles en haut de chaque en-tête de colonne. Ce paramètre est autorisé uniquement si le tableau contient une ligne d’en-tête.
showHeaders	Spécifie si la ligne d’en-tête est visible. Cette valeur peut être définie de manière à afficher ou à masquer la ligne d’en-tête.
showTotals	Spécifie si la ligne totale est visible. Cette valeur peut être définie de manière à afficher ou à masquer la ligne de total.
sort	Représente le tri du tableau.
style	Valeur constante qui représente le style de tableau. Les valeurs possibles sont : « TableStyleLight1 » à « TableStyleLight21 », « TableStyleMedium1 » à « TableStyleMedium28 », « TableStyleDark1 » à « TableStyleDark11 ». Vous pouvez également indiquer un style personnalisé présent dans le classeur.
tableStyle	Style appliqué au tableau.
worksheet	Feuille de calcul contenant le tableau actif.

Méthodes

clearFilters()	Supprime tous les filtres appliqués actuellement sur le tableau.
clearStyle()	Modifie le tableau pour utiliser le style de tableau par défaut.
convertToRange()	Convertit le tableau en plage normale de cellules. Toutes les données sont conservées.
delete()	Supprime le tableau.
getDataBodyRange()	Obtient l’objet de plage associé au corps de données du tableau.
getHeaderRowRange()	Obtient l’objet de plage associé à la ligne d’en-tête du tableau.
getRange()	Renvoie l’objet de plage associé à l’intégralité du tableau.
getTotalRowRange()	Obtient l’objet de plage associé à la ligne de total du tableau.
load(options)	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)	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)	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.
reapplyFilters()	Applique de nouveau tous les filtres actuellement appliqués sur le tableau.
resize(newRange)	Redimensionnez la table en fonction de la nouvelle plage. La nouvelle plage doit chevaucher la plage de tableau d’origine et les en-têtes (ou le haut du tableau) doivent se trouver dans la même ligne.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
setStyle(style)	Définit le style appliqué au tableau.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`appelle à son tour la `toJSON` méthode de l’objet qui lui est passé.) Alors que l’objet Excel.Table d’origine est un objet API, la `toJSON` méthode retourne un objet JavaScript brut (tapé en tant `Excel.Interfaces.TableData`que ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Événements

onChanged	Se produit lorsque les données des cellules changent sur une table spécifique.
onFiltered	Se produit lorsqu’un filtre est appliqué à une table spécifique.
onSelectionChanged	Se produit lorsque la sélection change sur une table spécifique.

Détails de la propriété

autoFilter

Représente l’objet AutoFilter de la table.

readonly autoFilter: Excel.AutoFilter;

Valeur de propriété

Excel.AutoFilter

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

columns

Représente une collection de toutes les colonnes du tableau.

readonly columns: Excel.TableColumnCollection;

Valeur de propriété

Excel.TableColumnCollection

Remarques

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

highlightFirstColumn

Spécifie si la première colonne contient une mise en forme spéciale.

highlightFirstColumn: boolean;

Valeur de propriété

boolean

Remarques

highlightLastColumn

Spécifie si la dernière colonne contient une mise en forme spéciale.

highlightLastColumn: boolean;

Valeur de propriété

boolean

Remarques

id

Renvoie une valeur qui permet d’identifier le tableau dans un classeur donné. La valeur de l’identificateur reste identique, même lorsque le tableau est renommé.

readonly id: string;

Valeur de propriété

string

Remarques

legacyId

Retourne un ID numérique.

readonly legacyId: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

name

Nom du tableau.

Le nom de l’ensemble du tableau doit suivre les instructions spécifiées dans l’article Renommer un tableau Excel .

name: string;

Valeur de propriété

string

Remarques

rows

Représente une collection de toutes les lignes du tableau.

readonly rows: Excel.TableRowCollection;

Valeur de propriété

Excel.TableRowCollection

Remarques

showBandedColumns

Spécifie si les colonnes affichent une mise en forme à bandes dans laquelle les colonnes impaires sont mises en surbrillance différemment des colonnes paires, pour faciliter la lecture du tableau.

showBandedColumns: boolean;

Valeur de propriété

boolean

Remarques

showBandedRows

Spécifie si les lignes affichent une mise en forme à bandes dans laquelle les lignes impaires sont mises en surbrillance différemment des lignes paires, pour faciliter la lecture du tableau.

showBandedRows: boolean;

Valeur de propriété

boolean

Remarques

showFilterButton

Spécifie si les boutons de filtre sont visibles en haut de chaque en-tête de colonne. Ce paramètre est autorisé uniquement si le tableau contient une ligne d’en-tête.

showFilterButton: boolean;

Valeur de propriété

boolean

Remarques

showHeaders

Spécifie si la ligne d’en-tête est visible. Cette valeur peut être définie de manière à afficher ou à masquer la ligne d’en-tête.

showHeaders: boolean;

Valeur de propriété

boolean

Remarques

showTotals

Spécifie si la ligne totale est visible. Cette valeur peut être définie de manière à afficher ou à masquer la ligne de total.

showTotals: boolean;

Valeur de propriété

boolean

Remarques

sort

Représente le tri du tableau.

readonly sort: Excel.TableSort;

Valeur de propriété

Excel.TableSort

Remarques

style

Valeur constante qui représente le style de tableau. Les valeurs possibles sont : « TableStyleLight1 » à « TableStyleLight21 », « TableStyleMedium1 » à « TableStyleMedium28 », « TableStyleDark1 » à « TableStyleDark11 ». Vous pouvez également indiquer un style personnalisé présent dans le classeur.

style: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

Exemples

// Set table style.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.name = 'Table1-Renamed';
    table.showTotals = false;
    table.style = 'TableStyleMedium2';
    table.load('tableStyle');
    await context.sync();
    
    console.log(table.style);
});

tableStyle

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Style appliqué au tableau.

readonly tableStyle: Excel.TableStyle;

Valeur de propriété

Excel.TableStyle

Remarques

worksheet

Feuille de calcul contenant le tableau actif.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Excel.Worksheet

Remarques

Détails de la méthode

clearFilters()

Supprime tous les filtres appliqués actuellement sur le tableau.

clearFilters(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

clearStyle()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Modifie le tableau pour utiliser le style de tableau par défaut.

clearStyle(): void;

Retours

void

Remarques

convertToRange()

Convertit le tableau en plage normale de cellules. Toutes les données sont conservées.

convertToRange(): Excel.Range;

Retours

Excel.Range

Remarques

Exemples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.convertToRange();
    await context.sync(); 
});

delete()

Supprime le tableau.

delete(): void;

Retours

void

Remarques

Exemples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.delete();
    await context.sync(); 
});

getDataBodyRange()

Obtient l’objet de plage associé au corps de données du tableau.

getDataBodyRange(): Excel.Range;

Retours

Excel.Range

Remarques

Exemples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableDataRange = table.getDataBodyRange();
    tableDataRange.load('address')
    await context.sync();
    
    console.log(tableDataRange.address);
});

getHeaderRowRange()

Obtient l’objet de plage associé à la ligne d’en-tête du tableau.

getHeaderRowRange(): Excel.Range;

Retours

Excel.Range

Remarques

Exemples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableHeaderRange = table.getHeaderRowRange();
    tableHeaderRange.load('address');
    await context.sync();

    console.log(tableHeaderRange.address);
});

getRange()

Renvoie l’objet de plage associé à l’intégralité du tableau.

getRange(): Excel.Range;

Retours

Excel.Range

Remarques

Exemples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableRange = table.getRange();
    tableRange.load('address');    
    await context.sync();
    
    console.log(tableRange.address);
});

getTotalRowRange()

Obtient l’objet de plage associé à la ligne de total du tableau.

getTotalRowRange(): Excel.Range;

Retours

Excel.Range

Remarques

Exemples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableTotalsRange = table.getTotalRowRange();
    tableTotalsRange.load('address');    
    await context.sync();
    
    console.log(tableTotalsRange.address);
});

load(options)

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.TableLoadOptions): Excel.Table;

Paramètres

options: Excel.Interfaces.TableLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.Table

load(propertyNames)

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.Table;

Paramètres

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.Table

Exemples

// Get a table by name.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.load('id')
    await context.sync();
    
    console.log(table.id);
});

load(propertyNamesAndPaths)

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?: {
            select?: string;
            expand?: string;
        }): Excel.Table;

Paramètres

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.Table

reapplyFilters()

Applique de nouveau tous les filtres actuellement appliqués sur le tableau.

reapplyFilters(): void;

Retours

void

Remarques