Excel.TableRowCollection 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 lignes du tableau.

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.TableRow[];

Valeur de propriété

Ajoute une ou plusieurs lignes dans le tableau. L’objet renvoyé sera placé en premier dans les lignes récemment ajoutées.

Notez que, contrairement aux plages ou colonnes, qui s’ajustent si de nouvelles lignes ou colonnes sont ajoutées avant elles, un TableRow objet représente l’emplacement physique de la ligne du tableau, mais pas les données. En d’autres termes, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de tableau continue à pointer vers l’index pour lequel elle a été créée.

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

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1 pour ajouter une seule ligne ; 1.4 permet d’ajouter plusieurs lignes ; 1.15 pour ajouter un alwaysInsert paramètre.

Exemples

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

Ajoute une ou plusieurs lignes dans le tableau. L’objet renvoyé sera la ligne supérieure de la ou des lignes nouvellement ajoutées. Contrairement à add(), addAsJson() prend n’importe quel type de valeur de cellule, tel que les types de données image ou entité.

Notez que, contrairement aux plages ou colonnes, qui s’ajustent si de nouvelles lignes ou colonnes sont ajoutées avant elles, un TableRow objet représente l’emplacement physique de la ligne du tableau, mais pas les données. En d’autres termes, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de tableau continue à pointer vers l’index pour lequel elle a été créée.

addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean): Excel.TableRow;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.16

Supprimer plusieurs lignes d’un tableau. Ces lignes n’ont pas besoin d’être séquentielles. Cette méthode renvoie l’erreur InvalidArgument si une ligne choisie a déjà été supprimée ou n’existe pas. Cette méthode renvoie l’erreur InsertDeleteConflict si un filtre est appliqué à la table sur laquelle la méthode est appelée.

deleteRows(rows: number[] | TableRow[]): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiOnline 1.1

Supprimez un nombre spécifié de lignes d’une table, à partir d’un index donné. Cette méthode renvoie l’erreur InsertDeleteConflict si un filtre est appliqué à la table sur laquelle la méthode est appelée.

deleteRowsAt(index: number, count?: number): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiOnline 1.1

Obtient le nombre de lignes dans le tableau.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

Jeu d’API : ExcelApi 1.4

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

Notez que, contrairement aux plages ou colonnes, qui s’ajustent si de nouvelles lignes ou colonnes sont ajoutées avant elles, un TableRow objet représente l’emplacement physique de la ligne du tableau, mais pas les données. En d’autres termes, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de tableau continue à pointer vers l’index pour lequel elle a été créée.

getItemAt(index: number): Excel.TableRow;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => {
    const tablerow = context.workbook.tables.getItem('Table1').rows.getItemAt(0);
    tablerow.load('values');
    await context.sync();
    console.log(tablerow.values);
});

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

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

Paramètres

Retours

Exemples

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

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

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

Retours