Visio.Application class
Représente l’objet Application.
- Extends
Remarques
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. |
| show |
Affiche ou masque les bordures de l’application iframe. |
| show |
Affiche ou masque les barres d’outils standard. |
Méthodes
| 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. |
| show |
Définit la visibilité d’une barre d’outils spécifique dans l’application. |
| show |
Définit la visibilité d’une barre d’outils spécifique dans l’application. |
| toJSON() | Remplace la méthode JavaScript |
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é
showBorders
Affiche ou masque les bordures de l’application iframe.
showBorders: boolean;Valeur de propriété
boolean
Remarques
Exemples
Visio.run(session, function (ctx) {
const application = ctx.document.application;
application.showToolbars = false;
application.showBorders = false;
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
showToolbars
Affiche ou masque les barres d’outils standard.
showToolbars: boolean;Valeur de propriété
boolean
Remarques
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.ApplicationLoadOptions): Visio.Application;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.Application;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.Application;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.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Visio.Interfaces.ApplicationUpdateData
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.Application): void;Paramètres
- properties
- Visio.Application
Retours
void
showToolbar(id, show)
Définit la visibilité d’une barre d’outils spécifique dans l’application.
showToolbar(id: Visio.ToolBarType, show: boolean): void;Paramètres
Type de la barre d’outils.
- show
-
boolean
Indique si la barre d’outils est visible ou non.
Retours
void
Remarques
showToolbar(idString, show)
Définit la visibilité d’une barre d’outils spécifique dans l’application.
showToolbar(idString: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;Paramètres
- idString
-
"CommandBar" | "PageNavigationBar" | "StatusBar"
Type de la barre d’outils.
- show
-
boolean
Indique si la barre d’outils est visible ou non.
Retours
void
Remarques
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.Application d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.ApplicationDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Visio.Interfaces.ApplicationData;