Excel.TableColumnCollection class

Package:: excel

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

Extends: OfficeExtension.ClientObject

Remarques

Utilisateur

Excel.Table : colonnes

Exemples

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

// Add checkboxes to 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 boolean values to checkboxes.
  range.control = {
    type: Excel.CellControlType.checkbox
  };
  await context.sync();
});

Propriétés

context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
count	Renvoie le nombre de colonnes du tableau.
items	Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(index, values, name)	Ajoute une nouvelle colonne au tableau.
getItem(key)	Obtient un objet de colonne par son nom ou son ID.
getItemAt(index)	Obtient une colonne en fonction de sa position dans la collection.
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.
toJSON()	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.TableColumnCollection` est un objet API, la `toJSON` méthode renvoie un objet JavaScript simple (typé ) `Excel.Interfaces.TableColumnCollectionData`qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

context

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é

Excel.RequestContext

count

Renvoie le nombre de colonnes du tableau.

readonly count: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.1

items

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

readonly items: Excel.TableColumn[];

Valeur de propriété

Excel.TableColumn[]

Détails de la méthode

add(index, values, name)

Ajoute une nouvelle colonne au tableau.

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

Paramètres

index: number

Facultatif. Spécifie la position relative de la nouvelle colonne. Si la valeur est null ou -1, la ligne est ajoutée à la fin. Les colonnes avec un index supérieur seront décalées sur le côté. Avec indice zéro.

values: Array<Array<boolean | string | number>> | boolean | string | number

Facultatif. Tableau 2D de valeurs non mises en forme de la colonne de la table.

name: string

Facultatif. Spécifie le nom de la nouvelle colonne. Si null, le nom par défaut est utilisé.

Retours

Excel.TableColumn

Remarques

Jeu d’API : ExcelApi 1.1 nécessite un index inférieur au nombre total de colonnes ; 1.4 permet à l’index d’être facultatif (null ou -1) et ajoutera une colonne à la fin ; 1.4 autorise le paramètre de nom 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);
});

getItem(key)

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

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

Paramètres

key: number | string

Nom ou ID de colonne.

Retours

Excel.TableColumn

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 all content from the Analysis column.
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();

  // Clear all the data from the second column.
  range.clearOrResetContents();
  await context.sync();
});

getItemAt(index)

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

getItemAt(index: number): Excel.TableColumn;

Paramètres

index: number

Valeur d’indice de l’objet à récupérer. Avec indice zéro.

Retours

Excel.TableColumn

Remarques

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

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

Paramètres

options: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retours

Excel.TableColumnCollection

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

Paramètres

propertyNames: string | string[]

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

Retours

Excel.TableColumnCollection

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

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?: OfficeExtension.LoadOption): Excel.TableColumnCollection;

Paramètres

propertyNamesAndPaths: OfficeExtension.LoadOption

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

toJSON()

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.TableColumnCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.TableColumnCollectionDataqui 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

Excel.Interfaces.TableColumnCollectionData

Commentaires

Cette page a-t-elle été utile ?