Word.TableCell class

Paquet:

word

Représente une cellule de tableau 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/table-cell-access.yaml

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

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

Propriétés

body	Renvoie l’objet corps de la cellule.
cellIndex	Obtient l’index de la cellule dans la ligne correspondante.
columnWidth	Spécifie la largeur de la colonne de la cellule en points. Applicable aux tableaux uniformes.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
horizontalAlignment	Spécifie l’alignement horizontal de la cellule. La valeur peut être « Left », « Centered », « Right » ou « Justified ».
parentRow	Obtient la ligne parent de la cellule.
parentTable	Obtient le tableau parent de la cellule.
rowIndex	Obtient l’index de la ligne de la cellule dans le tableau.
shadingColor	Spécifie la couleur d’ombrage de la cellule. La couleur est spécifiée au format « #RRVVBB » ou par son nom de couleur.
value	Spécifie le texte de la cellule.
verticalAlignment	Spécifie l’alignement vertical de la cellule. La valeur peut être « Top », « Center » ou « Bottom ».
width	Obtient la largeur de la cellule en points.

Méthodes

deleteColumn()	Supprime la colonne qui contient cette cellule. Applicable aux tableaux uniformes.
deleteRow()	Supprime la ligne qui contient cette cellule.
getBorder(borderLocation)	Obtient le style de la bordure spécifiée.
getBorder(borderLocationString)	Obtient le style de la bordure spécifiée.
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 cellule suivante. Génère une ItemNotFound erreur si cette cellule est la dernière.
getNextOrNullObject()	Obtient la cellule suivante. Si cette cellule 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.
insertColumns(insertLocation, columnCount, values)	Ajoute des colonnes à gauche ou à droite de la cellule, en utilisant la colonne de la cellule 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.
insertRows(insertLocation, rowCount, values)	Insère les lignes au-dessus ou au-dessous de la cellule, en utilisant la ligne de la cellule en tant que modèle. Si spécifiées, les valeurs de chaîne sont définies sur les lignes nouvellement insérées.
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.
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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet TableCell est un objet API. La toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableCellDataque ) 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 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é

body

Renvoie l’objet corps de la cellule.

readonly body: Word.Body;

Valeur de propriété

Word.Body

Remarques

[ Ensemble d’API : WordApi 1.3 ]

cellIndex

Obtient l’index de la cellule dans la ligne correspondante.

readonly cellIndex: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

columnWidth

Spécifie la largeur de la colonne de la cellule en points. Applicable aux tableaux uniformes.

columnWidth: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

horizontalAlignment

Spécifie l’alignement horizontal de la cellule. 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 ]

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 = context.document.body.tables.getFirst();
  const firstCell = firstTable.getCell(0, 0);
  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}`);
});

parentRow

Obtient la ligne parent de la cellule.

readonly parentRow: Word.TableRow;

Valeur de propriété

Word.TableRow

Remarques

[ Ensemble d’API : WordApi 1.3 ]

parentTable

Obtient le tableau parent de la cellule.

readonly parentTable: Word.Table;

Valeur de propriété

Word.Table

Remarques

[ Ensemble d’API : WordApi 1.3 ]

rowIndex

Obtient l’index de la ligne de la cellule dans le tableau.

readonly rowIndex: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

shadingColor

Spécifie la couleur d’ombrage de la cellule. 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 ]

value

Spécifie le texte de la cellule.

value: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

verticalAlignment

Spécifie l’alignement vertical de la cellule. 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 content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const firstCell = firstTable.getCell(0, 0);
  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}`);
});

width

Obtient la largeur de la cellule en points.

readonly width: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Détails de la méthode

deleteColumn()

Supprime la colonne qui contient cette cellule. Applicable aux tableaux uniformes.

deleteColumn(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

deleteRow()

Supprime la ligne qui contient cette cellule.

deleteRow(): 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 ]

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 ]

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 of the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const firstCell = firstTable.getCell(0, 0);
  const borderLocation = "Left";
  const border = firstCell.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

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

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 ]

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 ]

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 cell of the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const firstCell = firstTable.getCell(0, 0);
  const cellPaddingLocation = "Left";
  const cellPadding = firstCell.getCellPadding(cellPaddingLocation);
  await context.sync();

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

getNext()

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

getNext(): Word.TableCell;

Retours

Word.TableCell

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getNextOrNullObject()

Obtient la cellule suivante. Si cette cellule 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.TableCell;

Retours

Word.TableCell

Remarques

[ Ensemble d’API : WordApi 1.3 ]

insertColumns(insertLocation, columnCount, values)

Ajoute des colonnes à gauche ou à droite de la cellule, en utilisant la colonne de la cellule 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.

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

Paramètres

insertLocation

before | after | "Before" | "After"

Obligatoire. Il doit être « Avant » ou « Après ».

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 ]

insertRows(insertLocation, rowCount, values)

Insère les lignes au-dessus ou au-dessous de la cellule, en utilisant la ligne de la cellule en tant que modèle. Si spécifiées, les valeurs de chaîne sont définies sur les lignes nouvellement insérées.

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

Paramètres

insertLocation

before | after | "Before" | "After"

Obligatoire. Il doit être « Avant » ou « Après ».

rowCount

number

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

[ 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.TableCellLoadOptions): Word.TableCell;

Paramètres

options

Word.Interfaces.TableCellLoadOptions

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

Retours

Word.TableCell

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

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

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

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

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

Paramètres

properties

Word.Interfaces.TableCellUpdateData

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

Paramètres

properties

Word.TableCell

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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet TableCell est un objet API. La toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableCellDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.TableCellData;

Retours

Word.Interfaces.TableCellData

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

Retours

Word.TableCell

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

Retours

Word.TableCell