Partager via

Word.Page class

  • Référence
Paquet:
word

Représente une page dans le document. Page les objets gèrent la mise en page et le contenu.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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

Obtient la hauteur, en points, du papier défini dans la boîte de dialogue Mise en page.
index

Obtient l’index de la page. L’index de page est basé sur 1 et indépendant de la numérotation des pages personnalisée de l’utilisateur.
width

Obtient la largeur, en points, du papier défini dans la boîte de dialogue Mise en page.

Méthodes

getNext()

Obtient la page suivante dans le volet. Génère une ItemNotFound erreur si cette page est la dernière.
getNextOrNullObject()

Obtient la page suivante. Si cette page est la dernière, 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.
getRange(rangeLocation)

Obtient la page entière, ou le point de départ ou de fin de la page, sous forme de plage.
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.Page est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.PageDataque ) 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é

Word.RequestContext

height

Obtient la hauteur, en points, du papier défini dans la boîte de dialogue Mise en page.

readonly height: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

index

Obtient l’index de la page. L’index de page est basé sur 1 et indépendant de la numérotation des pages personnalisée de l’utilisateur.

readonly index: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

width

Obtient la largeur, en points, du papier défini dans la boîte de dialogue Mise en page.

readonly width: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Détails de la méthode

getNext()

Obtient la page suivante dans le volet. Génère une ItemNotFound erreur si cette page est la dernière.

getNext(): Word.Page;

Retours

Word.Page

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

getNextOrNullObject()

Obtient la page suivante. Si cette page est la dernière, 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.

getNextOrNullObject(): Word.Page;

Retours

Word.Page

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

getRange(rangeLocation)

Obtient la page entière, ou le point de départ ou de fin de la page, sous forme de plage.

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

Paramètres

rangeLocation

whole | start | end | "Whole" | "Start" | "End"

Facultatif. L’emplacement de la plage doit être « Entier », « Début » ou « Fin ».

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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.PageLoadOptions): Word.Page;

Paramètres

options
Word.Interfaces.PageLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.Page

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

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

Word.Page

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

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

Word.Page

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

toJSON(): Word.Interfaces.PageData;

Retours

Word.Interfaces.PageData

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

Retours

Word.Page

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

Retours

Word.Page