Partager via

Excel.Table class

  • Référence
Paquet:
excel

Représente un tableau Excel. Pour en savoir plus sur le modèle objet de table, consultez Utiliser des tableaux à l’aide de l’API JavaScript Excel.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

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.
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é.
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.
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.
worksheet

Feuille de calcul contenant le tableau actif.

Méthodes

clearFilters()

Supprime tous les filtres appliqués actuellement sur le tableau.
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.
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.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Table est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.TableDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

columns

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

readonly columns: Excel.TableColumnCollection;

Valeur de propriété

Excel.TableColumnCollection

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

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

[ Ensemble d’API : ExcelApi 1.1 ]

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

[ Ensemble d’API : ExcelApi 1.1 ]

rows

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

readonly rows: Excel.TableRowCollection;

Valeur de propriété

Excel.TableRowCollection

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

[ Ensemble d’API : ExcelApi 1.1 ]

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

[ Ensemble d’API : ExcelApi 1.1 ]

sort

Représente le tri du tableau.

readonly sort: Excel.TableSort;

Valeur de propriété

Excel.TableSort

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

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 1.1 ]

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

worksheet

Feuille de calcul contenant le tableau actif.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Excel.Worksheet

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

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 1.2 ]

convertToRange()

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

convertToRange(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

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

[ Ensemble d’API : ExcelApi 1.1 ]

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

[ Ensemble d’API : ExcelApi 1.1 ]

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

[ Ensemble d’API : ExcelApi 1.1 ]

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

[ Ensemble d’API : ExcelApi 1.1 ]

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

[ Ensemble d’API : ExcelApi 1.1 ]

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

[ Ensemble d’API : ExcelApi 1.2 ]

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: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.TableUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Table): void;

Paramètres

properties
Excel.Table

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Table est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.TableDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.TableData;

Retours

Excel.Interfaces.TableData