Excel.TableColumnCollection class

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é

Renvoie le nombre de colonnes du tableau.

readonly count: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

readonly items: Excel.TableColumn[];

Valeur de propriété

Ajoute une nouvelle colonne au tableau.

add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string): Excel.TableColumn;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.1 nécessite un index inférieur au nombre total de colonnes ; 1,4 autorise l’index à être facultatif (null ou -1) et ajoute une colonne à la fin ; 1.4 autorise le paramètre name au moment de la création. ]

Exemples

await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    const values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]];
    const column = tables.getItem("Table1").columns.add(null, values);
    column.load('name');
    await context.sync();
    
    console.log(column.name);
});

Ajoute une nouvelle colonne au tableau. Contrairement à add(), addAsJson() prend n’importe quel type de valeur de cellule, tel que les types de données d’image ou d’entité.

addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

Obtient le nombre de colonnes dans le tableau.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

Obtient un objet de colonne par son nom ou son ID.

getItem(key: number | string): Excel.TableColumn;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

await Excel.run(async (context) => { 
    const tableColumn = context.workbook.tables.getItem('Table1').columns.getItem(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

Obtient une colonne en fonction de sa position dans la collection.

getItemAt(index: number): Excel.TableColumn;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

await Excel.run(async (context) => { 
    const tableColumn = context.workbook.tables.getItem['Table1'].columns.getItemAt(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

Obtient un objet de colonne par son nom ou son ID. Si la colonne n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(key: number | string): Excel.TableColumn;

Paramètres

Retours

Remarques

[ Ensemble 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.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection;

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

Paramètres

Retours

Exemples

await Excel.run(async (context) => { 
    const tableColumns = context.workbook.tables.getItem('Table1').columns;
    tableColumns.load('items');
    await context.sync();
    
    console.log("tableColumns Count: " + tableColumns.count);
    for (let i = 0; i < tableColumns.items.length; i++) {
        console.log(tableColumns.items[i].name);
    }
});

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

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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.TableColumnCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.TableColumnCollectionDataque ) qui 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.TableColumnCollectionData;

Retours