Visio.Document class

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

readonly application: Visio.Application;

Eigenschaftswert

Hinweise

API-Satz: 1.1

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

context: RequestContext;

Eigenschaftswert

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

readonly pages: Visio.PageCollection;

Eigenschaftswert

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));
    }
});

Gibt das DocumentView-Objekt zurück.

readonly view: Visio.DocumentView;

Eigenschaftswert

Hinweise

API-Satz: 1.1

Gibt die aktive Seite des Dokuments zurück.

getActivePage(): Visio.Page;

Gibt zurück

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));
    }
});

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Visio.Document): void;

Parameter

Gibt zurück

Leg die aktive Seite des Dokuments fest.

setActivePage(PageName: string): void;

Parameter

Gibt zurück

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));
    }
});

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: 1.1

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: 1.1

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

startDataRefresh(): void;

Gibt zurück

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));
    }
});

Ü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.Document-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Visio.Interfaces.DocumentDatatypisiert ) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Visio.Interfaces.DocumentData;

Gibt zurück

Tritt auf, wenn die Daten im Diagramm aktualisiert werden.

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

Ereignistyp

Hinweise

API-Satz: 1.1

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

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

Ereignistyp

Hinweise

API-Satz: 1.1

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

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

Ereignistyp

Hinweise

API-Satz: 1.1

Tritt auf, wenn die Seite geladen ist.

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

Ereignistyp

Hinweise

API-Satz: 1.1

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

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

Ereignistyp

Hinweise

API-Satz: 1.1

Tritt auf, wenn der Benutzer den Mauszeiger in den Begrenzungsrahmen eines Shapes bewegt.

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

Ereignistyp

Hinweise

API-Satz: 1.1

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

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

Ereignistyp

Hinweise

API-Satz: 1.1

Tritt immer dann auf, wenn der Status eines Aufgabenbereichs geändert wird.

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

Ereignistyp

Hinweise

API-Satz: 1.1