Word.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é

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

readonly items: Word.TableRow[];

Valeur de propriété

Convertit les lignes d’un tableau en texte.

convertToText(options?: Word.TableConvertToTextOptions): Word.Range;

Paramètres

Retours

Objet Range représentant le texte converti.

Remarques

Jeu d’API : WordApiDesktop 1.4

Supprime les lignes du tableau.

delete(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Ajuste la hauteur des lignes pour les rendre égales.

distributeHeight(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient la première ligne de cette collection. Génère une ItemNotFound erreur si cette collection est vide.

getFirst(): Word.TableRow;

Retours

Remarques

Jeu d’API : WordApi 1.3

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets border details about the first row of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  const borderLocation = Word.BorderLocation.bottom;
  const border: Word.TableBorder = firstTableRow.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

  console.log(
    `Details about the ${borderLocation} border of the first table's first row:`,
    `- Color: ${border.color}`,
    `- Type: ${border.type}`,
    `- Width: ${border.width} points`,
  );
});

Obtient la première ligne de cette collection. Si cette collection est vide, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getFirstOrNullObject(): Word.TableRow;

Retours

Remarques

Jeu d’API : WordApi 1.3

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?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.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[]): Word.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(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableRowCollection;

Paramètres

Retours

Sélectionne les lignes du tableau.

select(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Définit la hauteur des cellules d’un tableau.

setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Définit la hauteur des cellules d’un tableau.

setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Définit le retrait à gauche de la ligne du tableau.

setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Définit le retrait à gauche de la ligne du tableau.

setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

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

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.TableRowCollection;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Word.TableRowCollection;

Retours