Word.TableCell class
Représente une cellule de tableau dans un document Word.
- Extends
Remarques
[ Ensemble d’API : WordApi 1.3 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});
Propriétés
body | Renvoie l’objet corps de la cellule. |
cell |
Obtient l’index de la cellule dans la ligne correspondante. |
column |
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. |
horizontal |
Spécifie l’alignement horizontal de la cellule. La valeur peut être « Left », « Centered », « Right » ou « Justified ». |
parent |
Obtient la ligne parent de la cellule. |
parent |
Obtient le tableau parent de la cellule. |
row |
Obtient l’index de la ligne de la cellule dans le tableau. |
shading |
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. |
vertical |
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
delete |
Supprime la colonne qui contient cette cellule. Applicable aux tableaux uniformes. |
delete |
Supprime la ligne qui contient cette cellule. |
get |
Obtient le style de la bordure spécifiée. |
get |
Obtient le style de la bordure spécifiée. |
get |
Obtient la marge intérieure des cellules en points. |
get |
Obtient la marge intérieure des cellules en points. |
get |
Obtient la cellule suivante. Génère une |
get |
Obtient la cellule suivante. Si cette cellule est la dernière, cette méthode retourne un objet avec sa |
insert |
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. |
insert |
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 |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
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. |
set |
Définit la marge intérieure des cellules en points. |
set |
Définit la marge intérieure des cellules en points. |
split(row |
Fractionne la cellule en nombre spécifié de lignes et de colonnes. |
toJSON() | Remplace la méthode JavaScript |
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 |
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 |
Détails de la propriété
body
Renvoie l’objet corps de la cellule.
readonly body: Word.Body;
Valeur de propriété
Remarques
cellIndex
Obtient l’index de la cellule dans la ligne correspondante.
readonly cellIndex: number;
Valeur de propriété
number
Remarques
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
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é
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: 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}`);
});
parentRow
Obtient la ligne parent de la cellule.
readonly parentRow: Word.TableRow;
Valeur de propriété
Remarques
parentTable
Obtient le tableau parent de la cellule.
readonly parentTable: Word.Table;
Valeur de propriété
Remarques
rowIndex
Obtient l’index de la ligne de la cellule dans le tableau.
readonly rowIndex: number;
Valeur de propriété
number
Remarques
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
value
Spécifie le texte de la cellule.
value: string;
Valeur de propriété
string
Remarques
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: 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}`);
});
width
Obtient la largeur de la cellule en points.
readonly width: number;
Valeur de propriété
number
Remarques
Détails de la méthode
deleteColumn()
Supprime la colonne qui contient cette cellule. Applicable aux tableaux uniformes.
deleteColumn(): void;
Retours
void
Remarques
deleteRow()
Supprime la ligne qui contient cette cellule.
deleteRow(): void;
Retours
void
Remarques
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
Remarques
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
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`);
});
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
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: 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`
);
});
getNext()
Obtient la cellule suivante. Génère une ItemNotFound
erreur si cette cellule est la dernière.
getNext(): Word.TableCell;
Retours
Remarques
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
Remarques
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
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
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
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
Remarques
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
Fournit des options pour les propriétés de l’objet à charger.
Retours
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
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
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
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
split(rowCount, columnCount)
Fractionne la cellule en nombre spécifié de lignes et de colonnes.
split(rowCount: number, columnCount: number): void;
Paramètres
- rowCount
-
number
Obligatoire. Nombre de lignes à fractionner. Doit être un diviseur du nombre de lignes sous-jacentes.
- columnCount
-
number
Obligatoire. Nombre de colonnes à fractionner.
Retours
void
Remarques
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.TableCell
est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableCellData
que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Word.Interfaces.TableCellData;
Retours
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
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;