Visio.Page class

Paquet:

visio

Représente la classe Page.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : 1.1 ]

Propriétés

allShapes	Toutes les formes de la page, y compris les sous-formes.
comments	Renvoie la collection de commentaires.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
height	Renvoie la hauteur de la page.
index	Index de l’objet Page.
isBackground	Indique s’il s’agit d’une page d’arrière-plan ou non.
name	Nom de la page.
shapes	Toutes les formes de niveau supérieur dans la page.
view	Renvoie l’affichage de la page.
width	Renvoie la largeur de la page.

Méthodes

activate()	Définit la page comme Page active du document.
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.
set(properties, options)	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)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
setMockData(data)	Définir des données fictives
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Visio.Page d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Visio.Interfaces.PageDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

allShapes

Toutes les formes de la page, y compris les sous-formes.

readonly allShapes: Visio.ShapeCollection;

Valeur de propriété

Visio.ShapeCollection

Remarques

[ Ensemble d’API : 1.1 ]

comments

Renvoie la collection de commentaires.

readonly comments: Visio.CommentCollection;

Valeur de propriété

Visio.CommentCollection

Remarques

[ Ensemble d’API : 1.1 ]

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é

Visio.RequestContext

height

Renvoie la hauteur de la page.

readonly height: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : 1.1 ]

index

Index de l’objet Page.

readonly index: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : 1.1 ]

isBackground

Indique s’il s’agit d’une page d’arrière-plan ou non.

readonly isBackground: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : 1.1 ]

name

Nom de la page.

readonly name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

shapes

Toutes les formes de niveau supérieur dans la page.

readonly shapes: Visio.ShapeCollection;

Valeur de propriété

Visio.ShapeCollection

Remarques

[ Ensemble d’API : 1.1 ]

view

Renvoie l’affichage de la page.

readonly view: Visio.PageView;

Valeur de propriété

Visio.PageView

Remarques

[ Ensemble d’API : 1.1 ]

width

Renvoie la largeur de la page.

readonly width: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : 1.1 ]

Détails de la méthode

activate()

Définit la page comme Page active du document.

activate(): void;

Retours

void

Remarques

[ Ensemble d’API : 1.1 ]

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?: Visio.Interfaces.PageLoadOptions): Visio.Page;

Paramètres

options

Visio.Interfaces.PageLoadOptions

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

Retours

Visio.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[]): Visio.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

Visio.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;
        }): Visio.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

Visio.Page

set(properties, options)

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.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Visio.Interfaces.PageUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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: Visio.Page): void;

Paramètres

properties

Visio.Page

Retours

void

setMockData(data)

Définir des données fictives

setMockData(data: Visio.Interfaces.PageData): void;

Paramètres

data

Visio.Interfaces.PageData

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

toJSON(): Visio.Interfaces.PageData;

Retours

Visio.Interfaces.PageData