Visio.Application class
Stellt die Anwendung dar.
- Extends
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| show |
Blendet die Rahmen der iframe-Anwendung ein oder aus. |
| show |
Blendet die Standardsymbolleisten ein oder aus. |
Methoden
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| show |
Legt die Sichtbarkeit einer bestimmten Symbolleiste in der Anwendung fest. |
| show |
Legt die Sichtbarkeit einer bestimmten Symbolleiste in der Anwendung fest. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
showBorders
Blendet die Rahmen der iframe-Anwendung ein oder aus.
showBorders: boolean;Eigenschaftswert
boolean
Hinweise
Beispiele
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
Blendet die Standardsymbolleisten ein oder aus.
showToolbars: boolean;Eigenschaftswert
boolean
Hinweise
Details zur Methode
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Visio.Interfaces.ApplicationLoadOptions): Visio.Application;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Visio.Application;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Application;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Visio.Interfaces.ApplicationUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Visio.Application): void;Parameter
- properties
- Visio.Application
Gibt zurück
void
showToolbar(id, show)
Legt die Sichtbarkeit einer bestimmten Symbolleiste in der Anwendung fest.
showToolbar(id: Visio.ToolBarType, show: boolean): void;Parameter
Der Typ der Symbolleiste.
- show
-
boolean
Gibt an, ob die Symbolleiste sichtbar ist oder nicht.
Gibt zurück
void
Hinweise
showToolbar(id, show)
Legt die Sichtbarkeit einer bestimmten Symbolleiste in der Anwendung fest.
showToolbar(id: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;Parameter
- id
-
"CommandBar" | "PageNavigationBar" | "StatusBar"
Der Typ der Symbolleiste.
- show
-
boolean
Gibt an, ob die Symbolleiste sichtbar ist oder nicht.
Gibt zurück
void
Hinweise
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Visio.Application-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.ApplicationData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Visio.Interfaces.ApplicationData;