Word.TableRow class

Paquet:

word

Représente une ligne dans un document Word.

Extends

OfficeExtension.ClientObject

Remarques

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

Propriétés

cellCount	Obtient le nombre de cellules dans la ligne.
cells	Obtient les cellules.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
fields	Obtient la collection d’objets de champ dans la ligne du tableau.
font	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.
horizontalAlignment	Spécifie l’alignement horizontal de chaque cellule de la ligne. La valeur peut être « Left », « Centered », « Right » ou « Justified ».
isHeader	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.
parentTable	Obtient la table parente.
preferredHeight	Spécifie la hauteur préférée de la ligne en points.
rowIndex	Obtient l’index de la ligne dans le tableau parent correspondant.
shadingColor	Spécifie la couleur d’ombrage. La couleur est spécifiée au format « #RRVVBB » ou par son nom de couleur.
values	Spécifie les valeurs de texte dans la ligne, sous la forme d’un tableau JavaScript 2D.
verticalAlignment	Spécifie l’alignement vertical des cellules de la ligne. La valeur peut être « Top », « Center » ou « Bottom ».

Méthodes

clear()	Efface le contenu de la ligne.
delete()	Supprime la ligne entière.
getBorder(borderLocation)	Obtient le style de bordure des cellules de la ligne.
getBorder(borderLocationString)	Obtient le style de bordure des cellules de la ligne.
getCellPadding(cellPaddingLocation)	Obtient la marge intérieure des cellules en points.
getCellPadding(cellPaddingLocationString)	Obtient la marge intérieure des cellules en points.
getNext()	Obtient la ligne suivante. Génère une ItemNotFound erreur si cette ligne est la dernière.
getNextOrNullObject()	Obtient la ligne suivante. Si cette ligne est la dernière, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
insertRows(insertLocation, rowCount, values)	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.
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.
merge()	Fusionne la ligne dans une cellule.
search(searchText, searchOptions)	Effectue une recherche avec les SearchOptions spécifiées dans l’étendue de la ligne. Les résultats de la recherche sont un ensemble d’objets de plage.
select(selectionMode)	Sélectionne la ligne et y accède via l’interface utilisateur de Word.
select(selectionModeString)	Sélectionne la ligne et y accède via l’interface utilisateur de Word.
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.
setCellPadding(cellPaddingLocation, cellPadding)	Définit la marge intérieure des cellules en points.
setCellPadding(cellPaddingLocationString, cellPadding)	Définit la marge intérieure des cellules en points.
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 Word.TableRow est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableRowDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
track()	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 sur 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 suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()	Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour 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 mise en production de la mémoire ne prenne effet.

Détails de la propriété

cellCount

Obtient le nombre de cellules dans la ligne.

readonly cellCount: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

cells

Obtient les cellules.

readonly cells: Word.TableCellCollection;

Valeur de propriété

Word.TableCellCollection

Remarques

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

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é

Word.RequestContext

fields

Obtient la collection d’objets de champ dans la ligne du tableau.

readonly fields: Word.FieldCollection;

Valeur de propriété

Word.FieldCollection

Remarques

[ Ensemble d’API : WordApi 1.4 ]

font

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é

Word.Font

Remarques

[ Ensemble d’API : WordApi 1.3 ]

horizontalAlignment

Spécifie l’alignement horizontal de chaque cellule de la ligne. La valeur peut être « Left », « Centered », « Right » ou « Justified ».

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

Valeur de propriété

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

Remarques

[ Ensemble d’API : WordApi 1.3 ]

isHeader

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é

boolean

Remarques

[ Ensemble d’API : WordApi 1.3 ]

parentTable

Obtient la table parente.

readonly parentTable: Word.Table;

Valeur de propriété

Word.Table

Remarques

[ Ensemble d’API : WordApi 1.3 ]

preferredHeight

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

preferredHeight: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

rowIndex

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

readonly rowIndex: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

shadingColor

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é

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

values

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

values: string[][];

Valeur de propriété

string[][]

Remarques

[ Ensemble d’API : WordApi 1.3 ]

verticalAlignment

Spécifie l’alignement vertical des cellules de la ligne. La valeur peut être « Top », « Center » ou « Bottom ».

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

Valeur de propriété

Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Détails de la méthode

clear()

Efface le contenu de la ligne.

