Visio.Document class

Referenz

Paket:: visio

Stellt die Document-Klasse dar.

Extends: OfficeExtension.ClientObject

Hinweise

Eigenschaften

application	Stellt die Instanz einer Visio-Anwendung dar, die dieses Dokument enthält.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
pages	Stellt eine Auflistung der mit dem Dokument verknüpften Seiten dar.
view	Gibt das DocumentView-Objekt zurück.

Methoden

getActivePage()	Gibt die aktive Seite des Dokuments zurück.
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(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(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.
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.
setActivePage(PageName)	Leg die aktive Seite des Dokuments fest.
setMockData(data)	Festlegen von Modelldaten
showTaskPane(taskPaneType, initialProps, show)	Blendet einen Aufgabenbereich ein oder aus. Dies wird vom DV Excel-Add-In/Anderen Drittanbieter-Apps genutzt, die die Visio-Zeichnung einbetten, um den Aufgabenbereich ein-/auszublenden.
showTaskPane(taskPaneTypeString, initialProps, show)	Blendet einen Aufgabenbereich ein oder aus. Dies wird vom DV Excel-Add-In/Anderen Drittanbieter-Apps genutzt, die die Visio-Zeichnung einbetten, um den Aufgabenbereich ein-/auszublenden.
startDataRefresh()	Löst die Aktualisierung der Daten im Diagramm für alle Seiten aus..
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Visio.Document-Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `Visio.Interfaces.DocumentData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Ereignisse

onDataRefreshComplete	Tritt auf, wenn die Daten im Diagramm aktualisiert werden.
onDocumentError	Tritt auf, wenn in der Sitzung ein erwarteter oder unerwarteter Fehler aufgetreten ist.
onDocumentLoadComplete	Tritt auf, wenn das Dokument geladen, aktualisiert oder geändert wird.
onPageLoadComplete	Tritt auf, wenn das Laden der Seite abgeschlossen ist.
onSelectionChanged	Tritt auf, wenn sich die aktuelle Auswahl von Formen ändert.
onShapeMouseEnter	Tritt auf, wenn der Benutzer den Mauszeiger in das umgebende Feld einer Form bewegt.
onShapeMouseLeave	Tritt auf, wenn der Benutzer die Maus aus dem Begrenzungsrahmen eines Shapes bewegt.
onTaskPaneStateChanged	Tritt auf, wenn ein Aufgabenbereichszustand geändert wird.

Details zur Eigenschaft

application

Stellt die Instanz einer Visio-Anwendung dar, die dieses Dokument enthält.

readonly application: Visio.Application;

Eigenschaftswert

Visio.Application

Hinweise

[ API-Satz: 1.1 ]

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Visio.RequestContext

pages

Stellt eine Auflistung der mit dem Dokument verknüpften Seiten dar.

readonly pages: Visio.PageCollection;

Eigenschaftswert

Visio.PageCollection

Hinweise

[ API-Satz: 1.1 ]

Beispiele

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

Gibt das DocumentView-Objekt zurück.

readonly view: Visio.DocumentView;

Eigenschaftswert

Visio.DocumentView

Hinweise

[ API-Satz: 1.1 ]

Details zur Methode

getActivePage()

Gibt die aktive Seite des Dokuments zurück.

getActivePage(): Visio.Page;

Gibt zurück

Visio.Page

Hinweise

[ API-Satz: 1.1 ]

Beispiele

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)

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.DocumentLoadOptions): Visio.Document;

Parameter

options: Visio.Interfaces.DocumentLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Visio.Document

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

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Visio.Document

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

Parameter

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Visio.Document

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

Parameter

properties: Visio.Interfaces.DocumentUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options: OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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.Document): void;

Parameter

properties: Visio.Document

Gibt zurück

void

setActivePage(PageName)

Leg die aktive Seite des Dokuments fest.

setActivePage(PageName: string): void;

Parameter

PageName: string

Name der Seite

Gibt zurück

void

Hinweise

[ API-Satz: 1.1 ]

Beispiele

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)

Festlegen von Modelldaten

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

Parameter

data: Visio.Interfaces.DocumentData

Gibt zurück

void

showTaskPane(taskPaneType, initialProps, show)

Blendet einen Aufgabenbereich ein oder aus. Dies wird vom DV Excel-Add-In/Anderen Drittanbieter-Apps genutzt, die die Visio-Zeichnung einbetten, um den Aufgabenbereich ein-/auszublenden.

showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;

Parameter

taskPaneType: Visio.TaskPaneType

Typ des Aufgabenbereichs des 1. Parteis. Es können Werte aus der Enumeration TaskPaneType verwendet werden.

initialProps: any

Optionaler Parameter. Dies ist eine generische Datenstruktur, die mit anfänglichen Daten gefüllt wird, die zum Initialisieren des Inhalts des Aufgabenbereichs erforderlich sind.

show: boolean

Optionaler Parameter. Wenn der Wert auf false festgelegt ist, wird der angegebene Aufgabenbereich ausgeblendet.

Gibt zurück

void

Hinweise

[ API-Satz: 1.1 ]

showTaskPane(taskPaneTypeString, initialProps, show)

Blendet einen Aufgabenbereich ein oder aus. Dies wird vom DV Excel-Add-In/Anderen Drittanbieter-Apps genutzt, die die Visio-Zeichnung einbetten, um den Aufgabenbereich ein-/auszublenden.

showTaskPane(taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;

Parameter

taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings"

Typ des Aufgabenbereichs des 1. Parteis. Es können Werte aus der Enumeration TaskPaneType verwendet werden.

initialProps: any

Optionaler Parameter. Dies ist eine generische Datenstruktur, die mit anfänglichen Daten gefüllt wird, die zum Initialisieren des Inhalts des Aufgabenbereichs erforderlich sind.

show: boolean

Optionaler Parameter. Wenn der Wert auf false festgelegt ist, wird der angegebene Aufgabenbereich ausgeblendet.

Gibt zurück

void

Hinweise

[ API-Satz: 1.1 ]

startDataRefresh()

Löst die Aktualisierung der Daten im Diagramm für alle Seiten aus..

startDataRefresh(): void;

Gibt zurück

void

Hinweise

[ API-Satz: 1.1 ]

Beispiele

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()

Ü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 das Objekt übergeben wird.) Während das ursprüngliche Visio.Document-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.DocumentData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Visio.Interfaces.DocumentData;

Gibt zurück

Visio.Interfaces.DocumentData

Details zum Ereignis

onDataRefreshComplete

Tritt auf, wenn die Daten im Diagramm aktualisiert werden.

readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>

Hinweise

[ API-Satz: 1.1 ]

onDocumentError

Tritt auf, wenn in der Sitzung ein erwarteter oder unerwarteter Fehler aufgetreten ist.

readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>

Hinweise

[ API-Satz: 1.1 ]

onDocumentLoadComplete

Tritt auf, wenn das Dokument geladen, aktualisiert oder geändert wird.

readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>

Hinweise

[ API-Satz: 1.1 ]

onPageLoadComplete

Tritt auf, wenn das Laden der Seite abgeschlossen ist.

readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>

Hinweise

[ API-Satz: 1.1 ]

onSelectionChanged

Tritt auf, wenn sich die aktuelle Auswahl von Formen ändert.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>

Hinweise

[ API-Satz: 1.1 ]

onShapeMouseEnter

Tritt auf, wenn der Benutzer den Mauszeiger in das umgebende Feld einer Form bewegt.

readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>

Hinweise

[ API-Satz: 1.1 ]

onShapeMouseLeave

Tritt auf, wenn der Benutzer die Maus aus dem Begrenzungsrahmen eines Shapes bewegt.

readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>

Hinweise

[ API-Satz: 1.1 ]

onTaskPaneStateChanged

Tritt auf, wenn ein Aufgabenbereichszustand geändert wird.

readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>

Hinweise

[ API-Satz: 1.1 ]