Visio.Document class
Représente la classe Document.
- Extends
Remarques
Propriétés
| application | Représente une instance de l’application Visio contenant ce document. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| pages | Représente une collection de pages associées au document. |
| view | Renvoie l’objet DocumentView. |
Méthodes
| get |
Renvoie la 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 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. |
| set |
Configure la page active du document. |
| set |
Définir des données fictives |
| show |
Affiche ou masque un TaskPane. Il sera consommé par le complément Excel DV/Autres applications tierces qui incorporent le dessin Visio pour afficher/masquer le volet Office. |
| show |
Affiche ou masque un TaskPane. Il sera consommé par le complément Excel DV/Autres applications tierces qui incorporent le dessin Visio pour afficher/masquer le volet Office. |
| start |
Déclenche l’actualisation des données dans le diagramme pour toutes les pages. |
| toJSON() | Remplace la méthode JavaScript |
Événements
| on |
Se produit lorsque les données sont actualisées dans le diagramme. |
| on |
Se produit lorsqu’une erreur attendue ou inattendue s’est produite dans la session. |
| on |
Se produit lorsque le document est chargé, actualisé ou modifié. |
| on |
Se produit lorsque le chargement de la page est terminé. |
| on |
Se produit lorsque la sélection actuelle des formes change. |
| on |
Se produit lorsque l’utilisateur déplace le pointeur de la souris dans le cadre englobant d’une forme. |
| on |
Se produit lorsque l’utilisateur déplace la souris hors du cadre englobant d’une forme. |
| on |
Se produit chaque fois qu’un état du volet Office est modifié. |
Détails de la propriété
application
Représente une instance de l’application Visio contenant ce document.
readonly application: Visio.Application;Valeur de propriété
Remarques
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é
pages
Représente une collection de pages associées au document.
readonly pages: Visio.PageCollection;Valeur de propriété
Remarques
Exemples
Visio.run(session, function (ctx) {
const pages = ctx.document.pages;
const pageCount = pages.getCount();
return ctx.sync().then(function () {
console.log("Pages Count: " +pageCount.value);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
view
Renvoie l’objet DocumentView.
readonly view: Visio.DocumentView;Valeur de propriété
Remarques
Détails de la méthode
getActivePage()
Renvoie la page active du document.
getActivePage(): Visio.Page;Retours
Remarques
Exemples
Visio.run(session, function (ctx) {
const document = ctx.document;
const activePage = document.getActivePage();
activePage.load("name");
return ctx.sync().then(function () {
console.log("pageName: " +activePage.name);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
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.DocumentLoadOptions): Visio.Document;Paramètres
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.Document;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;
}): Visio.Document;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 passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Visio.Interfaces.DocumentUpdateData
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.Document): void;Paramètres
- properties
- Visio.Document
Retours
void
setActivePage(PageName)
Configure la page active du document.
setActivePage(PageName: string): void;Paramètres
- PageName
-
string
Nom de la page
Retours
void
Remarques
Exemples
Visio.run(session, function (ctx) {
const document = ctx.document;
const pageName = "Page-1";
document.setActivePage(pageName);
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
setMockData(data)
Définir des données fictives
setMockData(data: Visio.Interfaces.DocumentData): void;Paramètres
Retours
void
showTaskPane(taskPaneType, initialProps, show)
Affiche ou masque un TaskPane. Il sera consommé par le complément Excel DV/Autres applications tierces qui incorporent le dessin Visio pour afficher/masquer le volet Office.
showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;Paramètres
- taskPaneType
- Visio.TaskPaneType
Type de l’élément TaskPane 1st Party. Il peut prendre des valeurs de l’énumération TaskPaneType
- initialProps
-
any
Paramètre facultatif. Il s’agit d’une structure de données générique qui serait remplie avec les données initiales requises pour initialiser le contenu du volet Office.
- show
-
boolean
Paramètre facultatif. S’il est défini sur false, il masque le volet Office spécifié.
Retours
void
Remarques
showTaskPane(taskPaneTypeString, initialProps, show)
Affiche ou masque un TaskPane. Il sera consommé par le complément Excel DV/Autres applications tierces qui incorporent le dessin Visio pour afficher/masquer le volet Office.
showTaskPane(taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;Paramètres
- taskPaneTypeString
-
"None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings"
Type de l’élément TaskPane 1st Party. Il peut prendre des valeurs de l’énumération TaskPaneType
- initialProps
-
any
Paramètre facultatif. Il s’agit d’une structure de données générique qui serait remplie avec les données initiales requises pour initialiser le contenu du volet Office.
- show
-
boolean
Paramètre facultatif. S’il est défini sur false, il masque le volet Office spécifié.
Retours
void
Remarques
startDataRefresh()
Déclenche l’actualisation des données dans le diagramme pour toutes les pages.
startDataRefresh(): void;Retours
void
Remarques
Exemples
Visio.run(session, function (ctx) {
const document = ctx.document;
document.startDataRefresh();
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
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.Document d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.DocumentDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Visio.Interfaces.DocumentData;Retours
Détails de l'événement
onDataRefreshComplete
Se produit lorsque les données sont actualisées dans le diagramme.
readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;Type d'événement
Remarques
onDocumentError
Se produit lorsqu’une erreur attendue ou inattendue s’est produite dans la session.
readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;Type d'événement
Remarques
onDocumentLoadComplete
Se produit lorsque le document est chargé, actualisé ou modifié.
readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;Type d'événement
Remarques
onPageLoadComplete
Se produit lorsque le chargement de la page est terminé.
readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;Type d'événement
Remarques
onSelectionChanged
Se produit lorsque la sélection actuelle des formes change.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;Type d'événement
Remarques
onShapeMouseEnter
Se produit lorsque l’utilisateur déplace le pointeur de la souris dans le cadre englobant d’une forme.
readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;Type d'événement
Remarques
onShapeMouseLeave
Se produit lorsque l’utilisateur déplace la souris hors du cadre englobant d’une forme.
readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;Type d'événement
Remarques
onTaskPaneStateChanged
Se produit chaque fois qu’un état du volet Office est modifié.
readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;Type d'événement
Remarques
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour