Partager via

Excel.TableRowCollection class

  • Référence
Paquet:
excel

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

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 de table, mais pas les données. Autrement dit, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de table continue à pointer vers l’index pour lequel elle a été créée.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

context

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

Renvoie le nombre de lignes du tableau.
items

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

Méthodes

add(index, values, alwaysInsert)

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 de table, mais pas les données. Autrement dit, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de table continue à pointer vers l’index pour lequel elle a été créée.
addAsJson(index, values, alwaysInsert)

Ajoute une ou plusieurs lignes dans le tableau. L’objet retourné 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 d’image ou d’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 de table, mais pas les données. Autrement dit, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de table continue à pointer vers l’index pour lequel elle a été créée.
deleteRows(rows)

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

Supprimer un nombre spécifié de lignes d’une table, en commençant à un index donné. Cette méthode génère l’erreur InsertDeleteConflict si un filtre est appliqué à la table sur laquelle la méthode est appelée.
getCount()

Obtient le nombre de lignes dans le tableau.
getItemAt(index)

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 de table, mais pas les données. Autrement dit, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de table continue à pointer vers l’index pour lequel elle a été créée.
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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.TableRowCollectionDataque ) 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 . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

count

Renvoie le nombre de lignes du tableau.

readonly count: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

items

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

readonly items: Excel.TableRow[];

Valeur de propriété

Excel.TableRow[]

Détails de la méthode

add(index, values, alwaysInsert)

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 de table, mais pas les données. Autrement dit, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de table 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

index

number

Optional. Spécifie la position relative de la nouvelle ligne. Si la valeur est null ou -1, la ligne est ajoutée à la fin. Toutes les lignes en dessous de la ligne insérée sont déplacées vers le bas. Avec indice zéro.

values

Array<Array<boolean | string | number>> | boolean | string | number

Optional. Tableau 2D de valeurs non mises en forme de la ligne de table.

alwaysInsert

boolean

Optional. Spécifie si les nouvelles lignes seront insérées dans la table lors de l’ajout de nouvelles lignes. Si truela valeur est , les nouvelles lignes sont insérées dans la table. Si falsela valeur est , les nouvelles lignes sont ajoutées sous le tableau. La valeur par défaut est true.

Retours

Excel.TableRow

Remarques

[ Ensemble d’API : ExcelApi 1.1 pour l’ajout d’une seule ligne ; 1.4 autorise l’ajout de plusieurs lignes ; 1.15 pour l’ajout alwaysInsert d’un 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);
});

addAsJson(index, values, alwaysInsert)

Ajoute une ou plusieurs lignes dans le tableau. L’objet retourné 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 d’image ou d’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 de table, mais pas les données. Autrement dit, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de table continue à pointer vers l’index pour lequel elle a été créée.

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

Paramètres

index

number

Optional. Spécifie la position relative de la nouvelle ligne. Si la valeur est null ou -1, la ligne est ajoutée à la fin. Toutes les lignes en dessous de la ligne insérée sont déplacées vers le bas. Avec indice zéro.

values

Excel.CellValue[][]

Optional. Tableau 2D de valeurs de cellule de la ligne de tableau.

alwaysInsert

boolean

Optional. Spécifie si les nouvelles lignes seront insérées dans la table lors de l’ajout de nouvelles lignes. Si truela valeur est , les nouvelles lignes sont insérées dans la table. Si falsela valeur est , les nouvelles lignes sont ajoutées sous le tableau. La valeur par défaut est true.

Retours

Excel.TableRow

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

deleteRows(rows)

Supprimer plusieurs lignes d’une table. Ces lignes n’ont pas besoin d’être séquentielles. Cette méthode génère l’erreur InvalidArgument si une ligne choisie a déjà été supprimée ou n’existe pas. Cette méthode génère 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

rows

number[] | Excel.TableRow[]

Tableau de numéros d’index de ligne ou d’objets de ligne à supprimer de la table.

Retours

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

deleteRowsAt(index, count)

Supprimer un nombre spécifié de lignes d’une table, en commençant à un index donné. Cette méthode génère 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

index

number

Valeur d’index de la ligne à supprimer. Remarque : les index de ligne sont mis à jour chaque fois qu’une ligne précédente de la table est supprimée, après chaque opération de suppression. Vérifiez que l’index de la ligne que vous souhaitez supprimer n’a pas changé entre le moment où vous avez déterminé la valeur et le moment où vous exécutez l’opération.

count

number

Nombre de lignes à supprimer. Par défaut, une seule ligne est supprimée.

Retours

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

getCount()

Obtient le nombre de lignes dans le tableau.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

getItemAt(index)

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 de table, mais pas les données. Autrement dit, si les données sont triées ou si de nouvelles lignes sont ajoutées, une ligne de table continue à pointer vers l’index pour lequel elle a été créée.

getItemAt(index: number): Excel.TableRow;

Paramètres

index

number

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

Retours

Excel.TableRow

Remarques

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

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

Paramètres

options

Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retours

Excel.TableRowCollection

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

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

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

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

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

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

Retours

Excel.Interfaces.TableRowCollectionData