Word.Table class

Représente un tableau dans un document Word.

Remarques

Utilisateur

Exemples

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

await Word.run(async (context) => {
  // Use a two-dimensional array to hold the initial table values.
  const data = [
    ["Tokyo", "Beijing", "Seattle"],
    ["Apple", "Orange", "Pineapple"]
  ];
  const table: Word.Table = context.document.body.insertTable(2, 3, "Start", data);
  table.styleBuiltIn = Word.BuiltInStyleName.gridTable5Dark_Accent2;
  table.styleFirstColumn = false;

  await context.sync();
});

Propriétés

alignment	Spécifie l’alignement du tableau par rapport à la colonne de la page. La valeur peut être `left`, `centered`, ou `right`.
columns	Renvoie l’objet `TableColumnCollection` qui représente les colonnes de la table.
context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
description	Spécifie la description de la table.
endnotes	Obtient la collection des notes de fin dans le tableau.
fields	Obtient la collection d’objets `Field` de la table.
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.
footnotes	Obtient la collection de notes de bas de page dans le tableau.
headerRowCount	Spécifie le nombre de lignes d’en-tête.
horizontalAlignment	Spécifie l’alignement horizontal de chaque cellule du tableau. La valeur peut être `left`, `centered`, `right`ou `justified`.
isUniform	Indique si toutes les lignes du tableau sont uniformes.
nestingLevel	Obtient le niveau d’imbrication du tableau. Les tableaux de niveau supérieur ont le niveau 1.
parentBody	Obtient le corps parent du tableau.
parentContentControl	Obtient le contrôle de contenu qui contient le tableau. Génère une `ItemNotFound` erreur s’il n’existe pas de contrôle de contenu parent.
parentContentControlOrNullObject	Obtient le contrôle de contenu qui contient le tableau. S’il n’existe pas de contrôle de contenu parent, 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.
parentTable	Obtient le tableau qui contient ce tableau. Génère une `ItemNotFound` erreur si elle n’est pas contenue dans une table.
parentTableCell	Obtient la cellule de tableau qui contient ce tableau. Génère une `ItemNotFound` erreur si elle n’est pas contenue dans une cellule de tableau.
parentTableCellOrNullObject	Obtient la cellule de tableau qui contient ce tableau. S’il n’est pas contenu dans une cellule de tableau, cette méthode renvoie un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
parentTableOrNullObject	Obtient le tableau qui contient ce tableau. S’il n’est pas contenu dans une table, cette méthode renvoie un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
rowCount	Obtient le nombre de lignes dans le tableau.
rows	Obtient toutes les lignes du tableau.
shading	Renvoie l’objet `ShadingUniversal` qui représente l’ombrage de la table.
shadingColor	Spécifie la couleur d’ombrage. La couleur est spécifiée au format « #RRVVBB » ou par son nom de couleur.
style	Spécifie le nom du style du tableau. Utilisez cette propriété pour les noms des styles personnalisés et localisés. Pour utiliser les styles prédéfinis qui sont portables entre différents paramètres régionaux, voir la propriété « styleBuiltIn ».
styleBandedColumns	Indique si la table comporte des colonnes à bandes.
styleBandedRows	Indique si la table comporte des lignes à bandes.
styleBuiltIn	Spécifie le nom du style intégré pour la table. Utilisez cette propriété pour les styles intégrés qui sont portables entre les paramètres régionaux. Pour utiliser des styles personnalisés ou des noms de style localisés, consultez la propriété « style ».
styleFirstColumn	Indique si le tableau comporte une première colonne avec un style spécial.
styleLastColumn	Indique si le tableau comporte une dernière colonne avec un style spécial.
styleTotalRow	Indique si le tableau comporte une ligne de total (dernière) avec un style particulier.
tables	Obtient les tableaux enfants imbriqués au niveau de profondeur suivant.
title	Spécifie le titre de la table.
values	Spécifie les valeurs de texte dans la table, sous la forme d’un tableau JavaScript 2D.
verticalAlignment	Spécifie l’alignement vertical de chaque cellule du tableau. La valeur peut être `top`, `center`, ou `bottom`.
width	Spécifie la largeur du tableau en points.

