Visio.Page class
Représente la classe Page.
- Extends
Remarques
Utilisateur
Propriétés
| all |
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. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| height | Renvoie la hauteur de la page. |
| index | Index de l’objet Page. |
| is |
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 |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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. |
| toJSON() | Remplace la méthode JavaScript |
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é
Remarques
comments
Renvoie la collection de commentaires.
readonly comments: Visio.CommentCollection;Valeur de propriété
Remarques
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
height
Renvoie la hauteur de la page.
readonly height: number;Valeur de propriété
number
Remarques
index
isBackground
Indique s’il s’agit d’une page d’arrière-plan ou non.
readonly isBackground: boolean;Valeur de propriété
boolean
Remarques
name
shapes
Toutes les formes de niveau supérieur dans la Page.
readonly shapes: Visio.ShapeCollection;Valeur de propriété
Remarques
view
Renvoie l’affichage de la page.
readonly view: Visio.PageView;Valeur de propriété
Remarques
width
Renvoie la largeur de la page.
readonly width: number;Valeur de propriété
number
Remarques
Détails de la méthode
activate()
Définit la page comme page active du document.
activate(): void;Retours
void
Remarques
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
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 spécifiant 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;
}): 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
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Visio.Interfaces.PageUpdateData
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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
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 Visio.Page d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé Visio.Interfaces.PageData) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Visio.Interfaces.PageData;