Word.TableRow class

Obtient le nombre de cellules dans la ligne.

readonly cellCount: number;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Obtient les cellules.

readonly cells: Word.TableCellCollection;

Valeur de propriété

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 content alignment details about the first cell 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 firstCell: Word.TableCell = firstTableRow.cells.getFirst();
  firstCell.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(
    `Details about the alignment of the first table's first cell:`,
    `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`,
    `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`,
  );
});

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 la collection des notes de fin dans la ligne du tableau.

readonly endnotes: Word.NoteItemCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.5

Obtient la collection d’objets dans la ligne du Field tableau.

readonly fields: Word.FieldCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.4

Obtient la police. Utilisez cette propriété pour obtenir et définir le nom de la police, la taille, la couleur et d’autres propriétés.

readonly font: Word.Font;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Obtient la collection de notes de bas de page dans la ligne du tableau.

readonly footnotes: Word.NoteItemCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.5

Spécifie l’alignement horizontal de chaque cellule de la ligne. La valeur peut être left, centered, rightou justified.

horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Vérifie si la ligne est une ligne d’en-tête. Pour définir le nombre de lignes d’en-tête, utilisez headerRowCount sur l’objet Table .

readonly isHeader: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Obtient la table parente.

readonly parentTable: Word.Table;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Spécifie la hauteur préférée de la ligne en points.

preferredHeight: number;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Renvoie l’objet Range qui représente la ligne du tableau.

readonly range: Word.Range;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient l’index de la ligne dans le tableau parent correspondant.

readonly rowIndex: number;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Renvoie l’objet ShadingUniversal qui représente l’ombrage de la ligne du tableau.

readonly shading: Word.ShadingUniversal;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Spécifie la couleur d’ombrage. La couleur est spécifiée au format « #RRVVBB » ou par son nom de couleur.

shadingColor: string;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Spécifie les valeurs de texte dans la ligne, sous la forme d’un tableau JavaScript 2D.

values: string[][];

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Spécifie l’alignement vertical des cellules dans la ligne. La valeur peut être top, center, ou bottom.

verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Efface le contenu de la ligne.

clear(): void;

Retours

Remarques

Jeu d’API : WordApi 1.3

Convertit la ligne du tableau en texte.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Supprime la ligne entière.

delete(): void;

Retours

Remarques

Jeu d’API : WordApi 1.3

Obtient le style de bordure des cellules de la ligne.

getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;

Paramètres

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 le style de bordure des cellules de la ligne.

getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.3

Obtient la marge intérieure des cellules en points.

getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;

Paramètres

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 cell padding 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 cellPaddingLocation = Word.CellPaddingLocation.bottom;
  const cellPadding = firstTableRow.getCellPadding(cellPaddingLocation);
  await context.sync();

  console.log(
    `Cell padding details about the ${cellPaddingLocation} border of the first table's first row: ${cellPadding.value} points`,
  );
});

Obtient la marge intérieure des cellules en points.

getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.3

Obtient la ligne suivante. Génère une ItemNotFound erreur si cette ligne est la dernière.

getNext(): Word.TableRow;

Retours

Remarques

Jeu d’API : WordApi 1.3

Obtient la ligne suivante. Si cette ligne est la dernière, 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.

getNextOrNullObject(): Word.TableRow;

Retours

Remarques

Jeu d’API : WordApi 1.3

Insère un contrôle de contenu sur la ligne.

insertContentControl(): Word.ContentControl;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.1

Insère des lignes en utilisant cette ligne en tant que modèle. Si les valeurs sont spécifiées, insère les valeurs sur de nouvelles lignes.

insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;

Paramètres

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

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

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?: {
            select?: string;
            expand?: string;
        }): Word.TableRow;

Paramètres

Retours

Fusionne la ligne en une cellule.

merge(): Word.TableCell;

Retours

Remarques

Jeu d’API : WordApi 1.4

Effectue une recherche avec les options de recherche spécifiées sur l’étendue de la ligne. Les résultats de la recherche sont une collection d’objets Range .

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.3

Sélectionne la ligne et y accède via l’interface utilisateur de Word.

select(selectionMode?: Word.SelectionMode): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.3

Sélectionne la ligne et y accède via l’interface utilisateur de Word.

select(selectionMode?: "Select" | "Start" | "End"): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.3

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.TableRow): void;

Paramètres

Retours

Définit la marge intérieure des cellules en points.

setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.3

Définit la marge intérieure des cellules en points.

setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.3

Définit la hauteur de la ligne.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Définit la hauteur de la ligne.

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.TableRow est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.TableRowDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.TableRowData;

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

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

Retours