Méthodes

addColumns(insertLocation, columnCount, values)	Ajoute des colonnes au début ou à la fin du tableau, en utilisant la première ou la dernière colonne existante en tant que modèle. Applicable aux tableaux uniformes. Si spécifiées, les valeurs de chaîne sont définies sur les lignes nouvellement insérées.
addRows(insertLocation, rowCount, values)	Ajoute des lignes au début ou à la fin du tableau, en utilisant la première ou la dernière ligne existante en tant que modèle. Si spécifiées, les valeurs de chaîne sont définies sur les lignes nouvellement insérées.
applyStyleDirectFormatting(styleName)	Applique le style spécifié, mais conserve toute mise en forme directement appliquée par un utilisateur.
autoFitBehavior(behavior)	Détermine la façon dont Microsoft Word redimensionne un tableau lorsque la fonction Ajustement automatique est utilisée.
autoFitBehavior(behavior)	Détermine la façon dont Microsoft Word redimensionne un tableau lorsque la fonction Ajustement automatique est utilisée.
autoFitWindow()	Ajuste automatiquement les colonnes du tableau à la largeur de la fenêtre.
autoFormat(options)	Permet d'appliquer un aspect prédéfini à un tableau.
clear()	Efface le contenu du tableau.
convertToText(options)	Convertit un tableau en texte.
delete()	Supprime le tableau entier.
deleteColumns(columnIndex, columnCount)	Supprime des colonnes spécifiques. Applicable aux tableaux uniformes.
deleteRows(rowIndex, rowCount)	Supprime des lignes spécifiques.
distributeColumns()	Répartit uniformément les largeurs de colonne. Applicable aux tableaux uniformes.
getBorder(borderLocation)	Obtient le style de la bordure spécifiée.
getBorder(borderLocation)	Obtient le style de la bordure spécifiée.
getCell(rowIndex, cellIndex)	Obtient la cellule du tableau à une ligne et une colonne spécifiées. Génère une `ItemNotFound` erreur si la cellule de tableau spécifiée n’existe pas.
getCellOrNullObject(rowIndex, cellIndex)	Obtient la cellule du tableau à une ligne et une colonne spécifiées. Si la cellule de tableau spécifiée n’existe pas, 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.
getCellPadding(cellPaddingLocation)	Obtient la marge intérieure des cellules en points.
getCellPadding(cellPaddingLocation)	Obtient la marge intérieure des cellules en points.
getNext()	Obtient le tableau suivant. Génère une `ItemNotFound` erreur si cette table est la dernière.
getNextOrNullObject()	Obtient le tableau suivant. Si cette table 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.
getParagraphAfter()	Obtient le paragraphe après le tableau. Génère une `ItemNotFound` erreur s’il n’y a pas de paragraphe après le tableau.
getParagraphAfterOrNullObject()	Obtient le paragraphe après le tableau. S’il n’y a pas de paragraphe après le tableau, 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.
getParagraphBefore()	Obtient le paragraphe avant le tableau. Génère une `ItemNotFound` erreur s’il n’y a pas de paragraphe avant le tableau.
getParagraphBeforeOrNullObject()	Obtient le paragraphe avant le tableau. S’il n’y a pas de paragraphe avant le tableau, 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.
getRange(rangeLocation)	Obtient la plage qui contient ce tableau, ou la plage située au début ou à la fin du tableau.
insertContentControl()	Insère un contrôle de contenu dans le tableau.
insertParagraph(paragraphText, insertLocation)	Insère un paragraphe à l’emplacement spécifié.
insertTable(rowCount, columnCount, insertLocation, values)	Insère un tableau avec le nombre spécifié de lignes et de colonnes.
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.
mergeCells(topRow, firstCell, bottomRow, lastCell)	Fusionne les cellules délimitées inclusivement par une première et une dernière cellule.
reapplyAutoFormat()	Mises à jour de la table avec les caractéristiques du format de table prédéfini lors de l’appel de la `autoFormat` méthode. Le format prédéfini par défaut est TableFormatType.none.
search(searchText, searchOptions)	Effectue une recherche avec les options de recherche spécifiées sur l’étendue de l’objet `Table` . Les résultats de la recherche sont une collection d’objets `Range` .
select(selectionMode)	Sélectionne le tableau ou la position de début ou de fin du tableau et y accède dans l’interface utilisateur de Word.
select(selectionMode)	Sélectionne le tableau ou la position de début ou de fin du tableau et y accède dans l’interface utilisateur de Word.
set(properties, options)	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)	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(cellPaddingLocation, cellPadding)	Définit la marge intérieure des cellules en points.
sort(options)	Trie le contenu du tableau spécifié
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.Table` est un objet API, la `toJSON` méthode renvoie un objet JavaScript simple (typé ) `Word.Interfaces.TableData`qui contient des copies superficielles de toutes les propriétés enfants chargées à partir 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 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.
untrack()	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.

alignment

Spécifie l’alignement du tableau par rapport à la colonne de la page. La valeur peut être left, centered, ou right.

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

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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(
    `Details about the alignment of the first table:`,
    `- Alignment of the table within the containing page column: ${firstTable.alignment}`,
    `- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`,
    `- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`,
  );
});

columns

Renvoie l’objet TableColumnCollection qui représente les colonnes de la table.

readonly columns: Word.TableColumnCollection;

Valeur de propriété

Word.TableColumnCollection

Remarques

Jeu d’API : WordApiDesktop 1.4

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é

Word.RequestContext

description

Spécifie la description de la table.

description: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApiDesktop 1.4

endnotes

Obtient la collection des notes de fin dans le tableau.

readonly endnotes: Word.NoteItemCollection;

Valeur de propriété

Word.NoteItemCollection

Remarques

Jeu d’API : WordApi 1.5

fields

Obtient la collection d’objets Field de la table.

readonly fields: Word.FieldCollection;

Valeur de propriété

Word.FieldCollection

Remarques

Jeu 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

Jeu d’API : WordApi 1.3

footnotes

Obtient la collection de notes de bas de page dans le tableau.

readonly footnotes: Word.NoteItemCollection;

Valeur de propriété

Word.NoteItemCollection

Remarques

Jeu d’API : WordApi 1.5

headerRowCount

Spécifie le nombre de lignes d’en-tête.

headerRowCount: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApi 1.3

horizontalAlignment

Spécifie l’alignement horizontal de chaque cellule du tableau. 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

Exemples

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

// Gets alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(
    `Details about the alignment of the first table:`,
    `- Alignment of the table within the containing page column: ${firstTable.alignment}`,
    `- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`,
    `- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`,
  );
});

isUniform

Indique si toutes les lignes du tableau sont uniformes.

readonly isUniform: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.3

nestingLevel

Obtient le niveau d’imbrication du tableau. Les tableaux de niveau supérieur ont le niveau 1.

readonly nestingLevel: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApi 1.3

parentBody

Obtient le corps parent du tableau.

readonly parentBody: Word.Body;

Valeur de propriété

Word.Body

Remarques

Jeu d’API : WordApi 1.3

parentContentControl

Obtient le contrôle de contenu qui contient le tableau. Génère une ItemNotFound erreur s’il n’existe pas de contrôle de contenu parent.

readonly parentContentControl: Word.ContentControl;

Valeur de propriété

Word.ContentControl

Remarques

Jeu d’API : WordApi 1.3

parentContentControlOrNullObject

Obtient le contrôle de contenu qui contient le tableau. S’il n’existe pas de contrôle de contenu parent, 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.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valeur de propriété

Word.ContentControl

Remarques

Jeu d’API : WordApi 1.3

parentTable

Obtient le tableau qui contient ce tableau. Génère une ItemNotFound erreur si elle n’est pas contenue dans une table.

readonly parentTable: Word.Table;

Valeur de propriété

Word.Table

Remarques

Jeu d’API : WordApi 1.3

parentTableCell

Obtient la cellule de tableau qui contient ce tableau. Génère une ItemNotFound erreur si elle n’est pas contenue dans une cellule de tableau.

readonly parentTableCell: Word.TableCell;

Valeur de propriété

Word.TableCell

Remarques

Jeu d’API : WordApi 1.3

parentTableCellOrNullObject

Obtient la cellule de tableau qui contient ce tableau. S’il n’est pas contenu dans une cellule de tableau, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valeur de propriété

Word.TableCell

Remarques

Jeu d’API : WordApi 1.3

parentTableOrNullObject

Obtient le tableau qui contient ce tableau. S’il n’est pas contenu dans une table, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

readonly parentTableOrNullObject: Word.Table;

Valeur de propriété

Word.Table

Remarques

Jeu d’API : WordApi 1.3

rowCount

Obtient le nombre de lignes dans le tableau.

readonly rowCount: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApi 1.3

rows

Obtient toutes les lignes du tableau.

readonly rows: Word.TableRowCollection;

Valeur de propriété

Word.TableRowCollection

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 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();
  firstTableRow.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

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

shading

Renvoie l’objet ShadingUniversal qui représente l’ombrage de la table.

readonly shading: Word.ShadingUniversal;

Valeur de propriété

Word.ShadingUniversal

Remarques

Jeu d’API : WordApiDesktop 1.4

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

Jeu d’API : WordApi 1.3

style

Spécifie le nom du style du tableau. Utilisez cette propriété pour les noms des styles personnalisés et localisés. Pour utiliser les styles prédéfinis qui sont portables entre différents paramètres régionaux, voir la propriété « styleBuiltIn ».

style: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApi 1.3

styleBandedColumns

Indique si la table comporte des colonnes à bandes.

styleBandedColumns: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.3

styleBandedRows

Indique si la table comporte des lignes à bandes.

styleBandedRows: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.3

styleBuiltIn

Spécifie le nom du style intégré pour la table. Utilisez cette propriété pour les styles intégrés qui sont portables entre les paramètres régionaux. Pour utiliser des styles personnalisés ou des noms de style localisés, consultez la propriété « style ».

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

styleFirstColumn

Indique si le tableau comporte une première colonne avec un style spécial.

styleFirstColumn: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.3

styleLastColumn

Indique si le tableau comporte une dernière colonne avec un style spécial.

styleLastColumn: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.3

styleTotalRow

Indique si le tableau comporte une ligne de total (dernière) avec un style particulier.

styleTotalRow: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.3

tables

Obtient les tableaux enfants imbriqués au niveau de profondeur suivant.

readonly tables: Word.TableCollection;

Valeur de propriété

Word.TableCollection

Remarques

Jeu d’API : WordApi 1.3

title

Spécifie le titre de la table.

title: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApiDesktop 1.4

values

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

values: string[][];

Valeur de propriété

string[][]

Remarques

Jeu d’API : WordApi 1.3

verticalAlignment

Spécifie l’alignement vertical de chaque cellule du tableau. 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

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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(
    `Details about the alignment of the first table:`,
    `- Alignment of the table within the containing page column: ${firstTable.alignment}`,
    `- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`,
    `- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`,
  );
});

width

Spécifie la largeur du tableau en points.

width: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApi 1.3

addColumns(insertLocation, columnCount, values)

Ajoute des colonnes au début ou à la fin du tableau, en utilisant la première ou la dernière colonne existante en tant que modèle. Applicable aux tableaux uniformes. Si spécifiées, les valeurs de chaîne sont définies sur les lignes nouvellement insérées.

addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void;

Paramètres

insertLocation: start | end | "Start" | "End"

Il doit être start ou end, correspondant au côté approprié du tableau.

columnCount: number

Nombre de colonnes à ajouter.

values: string[][]

Tableau 2D facultatif. Les cellules sont remplies si les chaînes correspondantes sont spécifiées dans le tableau.

Retours

void

Remarques

Jeu d’API : WordApi 1.3

addRows(insertLocation, rowCount, values)

Ajoute des lignes au début ou à la fin du tableau, en utilisant la première ou la dernière ligne existante en tant que modèle. Si spécifiées, les valeurs de chaîne sont définies sur les lignes nouvellement insérées.

addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;

Paramètres

insertLocation: start | end | "Start" | "End"

Il doit être start ou end.

rowCount: number

Nombre de lignes à ajouter.

values: string[][]

Tableau 2D facultatif. Les cellules sont remplies si les chaînes correspondantes sont spécifiées dans le tableau.

Retours

Word.TableRowCollection

Remarques

Jeu d’API : WordApi 1.3

applyStyleDirectFormatting(styleName)

Applique le style spécifié, mais conserve toute mise en forme directement appliquée par un utilisateur.

applyStyleDirectFormatting(styleName: string): void;

Paramètres

styleName: string

Nom du style à appliquer.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

autoFitBehavior(behavior)

Détermine la façon dont Microsoft Word redimensionne un tableau lorsque la fonction Ajustement automatique est utilisée.

autoFitBehavior(behavior: Word.AutoFitBehavior): void;

Paramètres

behavior: Word.AutoFitBehavior

Type de redimensionnement appliqué par Word au tableau spécifié avec la fonction Ajustement automatique activée.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

autoFitBehavior(behavior)

Détermine la façon dont Microsoft Word redimensionne un tableau lorsque la fonction Ajustement automatique est utilisée.

autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void;

Paramètres

behavior: "FixedSize" | "Content" | "Window"

Type de redimensionnement appliqué par Word au tableau spécifié avec la fonction Ajustement automatique activée.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

autoFitWindow()

Ajuste automatiquement les colonnes du tableau à la largeur de la fenêtre.

autoFitWindow(): void;

Retours

void

Remarques

Jeu d’API : WordApi 1.3

autoFormat(options)

Permet d'appliquer un aspect prédéfini à un tableau.

autoFormat(options?: Word.TableAutoFormatOptions): void;

Paramètres

options: Word.TableAutoFormatOptions

Facultatif. Objet qui spécifie les options d’application du format de tableau.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

clear()

Efface le contenu du tableau.

clear(): void;

Retours

void

Remarques

Jeu d’API : WordApi 1.3

convertToText(options)

Convertit un tableau en texte.

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

Paramètres

options: Word.TableConvertToTextOptions

Facultatif. Objet qui spécifie les options de conversion du tableau en texte.

Retours

Word.Range

Objet Range représentant le texte converti.

Remarques

Jeu d’API : WordApiDesktop 1.4

delete()

Supprime le tableau entier.

delete(): void;

Retours

void

Remarques

Jeu d’API : WordApi 1.3

deleteColumns(columnIndex, columnCount)

Supprime des colonnes spécifiques. Applicable aux tableaux uniformes.

deleteColumns(columnIndex: number, columnCount?: number): void;

Paramètres

columnIndex: number

La première colonne à supprimer.

columnCount: number

Facultatif. Nombre de colonnes à supprimer. Valeur par défaut 1.

Retours

void

Remarques

Jeu d’API : WordApi 1.3

deleteRows(rowIndex, rowCount)

Supprime des lignes spécifiques.

deleteRows(rowIndex: number, rowCount?: number): void;

Paramètres

rowIndex: number

Première ligne à supprimer.

rowCount: number

Facultatif. Nombre de lignes à supprimer. Valeur par défaut 1.

Retours

void

Remarques

Jeu d’API : WordApi 1.3

distributeColumns()

Répartit uniformément les largeurs de colonne. Applicable aux tableaux uniformes.

distributeColumns(): void;

Retours

void

Remarques

Jeu d’API : WordApi 1.3

getBorder(borderLocation)

Obtient le style de la bordure spécifiée.

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

Paramètres

borderLocation: Word.BorderLocation

L’emplacement de la frontière.

Retours

Word.TableBorder

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 table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const borderLocation = Word.BorderLocation.top;
  const border: Word.TableBorder = firstTable.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

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

getBorder(borderLocation)

Obtient le style de la bordure spécifiée.

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

Paramètres

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

L’emplacement de la frontière.

Retours

Word.TableBorder

Remarques

Jeu d’API : WordApi 1.3

getCell(rowIndex, cellIndex)

Obtient la cellule du tableau à une ligne et une colonne spécifiées. Génère une ItemNotFound erreur si la cellule de tableau spécifiée n’existe pas.

getCell(rowIndex: number, cellIndex: number): Word.TableCell;

Paramètres

rowIndex: number

Index de la ligne.

cellIndex: number

Index de la cellule dans la ligne.

Retours

Word.TableCell

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/table-cell-access.yaml

// Gets the content of the first cell in the first table.
await Word.run(async (context) => {
  const firstCell: Word.Body = context.document.body.tables.getFirst().getCell(0, 0).body;
  firstCell.load("text");

  await context.sync();
  console.log("First cell's text is: " + firstCell.text);
});

getCellOrNullObject(rowIndex, cellIndex)

Obtient la cellule du tableau à une ligne et une colonne spécifiées. Si la cellule de tableau spécifiée n’existe pas, 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.

getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell;

Paramètres

rowIndex: number

Index de la ligne.

cellIndex: number

Index de la cellule dans la ligne.

Retours

Word.TableCell

Remarques

Jeu 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

L’emplacement du remplissage de la cellule doit être top,left , bottom, ou .right

Retours

OfficeExtension.ClientResult<number>

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 table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const cellPaddingLocation = Word.CellPaddingLocation.right;
  const cellPadding = firstTable.getCellPadding(cellPaddingLocation);
  await context.sync();

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

getCellPadding(cellPaddingLocation)

Obtient la marge intérieure des cellules en points.

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

Paramètres

cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;

Paramètres

rangeLocation: whole | start | end | after | "Whole" | "Start" | "End" | "After"

Facultatif. L’emplacement de la plage doit être whole,start ,end ou .after

Retours

Word.Range

Remarques

Jeu d’API : WordApi 1.3

insertContentControl()

Insère un contrôle de contenu dans le tableau.

insertContentControl(): Word.ContentControl;

Retours

Word.ContentControl

Remarques

Jeu d’API : WordApi 1.3

insertParagraph(paragraphText, insertLocation)

Insère un paragraphe à l’emplacement spécifié.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

Paramètres

paragraphText: string

Texte de paragraphe à insérer.

insertLocation: before | after | "Before" | "After"

La valeur doit être before ou after.

Retours

Word.Paragraph

Remarques

Jeu d’API : WordApi 1.3

insertTable(rowCount, columnCount, insertLocation, values)

Insère un tableau avec le nombre spécifié de lignes et de colonnes.

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

Paramètres

rowCount: number

Nombre de lignes du tableau.

columnCount: number

Nombre de colonnes du tableau.

insertLocation: before | after | "Before" | "After"

La valeur doit être before ou after.

values: string[][]

Tableau 2D facultatif. Les cellules sont remplies si les chaînes correspondantes sont spécifiées dans le tableau.

Retours

Word.Table

Remarques

Jeu 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.TableLoadOptions): Word.Table;

Paramètres

options: Word.Interfaces.TableLoadOptions

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

Retours

Word.Table

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

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

Word.Table

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

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

mergeCells(topRow, firstCell, bottomRow, lastCell)

Fusionne les cellules délimitées inclusivement par une première et une dernière cellule.

mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell;

Paramètres

topRow: number

Ligne de la première cellule.

firstCell: number

Index de la première cellule de sa ligne.

bottomRow: number

Ligne de la dernière cellule.

lastCell: number

Index de la dernière cellule de sa ligne.

Retours

Word.TableCell

Remarques

Jeu d’API : WordApi 1.4

reapplyAutoFormat()

Mises à jour de la table avec les caractéristiques du format de table prédéfini lors de l’appel de la autoFormat méthode. Le format prédéfini par défaut est TableFormatType.none.

reapplyAutoFormat(): void;

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

search(searchText, searchOptions)

Effectue une recherche avec les options de recherche spécifiées sur l’étendue de l’objet Table . 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

searchText: string

Texte de recherche.

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

Facultatif. Options de la recherche.

Retours

Word.RangeCollection

Remarques

Jeu d’API : WordApi 1.3

select(selectionMode)

Sélectionne le tableau ou la position de début ou de fin du tableau et y accède dans l’interface utilisateur de Word.

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

Paramètres

selectionMode: Word.SelectionMode

Facultatif. Le mode de sélection doit être select, start, ou end. select est la valeur par défaut.

Retours

void

Remarques

Jeu d’API : WordApi 1.3

select(selectionMode)

Sélectionne le tableau ou la position de début ou de fin du tableau et y accède dans l’interface utilisateur de Word.

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

Paramètres

selectionMode: "Select" | "Start" | "End"

Facultatif. Le mode de sélection doit être select, start, ou end. select est la valeur par défaut.

Retours

void

Remarques

Jeu d’API : WordApi 1.3

set(properties, options)

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

Paramètres

properties: Word.Interfaces.TableUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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.Table): void;

Paramètres

properties: Word.Table

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

L’emplacement du remplissage de la cellule doit être top,left , bottom, ou .right

cellPadding: number

Remplissage de cellule.

Retours

void

Remarques

Jeu d’API : WordApi 1.3

setCellPadding(cellPaddingLocation, cellPadding)

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

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

Paramètres

cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"

L’emplacement du remplissage de la cellule doit être top,left , bottom, ou .right

cellPadding: number

Remplissage de cellule.

Retours

void

Remarques

Jeu d’API : WordApi 1.3

sort(options)

Trie le contenu du tableau spécifié

sort(options?: Word.TableSortOptions): void;

Paramètres

options: Word.TableSortOptions

Facultatif. Objet qui spécifie les options de tri de la table.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

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

toJSON(): Word.Interfaces.TableData;

Retours

Word.Interfaces.TableData

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

Retours

Word.Table

untrack()

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

Retours

Word.Table

Remarques

Utilisateur

Exemples

Propriétés

Méthodes

Détails de la propriété

alignment

Valeur de propriété

Remarques

Exemples

columns

Valeur de propriété

Remarques

context

Valeur de propriété

description

Valeur de propriété

Remarques

endnotes

Valeur de propriété

Remarques

fields

Valeur de propriété

Remarques

font

Valeur de propriété

Remarques

footnotes

Valeur de propriété

Remarques

headerRowCount

Valeur de propriété

Remarques

horizontalAlignment

Valeur de propriété

Remarques

Exemples

isUniform

Valeur de propriété

Remarques

nestingLevel

Valeur de propriété

Remarques

parentBody

Valeur de propriété

Remarques

parentContentControl

Valeur de propriété

Remarques

parentContentControlOrNullObject

Valeur de propriété

Remarques

parentTable

Valeur de propriété

Remarques

parentTableCell

Valeur de propriété

Remarques

parentTableCellOrNullObject

Valeur de propriété

Remarques

parentTableOrNullObject

Valeur de propriété

Remarques

rowCount

Valeur de propriété

Remarques

rows

Valeur de propriété

Remarques

Exemples

shading

Valeur de propriété

Remarques

shadingColor

Valeur de propriété

Remarques

style

Valeur de propriété