Partager via

Excel.TableRow class

  • Référence
Paquet:
excel

Représente une ligne dans un 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.
index

Renvoie le numéro d’indice de la ligne dans la collection de lignes du tableau. Avec indice zéro.
values

Représente les valeurs brutes de la plage spécifiée. Les données retournées peuvent être une chaîne, un nombre ou une valeur booléenne. Les cellules contenant une erreur renvoie la chaîne d’erreur. Si la valeur retournée commence par un signe plus (« + »), moins (« - ») ou égal (« = »), Excel interprète cette valeur comme une formule.
valuesAsJson

Représentation JSON des valeurs dans les cellules de cette ligne de tableau. Contrairement à TableRow.values, TableRow.valuesAsJson prend en charge tous les types de données qui peuvent se trouver dans une cellule. Les exemples incluent les valeurs numériques mises en forme et les images web, en plus des valeurs booléennes, numériques et de chaînes standard. Les données retournées par cette API s’alignent toujours sur les paramètres régionaux en-US. Pour récupérer des données dans les paramètres régionaux d’affichage de l’utilisateur, utilisez TableRow.valuesAsJsonLocal.
valuesAsJsonLocal

Représentation JSON des valeurs dans les cellules de cette ligne de tableau. Contrairement à TableRow.values, TableRow.valuesAsJsonLocal prend en charge tous les types de données qui peuvent se trouver dans une cellule. Les exemples incluent les valeurs numériques mises en forme et les images web, en plus des valeurs booléennes, numériques et de chaînes standard. Les données retournées par cette API s’alignent toujours sur les paramètres régionaux d’affichage de l’utilisateur. Pour récupérer des données indépendamment des paramètres régionaux, utilisez TableRow.valuesAsJson.

Méthodes

delete()

Supprime la ligne du tableau.
getRange()

Renvoie l’objet de plage associé à la ligne entière.
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.
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.TableRow est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.TableRowDataque ) 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é

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

index

Renvoie le numéro d’indice de la ligne dans la collection de lignes du tableau. Avec indice zéro.

readonly index: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

values

Représente les valeurs brutes de la plage spécifiée. Les données retournées peuvent être une chaîne, un nombre ou une valeur booléenne. Les cellules contenant une erreur renvoie la chaîne d’erreur. Si la valeur retournée commence par un signe plus (« + »), moins (« - ») ou égal (« = »), Excel interprète cette valeur comme une formule.

values: any[][];

Valeur de propriété

any[][]

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

valuesAsJson

Représentation JSON des valeurs dans les cellules de cette ligne de tableau. Contrairement à TableRow.values, TableRow.valuesAsJson prend en charge tous les types de données qui peuvent se trouver dans une cellule. Les exemples incluent les valeurs numériques mises en forme et les images web, en plus des valeurs booléennes, numériques et de chaînes standard. Les données retournées par cette API s’alignent toujours sur les paramètres régionaux en-US. Pour récupérer des données dans les paramètres régionaux d’affichage de l’utilisateur, utilisez TableRow.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Valeur de propriété

Excel.CellValue[][]

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

valuesAsJsonLocal

Représentation JSON des valeurs dans les cellules de cette ligne de tableau. Contrairement à TableRow.values, TableRow.valuesAsJsonLocal prend en charge tous les types de données qui peuvent se trouver dans une cellule. Les exemples incluent les valeurs numériques mises en forme et les images web, en plus des valeurs booléennes, numériques et de chaînes standard. Les données retournées par cette API s’alignent toujours sur les paramètres régionaux d’affichage de l’utilisateur. Pour récupérer des données indépendamment des paramètres régionaux, utilisez TableRow.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Valeur de propriété

Excel.CellValue[][]

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

Détails de la méthode

delete()

Supprime la ligne du tableau.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(2);
    row.delete();
    await context.sync(); 
});

getRange()

Renvoie l’objet de plage associé à la ligne entière.

getRange(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
    const rowRange = row.getRange();
    rowRange.load('address');
    await context.sync();
    
    console.log(rowRange.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.TableRowLoadOptions): Excel.TableRow;

Paramètres

options
Excel.Interfaces.TableRowLoadOptions

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

Retours

Excel.TableRow

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

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

Exemples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
    row.load('index');
    await context.sync();
    
    console.log(row.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?: {
            select?: string;
            expand?: string;
        }): Excel.TableRow;

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

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

Paramètres

properties
Excel.Interfaces.TableRowUpdateData

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.TableRow): void;

Paramètres

properties
Excel.TableRow

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.TableRow est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.TableRowDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.TableRowData;

Retours

Excel.Interfaces.TableRowData