Word.TableCell class

Obtient l’objet Body de la cellule.

readonly body: Word.Body;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

readonly cellIndex: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Renvoie l’objet TableColumn qui représente la colonne de table qui contient cette cellule.

readonly column: Word.TableColumn;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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

columnWidth: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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é

Spécifie l’alignement horizontal de la cellule. La valeur peut être left, centered, rightou 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 content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
  firstCell.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

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

Obtient la ligne parent de la cellule.

readonly parentRow: Word.TableRow;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Obtient le tableau parent de la cellule.

readonly parentTable: Word.Table;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

readonly rowIndex: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

readonly shading: Word.ShadingUniversal;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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é

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Spécifie le texte de la cellule.

value: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Spécifie l’alignement vertical de la cellule. La valeur peut être top, centerou bottom.

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

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

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

Obtient la largeur de la cellule en points.

readonly width: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Insère un champ = (Formule) qui calcule et affiche la somme des valeurs dans les cellules du tableau au-dessus ou à gauche de la cellule spécifiée dans l’expression.

autoSum(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime la cellule de tableau et contrôle éventuellement la façon dont les cellules restantes sont décalées.

delete(shiftCells: any): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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

deleteColumn(): void;

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Supprime la ligne qui contient cette cellule.

deleteRow(): void;

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Insère un champ = (Formule) qui contient la formule spécifiée dans une cellule de tableau.

formula(options?: Word.TableCellFormulaOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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

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

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

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

Paramètres

Retours

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: Word.Table = context.document.body.tables.getFirst();
  const firstCell: Word.TableCell = firstTable.getCell(0, 0);
  const borderLocation = "Left";
  const border: Word.TableBorder = 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`);
});

Obtient la marge intérieure des cellules en points.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Obtient la marge intérieure des cellules en points.

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

Paramètres

Retours

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: Word.Table = context.document.body.tables.getFirst();
  const firstCell: Word.TableCell = 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`
  );
});

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

getNext(): Word.TableCell;

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.TableCellLoadOptions): Word.TableCell;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.TableCell;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableCell;

Paramètres

Retours

Fusionne cette cellule de tableau avec la cellule de tableau spécifiée.

merge(mergeTo: Word.TableCell): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Sélectionne la cellule du tableau.

select(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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

Retours

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

Retours

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

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

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

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

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

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Fractionne la cellule en nombre spécifié de lignes et de colonnes.

split(rowCount: number, columnCount: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.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 de l’objet d’origine.

toJSON(): Word.Interfaces.TableCellData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet 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

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