clear(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

delete()

Supprime la ligne entière.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getBorder(borderLocation)

Obtient le style de bordure des cellules de la ligne.

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

Paramètres

borderLocation

Word.BorderLocation

Obligatoire. Emplacement de la bordure.

Retours

Word.TableBorder

Remarques

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

getBorder(borderLocationString)

Obtient le style de bordure des cellules de la ligne.

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

Paramètres

borderLocationString

"Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"

Obligatoire. Emplacement de la bordure.

Retours

Word.TableBorder

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getCellPadding(cellPaddingLocation)

Obtient la marge intérieure des cellules en points.

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

Paramètres

cellPaddingLocation

Word.CellPaddingLocation

Obligatoire. L’emplacement de remplissage des cellules doit être « Top », « Left », « Bottom » ou « Right ».

Retours

OfficeExtension.ClientResult<number>

Remarques

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

getCellPadding(cellPaddingLocationString)

Obtient la marge intérieure des cellules en points.

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

Paramètres

cellPaddingLocationString

"Top" | "Left" | "Bottom" | "Right"

Obligatoire. L’emplacement de remplissage des cellules doit être « Top », « Left », « Bottom » ou « Right ».

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getNext()

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

getNext(): Word.TableRow;

Retours

Word.TableRow

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getNextOrNullObject()

Obtient la ligne suivante. Si cette ligne est la dernière, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getNextOrNullObject(): Word.TableRow;

Retours

Word.TableRow

Remarques

[ Ensemble d’API : WordApi 1.3 ]

insertRows(insertLocation, rowCount, values)

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

insertLocation

before | after | "Before" | "After"

Obligatoire. Où les nouvelles lignes doivent être insérées, par rapport à la ligne actuelle. Il doit être « Avant » ou « Après ».

rowCount

number

Obligatoire. Nombre de lignes à ajouter

values

string[][]

Optional. Chaînes à insérer dans les nouvelles lignes, spécifiées en tant que tableau 2D. Le nombre de cellules dans chaque ligne ne doit pas dépasser le nombre de cellules de la ligne existante.

Retours

Word.TableRowCollection

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

Paramètres

options

Word.Interfaces.TableRowLoadOptions

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

Retours

Word.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[]): Word.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

Word.TableRow

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

Word.TableRow

merge()

Fusionne la ligne dans une cellule.

merge(): Word.TableCell;

Retours

Word.TableCell

Remarques

[ Ensemble d’API : WordApi 1.4 ]

search(searchText, searchOptions)

Effectue une recherche avec les SearchOptions spécifiées dans l’étendue de la ligne. Les résultats de la recherche sont un ensemble d’objets de plage.

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

Paramètres

searchText

string

Obligatoire. Texte de recherche.

searchOptions

Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Optional. Options de la recherche.

Retours

Word.RangeCollection

Remarques

[ Ensemble d’API : WordApi 1.3 ]

select(selectionMode)

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

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

Paramètres

selectionMode

Word.SelectionMode

Optional. Le mode de sélection doit être « Select », « Start » ou « End ». « Select » (sélectionner) est la valeur par défaut.

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

select(selectionModeString)

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

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

Paramètres

selectionModeString

"Select" | "Start" | "End"

Optional. Le mode de sélection doit être « Select », « Start » ou « End ». « Select » (sélectionner) est la valeur par défaut.

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

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

Paramètres

properties

Word.TableRow

Retours

void

setCellPadding(cellPaddingLocation, cellPadding)

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

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

Paramètres

cellPaddingLocation

Word.CellPaddingLocation

Obligatoire. L’emplacement de remplissage des cellules doit être « Top », « Left », « Bottom » ou « Right ».

cellPadding

number

Obligatoire. Remplissage de cellule.

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

setCellPadding(cellPaddingLocationString, cellPadding)

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

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

Paramètres

cellPaddingLocationString

"Top" | "Left" | "Bottom" | "Right"

Obligatoire. L’emplacement de remplissage des cellules doit être « Top », « Left », « Bottom » ou « Right ».

cellPadding

number

Obligatoire. Remplissage de cellule.

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

toJSON(): Word.Interfaces.TableRowData;

Retours

Word.Interfaces.TableRowData

track()

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 sur 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 suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.TableRow;

Retours

Word.TableRow

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour 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 mise en production de la mémoire ne prenne effet.

untrack(): Word.TableRow;

Retours

Word.TableRow