Partager via


Word.TabStop class

Représente un taquet de tabulation dans un document Word.

Extends

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Propriétés

alignment

Obtient une TabAlignment valeur qui représente l’alignement du taquet de tabulation.

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

customTab

Obtient si ce taquet de tabulation est un taquet de tabulation personnalisé.

leader

Obtient une TabLeader valeur qui représente le leader de cet TabStop objet.

next

Obtient le taquet de tabulation suivant dans la collection.

position

Obtient la position du taquet de tabulation par rapport à la marge de gauche.

previous

Obtient le taquet de tabulation précédent dans la collection.

Méthodes

clear()

Supprime ce taquet de tabulation personnalisé.

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(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(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.

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

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.

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.

Détails de la propriété

alignment

Obtient une TabAlignment valeur qui représente l’alignement du taquet de tabulation.

readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List";

Valeur de propriété

Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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é

customTab

Obtient si ce taquet de tabulation est un taquet de tabulation personnalisé.

readonly customTab: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

leader

Obtient une TabLeader valeur qui représente le leader de cet TabStop objet.

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

Valeur de propriété

Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

next

Obtient le taquet de tabulation suivant dans la collection.

readonly next: Word.TabStop;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

position

Obtient la position du taquet de tabulation par rapport à la marge de gauche.

readonly position: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

previous

Obtient le taquet de tabulation précédent dans la collection.

readonly previous: Word.TabStop;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Détails de la méthode

clear()

Supprime ce taquet de tabulation personnalisé.

clear(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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.TabStopLoadOptions): Word.TabStop;

Paramètres

options
Word.Interfaces.TabStopLoadOptions

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

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

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

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

toJSON(): Word.Interfaces.TabStopData;

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

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

Retours