Word.Table class

Référence

Paquet:: word

Représente un tableau dans un document Word.

Extends: OfficeExtension.ClientObject

Remarques

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 de la table par rapport à la colonne de page. La valeur peut être « Left », « Centered » ou « Right ».
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
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.
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 retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés 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. Si elle n’est pas contenue 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 OrNullObject.
parentTableOrNullObject	Obtient le tableau qui contient ce tableau. Si elle n’est pas contenue dans une table, 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.
rowCount	Obtient le nombre de lignes dans le tableau.
rows	Obtient toutes les lignes du tableau.
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 de style de la table. 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	Spécifie si la table comporte des colonnes à bandes.
styleBandedRows	Spécifie si la table comporte des lignes à bandes.
styleBuiltIn	Spécifie le nom de 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	Spécifie si la table a une première colonne avec un style spécial.
styleLastColumn	Spécifie si la table a une dernière colonne avec un style spécial.
styleTotalRow	Spécifie si la table a un total (dernière) ligne avec un style spécial.
tables	Obtient les tableaux enfants imbriqués au niveau de profondeur suivant.
values	Spécifie les valeurs de texte dans le tableau, 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.
autoFitWindow()	Ajuste automatiquement les colonnes du tableau à la largeur de la fenêtre.
clear()	Efface le contenu du tableau.
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(borderLocationString)	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 retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getCellPadding(cellPaddingLocation)	Obtient la marge intérieure des cellules en points.
getCellPadding(cellPaddingLocationString)	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 retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés 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 la 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 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 la table, 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.
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.
search(searchText, searchOptions)	Effectue une recherche avec l’objet SearchOptions spécifié dans l’étendue de l’objet table. Les résultats de la recherche sont un ensemble d’objets de plage.
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(selectionModeString)	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 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.Table` est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (typé en tant `Word.Interfaces.TableData`que ) 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é

alignment

Spécifie l’alignement de la table par rapport à la colonne de page. La valeur peut être « Left », « Centered » ou « Right ».

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

Valeur de propriété

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

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

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 ]

headerRowCount

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

headerRowCount: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

horizontalAlignment

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

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

Valeur de propriété

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

[ Ensemble 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

[ Ensemble d’API : WordApi 1.3 ]

parentBody

Obtient le corps parent du tableau.

readonly parentBody: Word.Body;

Valeur de propriété

Word.Body

Remarques

[ Ensemble 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

[ Ensemble 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 retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valeur de propriété

Word.ContentControl

Remarques

[ Ensemble 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

[ Ensemble 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

[ Ensemble d’API : WordApi 1.3 ]

parentTableCellOrNullObject

Obtient la cellule de tableau qui contient ce tableau. Si elle n’est pas contenue 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 OrNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valeur de propriété

Word.TableCell

Remarques

[ Ensemble d’API : WordApi 1.3 ]

parentTableOrNullObject

Obtient le tableau qui contient ce tableau. Si elle n’est pas contenue dans une table, 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.

readonly parentTableOrNullObject: Word.Table;

Valeur de propriété

Word.Table

Remarques

[ Ensemble d’API : WordApi 1.3 ]

rowCount

Obtient le nombre de lignes dans le tableau.

readonly rowCount: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

rows

Obtient toutes les lignes du tableau.

readonly rows: Word.TableRowCollection;

Valeur de propriété

Word.TableRowCollection

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

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 ]

style

Spécifie le nom de style de la table. 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

[ Ensemble d’API : WordApi 1.3 ]

styleBandedColumns

Spécifie si la table comporte des colonnes à bandes.

styleBandedColumns: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.3 ]

styleBandedRows

Spécifie si la table comporte des lignes à bandes.

styleBandedRows: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.3 ]

styleBuiltIn

Spécifie le nom de 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

[ Ensemble d’API : WordApi 1.3 ]

styleFirstColumn

Spécifie si la table a une première colonne avec un style spécial.

styleFirstColumn: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.3 ]

styleLastColumn

Spécifie si la table a une dernière colonne avec un style spécial.

styleLastColumn: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.3 ]

styleTotalRow

Spécifie si la table a un total (dernière) ligne avec un style spécial.

styleTotalRow: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble d’API : WordApi 1.3 ]

values

Spécifie les valeurs de texte dans le tableau, 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 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

[ 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 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

[ Ensemble d’API : WordApi 1.3 ]

Détails de la méthode

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"

Obligatoire. Il doit être « Start » ou « End », correspondant au côté approprié de la table.

columnCount: number

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

[ Ensemble 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"

Obligatoire. Il doit être « Début » ou « Fin ».

rowCount: number

Obligatoire. Nombre de lignes à ajouter.

values: string[][]

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

Paramètres

columnIndex: number

Obligatoire. Première colonne à supprimer.

columnCount: number

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

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

deleteRows(rowIndex, rowCount)

Supprime des lignes spécifiques.

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

Paramètres

rowIndex: number

Obligatoire. Première ligne à supprimer.

rowCount: number

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

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

distributeColumns()

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

distributeColumns(): void;

Retours

void

Remarques

[ Ensemble 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

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 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(borderLocationString)

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

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 ]

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

Obligatoire. Index de la ligne.

cellIndex: number

Obligatoire. Index de la cellule dans la ligne.

Retours

Word.TableCell

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/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 retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

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

Paramètres

rowIndex: number

Obligatoire. Index de la ligne.

cellIndex: number

Obligatoire. Index de la cellule dans la ligne.

Retours

Word.TableCell

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 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(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"

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"

Optional. L’emplacement de la plage doit être « Entier », « Début », « Fin » ou « Après ».

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.3 ]

insertContentControl()

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

insertContentControl(): Word.ContentControl;

Retours

Word.ContentControl

Remarques

[ Ensemble 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

Obligatoire. Texte de paragraphe à insérer.

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

Obligatoire. La valeur doit être « Before » ou « After ».

Retours

Word.Paragraph

Remarques

[ Ensemble 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

Obligatoire. Nombre de lignes dans le tableau.

columnCount: number

Obligatoire. Nombre de colonnes dans le tableau.

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

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

[ 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.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 qui spécifient 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

search(searchText, searchOptions)

Effectue une recherche avec l’objet SearchOptions spécifié dans l’étendue de l’objet table. 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 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

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 le tableau ou la position de début ou de fin du tableau et y accède dans 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.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties: Word.Interfaces.TableUpdateData

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

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

Retours

Word.Table

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

Retours

Word.Table

Partager via

Word.Table class

Remarques

Exemples

Propriétés

Méthodes

Détails de la propriété

alignment

Valeur de propriété

Remarques

Exemples

context

Valeur de propriété

font

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

shadingColor

Valeur de propriété

Remarques

style

Valeur de propriété

Remarques

styleBandedColumns

Valeur de propriété

Remarques

styleBandedRows

Valeur de propriété

Remarques

styleBuiltIn

Valeur de propriété

Remarques

styleFirstColumn

Valeur de propriété

Remarques

styleLastColumn

Valeur de propriété

Remarques

styleTotalRow

Valeur de propriété