Word.TableOfFigures class
Représente une table de figures dans un document Word.
- Extends
Propriétés
| additional |
Obtient les styles supplémentaires utilisés pour le tableau des figures. Les styles par défaut « Titre 1 » à « Titre 9 » ne sont pas inclus dans cette collection. |
| are |
Indique si des styles de titre intégrés sont utilisés pour le tableau des figures. |
| are |
Indique si les champs Entrée de table des matières sont inclus dans la table des figures. |
| are |
Spécifie si les entrées du tableau des illustrations doivent être formatées sous forme de liens hypertexte lors de la publication sur le Web. |
| are |
Spécifie si les numéros de page du tableau des illustrations doivent être masqués lors de la publication sur le web. |
| are |
Indique si les numéros de page sont inclus dans le tableau des illustrations. |
| are |
Indique si les numéros de page sont alignés sur la marge de droite dans le tableau des illustrations. |
| caption |
Spécifie l’étiquette qui identifie les éléments à inclure dans le tableau des figures. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| is |
Indique si l’étiquette de légende et le numéro de légende sont inclus dans le tableau des illustrations. |
| lower |
Spécifie le niveau de titre de fin du tableau des figures. Doit être une valeur comprise entre 1 et 9 et supérieure à |
| range | Obtient la partie d’un document qui correspond à ce tableau de figures. |
| tab |
Spécifie le caractère entre les entrées et leurs numéros de page dans le tableau des figures. |
| table |
Spécifie un identificateur à une lettre des champs TC utilisé pour le tableau des figures. |
| upper |
Spécifie le niveau de titre de départ du tableau des illustrations. Doit être une valeur comprise entre 1 et 9 et inférieure à |
Méthodes
| delete() | Supprime ce tableau de figures. |
| 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 transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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. |
| 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 entre des |
| untrack() | Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 |
| update |
Mises à jour l’intégralité du tableau des figures. |
Détails de la propriété
additionalHeadingStyles
Obtient les styles supplémentaires utilisés pour le tableau des figures. Les styles par défaut « Titre 1 » à « Titre 9 » ne sont pas inclus dans cette collection.
readonly additionalHeadingStyles: Word.HeadingStyleCollection;Valeur de propriété
Remarques
areBuiltInHeadingStylesUsed
Indique si des styles de titre intégrés sont utilisés pour le tableau des figures.
areBuiltInHeadingStylesUsed: boolean;Valeur de propriété
boolean
Remarques
areFieldsUsed
Indique si les champs Entrée de table des matières sont inclus dans la table des figures.
areFieldsUsed: boolean;Valeur de propriété
boolean
Remarques
areHyperlinksUsedOnWeb
Spécifie si les entrées du tableau des illustrations doivent être formatées sous forme de liens hypertexte lors de la publication sur le Web.
areHyperlinksUsedOnWeb: boolean;Valeur de propriété
boolean
Remarques
arePageNumbersHiddenOnWeb
Spécifie si les numéros de page du tableau des illustrations doivent être masqués lors de la publication sur le web.
arePageNumbersHiddenOnWeb: boolean;Valeur de propriété
boolean
Remarques
arePageNumbersIncluded
Indique si les numéros de page sont inclus dans le tableau des illustrations.
arePageNumbersIncluded: boolean;Valeur de propriété
boolean
Remarques
arePageNumbersRightAligned
Indique si les numéros de page sont alignés sur la marge de droite dans le tableau des illustrations.
arePageNumbersRightAligned: boolean;Valeur de propriété
boolean
Remarques
captionLabel
Spécifie l’étiquette qui identifie les éléments à inclure dans le tableau des figures.
captionLabel: string;Valeur de propriété
string
Remarques
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
isLabelIncluded
Indique si l’étiquette de légende et le numéro de légende sont inclus dans le tableau des illustrations.
isLabelIncluded: boolean;Valeur de propriété
boolean
Remarques
lowerHeadingLevel
Spécifie le niveau de titre de fin du tableau des figures. Doit être une valeur comprise entre 1 et 9 et supérieure à upperHeadingLevel.
lowerHeadingLevel: number;Valeur de propriété
number
Remarques
range
Obtient la partie d’un document qui correspond à ce tableau de figures.
readonly range: Word.Range;Valeur de propriété
Remarques
tabLeader
Spécifie le caractère entre les entrées et leurs numéros de page dans le tableau des figures.
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";Valeur de propriété
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Remarques
tableId
Spécifie un identificateur à une lettre des champs TC utilisé pour le tableau des figures.
tableId: string;Valeur de propriété
string
Remarques
upperHeadingLevel
Spécifie le niveau de titre de départ du tableau des illustrations. Doit être une valeur comprise entre 1 et 9 et inférieure à lowerHeadingLevel.
upperHeadingLevel: number;Valeur de propriété
number
Remarques
Détails de la méthode
delete()
Supprime ce tableau de figures.
delete(): void;Retours
void
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.TableOfFiguresLoadOptions): Word.TableOfFigures;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.TableOfFigures;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant 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.TableOfFigures;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 transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties: Interfaces.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Word.Interfaces.TableOfFiguresUpdateData
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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.TableOfFigures): void;Paramètres
- properties
- Word.TableOfFigures
Retours
void
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.TableOfFigures est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.TableOfFiguresDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Word.Interfaces.TableOfFiguresData;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 entre 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 suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
track(): Word.TableOfFigures;Retours
untrack()
Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 libération de mémoire prenne effet.
untrack(): Word.TableOfFigures;Retours
updatePageNumbers()
Mises à jour l’intégralité du tableau des figures.
updatePageNumbers(): void;Retours
void