Visio.DocumentView class

Paquet:

visio

Représente la classe DocumentView.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : 1.1 ]

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.
disableHyperlinks	Désactiver les liens hypertexte.
disablePan	Désactiver le panoramique.
disablePanZoomWindow	Désactivez PanZoomWindow.
disableZoom	Désactiver le zoom.
hideDiagramBoundary	Masquer la limite du diagramme.

Méthodes

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

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é

Visio.RequestContext

disableHyperlinks

Désactiver les liens hypertexte.

disableHyperlinks: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : 1.1 ]

Exemples

Visio.run(session, function (ctx) {
    const documentView = ctx.document.view;
    documentView.disableHyperlinks();
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

disablePan

Désactiver le panoramique.

disablePan: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : 1.1 ]

disablePanZoomWindow

Désactivez PanZoomWindow.

disablePanZoomWindow: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : 1.1 ]

disableZoom

Désactiver le zoom.

disableZoom: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : 1.1 ]

hideDiagramBoundary

Masquer la limite du diagramme.

hideDiagramBoundary: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : 1.1 ]

Détails de la méthode

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

Paramètres

options

Visio.Interfaces.DocumentViewLoadOptions

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

Retours

Visio.DocumentView

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

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

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

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

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

Paramètres

properties

Visio.Interfaces.DocumentViewUpdateData

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.DocumentView): void;

Paramètres

properties

Visio.DocumentView

Retours

void

setMockData(data)

Définir des données fictives

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

Paramètres

data

Visio.Interfaces.DocumentViewData

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

toJSON(): Visio.Interfaces.DocumentViewData;

Retours

Visio.Interfaces.DocumentViewData