Word.TableOfContents class

Obtient les styles supplémentaires utilisés pour la table des matières. 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

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les styles de titre intégrés sont utilisés pour la table des matières.

areBuiltInHeadingStylesUsed: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les champs d’entrée de table des matières (TC) sont inclus dans la table des matières.

areFieldsUsed: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les entrées de la table des matières doivent être mises en forme en tant que liens hypertexte lors de la publication sur le web.

areHyperlinksUsedOnWeb: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les numéros de page de la table des matières doivent être masqués lors de la publication sur le web.

arePageNumbersHiddenOnWeb: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les numéros de page sont inclus dans la table des matières.

arePageNumbersIncluded: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les numéros de page sont alignés sur la marge de droite dans la table des matières.

arePageNumbersRightAligned: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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 le niveau de titre de fin pour la table des matières. Doit être une valeur comprise entre 1 et 9 et supérieure à upperHeadingLevel.

lowerHeadingLevel: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient la partie d’un document qui est cette table des matières.

readonly range: Word.Range;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le caractère entre les entrées et leurs numéros de page dans la table des matières.

tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie un identificateur à une lettre des champs TC utilisé pour la table des matières.

tableId: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le niveau de titre de départ de la table des matières. Doit être une valeur comprise entre 1 et 9 et inférieure à lowerHeadingLevel.

upperHeadingLevel: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime cette table des matières.

delete(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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.TableOfContentsLoadOptions): Word.TableOfContents;

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

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

Paramètres

Retours

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.TableOfContentsUpdateData, 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.TableOfContents): void;

Paramètres

Retours

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.TableOfContents est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableOfContentsDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.TableOfContentsData;

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

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

Retours

Mises à jour la table des matières entière.

updatePageNumbers(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]