PowerPoint.TableRowCollection class

Représente un ensemble de lignes de tableau.

Extends

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.

items

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

Méthodes

add(index, count)

Ajoute une ou plusieurs lignes dans le tableau.

deleteRows(rows)

Supprime les lignes spécifiées de la collection.

getCount()

Obtient le nombre de lignes de la collection.

getItemAt(index)

Récupère la ligne à l’aide de son index de base zéro 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 PowerPoint.TableRowCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.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.

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é

items

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

readonly items: PowerPoint.TableRow[];

Valeur de propriété

Détails de la méthode

add(index, count)

Ajoute une ou plusieurs lignes dans le tableau.

add(index?: number | null | undefined, count?: number | undefined): void;

Paramètres

index

number | null | undefined

Facultatif. Spécifie l’index de base zéro dans lequel les nouvelles lignes sont ajoutées. Les lignes existantes commençant à l’emplacement de l’index sont déplacées vers le bas. Si la valeur d’index est indéfinie, nulle, -1 ou supérieure au nombre de lignes du tableau, les nouvelles lignes sont ajoutées à la fin du tableau.

count

number | undefined

Facultatif. Nombre de lignes à ajouter. Si la valeur est indéfinie ou 0, une seule ligne est ajoutée.

Retours

void

Remarques

Jeu d’API : PowerPointApi 1.9

deleteRows(rows)

Supprime les lignes spécifiées de la collection.

deleteRows(rows: PowerPoint.TableRow[]): void;

Paramètres

rows

PowerPoint.TableRow[]

Tableau d’objets TableRow représentant les lignes à supprimer.

Retours

void

Remarques

Jeu d’API : PowerPointApi 1.9

getCount()

Obtient le nombre de lignes de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Nombre de lignes dans la collection.

Remarques

Jeu d’API : PowerPointApi 1.9

getItemAt(index)

Récupère la ligne à l’aide de son index de base zéro dans la collection.

getItemAt(index: number): PowerPoint.TableRow;

Paramètres

index

number

Valeur d’index de la ligne à récupérer, sous la forme d’un index en base zéro.

Retours

Objet ligne.

Remarques

Jeu d’API : PowerPointApi 1.9

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

Paramètres

options

PowerPoint.Interfaces.TableRowCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Retours

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[]): PowerPoint.TableRowCollection;

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

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): PowerPoint.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

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

Retours