Partager via


Word.HtmlDivision class

Extends

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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.

htmlDivisions
leftIndent

Spécifie la valeur de retrait gauche (en points) pour cette division HTML.

range

Obtient un Range objet qui représente la partie d’un document contenue dans cette division HTML.

rightIndent

Spécifie le retrait droit (en points) pour cette division HTML.

spaceAfter

Spécifie la quantité d’espacement (en points) après cette division HTML.

spaceBefore

Spécifie l’espacement (en points) avant cette division HTML.

Méthodes

delete()

Supprime cette division HTML.

htmlDivisionParent(levelsUp)

Renvoie un HtmlDivision objet qui représente une division parente de la division HTML actuelle.

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.HtmlDivision est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.HtmlDivisionDataque ) 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é

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é

htmlDivisions

readonly htmlDivisions: Word.HtmlDivisionCollection;

Valeur de propriété

leftIndent

Spécifie la valeur de retrait gauche (en points) pour cette division HTML.

leftIndent: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

range

Obtient un Range objet qui représente la partie d’un document contenue dans cette division HTML.

readonly range: Word.Range;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

rightIndent

Spécifie le retrait droit (en points) pour cette division HTML.

rightIndent: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

spaceAfter

Spécifie la quantité d’espacement (en points) après cette division HTML.

spaceAfter: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

spaceBefore

Spécifie l’espacement (en points) avant cette division HTML.

spaceBefore: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Détails de la méthode

delete()

Supprime cette division HTML.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

htmlDivisionParent(levelsUp)

Renvoie un HtmlDivision objet qui représente une division parente de la division HTML actuelle.

htmlDivisionParent(levelsUp?: number): Word.HtmlDivision;

Paramètres

levelsUp

number

Facultatif. Nombre de niveaux à monter pour récupérer la division parente.

Retours

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.HtmlDivisionLoadOptions): Word.HtmlDivision;

Paramètres

options
Word.Interfaces.HtmlDivisionLoadOptions

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

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

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

toJSON(): Word.Interfaces.HtmlDivisionData;

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

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

Retours