Word.TableCellCollection class
Contient la collection des Word du document. Objets TableCell.
- 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
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| auto |
Modifie la largeur d'une colonne d'un tableau pour s'adapter à la largeur du texte sans modifier l'habillage de texte dans les cellules. |
| delete(shift |
Supprime les cellules du tableau et contrôle éventuellement la façon dont les cellules restantes sont décalées. |
| delete(shift |
Supprime les cellules du tableau et contrôle éventuellement la façon dont les cellules restantes sont décalées. |
| distribute |
Affecte la même hauteur aux cellules spécifiées. |
| distribute |
Affecte la même largeur aux cellules spécifiées. |
| get |
Obtient la première cellule de tableau de cette collection. Génère une |
| get |
Obtient la première cellule de tableau de cette collection. Si cette collection est vide, cette méthode retourne un objet avec sa |
| 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 |
| merge() | Fusionne les cellules spécifiées en une seule cellule. |
| set |
Définit la hauteur des cellules d’un tableau. |
| set |
Définit la hauteur des cellules d’un tableau. |
| set |
Définit la largeur des cellules d’un tableau. |
| set |
Définit la largeur des cellules d’un tableau. |
| split(options) | Fractionne cette plage de cellules de tableau. |
| 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é
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é
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Word.TableCell[];Valeur de propriété
Détails de la méthode
autoFit()
Modifie la largeur d'une colonne d'un tableau pour s'adapter à la largeur du texte sans modifier l'habillage de texte dans les cellules.
autoFit(): void;Retours
void
Remarques
delete(shiftCells)
Supprime les cellules du tableau et contrôle éventuellement la façon dont les cellules restantes sont décalées.
delete(shiftCells?: Word.DeleteCells): void;Paramètres
- shiftCells
- Word.DeleteCells
Facultatif. Spécifie comment les cellules restantes sont décalées après la suppression. La valeur par défaut est shiftLeft.
Retours
void
Remarques
delete(shiftCells)
Supprime les cellules du tableau et contrôle éventuellement la façon dont les cellules restantes sont décalées.
delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void;Paramètres
- shiftCells
-
"ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"
Facultatif. Spécifie comment les cellules restantes sont décalées après la suppression. La valeur par défaut est shiftLeft.
Retours
void
Remarques
distributeHeight()
Affecte la même hauteur aux cellules spécifiées.
distributeHeight(): void;Retours
void
Remarques
distributeWidth()
Affecte la même largeur aux cellules spécifiées.
distributeWidth(): void;Retours
void
Remarques
getFirst()
Obtient la première cellule de tableau de cette collection. Génère une ItemNotFound erreur si cette collection est vide.
getFirst(): Word.TableCell;Retours
Remarques
getFirstOrNullObject()
Obtient la première cellule de tableau de cette collection. Si cette collection est vide, 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.
getFirstOrNullObject(): Word.TableCell;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.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection;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.TableCellCollection;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?: OfficeExtension.LoadOption): Word.TableCellCollection;Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
merge()
Fusionne les cellules spécifiées en une seule cellule.
merge(): void;Retours
void
Remarques
setHeight(rowHeight, heightRule)
Définit la hauteur des cellules d’un tableau.
setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;Paramètres
- rowHeight
-
number
Hauteur de la ligne à définir, en points.
- heightRule
- Word.RowHeightRule
Règle permettant de déterminer la hauteur des lignes spécifiées.
Retours
void
Remarques
setHeight(rowHeight, heightRule)
Définit la hauteur des cellules d’un tableau.
setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;Paramètres
- rowHeight
-
number
Hauteur de la ligne à définir, en points.
- heightRule
-
"Auto" | "AtLeast" | "Exactly"
Règle permettant de déterminer la hauteur des lignes spécifiées.
Retours
void
Remarques
setWidth(columnWidth, rulerStyle)
Définit la largeur des cellules d’un tableau.
setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;Paramètres
- columnWidth
-
number
Largeur de la ligne à définir, en points.
- rulerStyle
- Word.RulerStyle
Style de règle à appliquer.
Retours
void
Remarques
setWidth(columnWidth, rulerStyle)
Définit la largeur des cellules d’un tableau.
setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;Paramètres
- columnWidth
-
number
Largeur de la ligne à définir, en points.
- rulerStyle
-
"None" | "Proportional" | "FirstColumn" | "SameWidth"
Style de règle à appliquer.
Retours
void
Remarques
split(options)
Fractionne cette plage de cellules de tableau.
split(options?: Word.TableCellCollectionSplitOptions): void;Paramètres
Facultatif. Options de fractionnement des cellules du tableau.
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.TableCellCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableCellCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Word.Interfaces.TableCellCollectionData;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.TableCellCollection;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.TableCellCollection;