Visio.Document class

このドキュメントを含む Visio アプリケーションのインスタンスを表します。

readonly application: Visio.Application;

プロパティ値

注釈

API セット: 1.1

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

ドキュメントに関連付けられているページのコレクションを表します。

readonly pages: Visio.PageCollection;

プロパティ値

注釈

API セット: 1.1

例

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

DocumentView オブジェクトを返します。

readonly view: Visio.DocumentView;

プロパティ値

注釈

API セット: 1.1

ドキュメントのアクティブ ページを返します。

getActivePage(): Visio.Page;

返品

注釈

API セット: 1.1

例

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

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Visio.Interfaces.DocumentLoadOptions): Visio.Document;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Visio.Document;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.Document;

パラメーター

返品

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Visio.Document): void;

パラメーター

返品

ドキュメントのアクティブ ページを設定します。

setActivePage(PageName: string): void;

パラメーター

返品

注釈

API セット: 1.1

例

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

タスク ウィンドウを表示または非表示にします。 これは、Visio の図面を埋め込んで作業ウィンドウを表示/非表示にする DV Excel アドイン/その他のサード パーティ製アプリによって使用されます。

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

パラメーター

返品

注釈

API セット: 1.1

タスク ウィンドウを表示または非表示にします。 これは、Visio の図面を埋め込んで作業ウィンドウを表示/非表示にする DV Excel アドイン/その他のサード パーティ製アプリによって使用されます。

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

パラメーター

返品

注釈

API セット: 1.1

すべてのページについて、図内のデータの更新をトリガーします。

startDataRefresh(): void;

返品

注釈

API セット: 1.1

例

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

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify は、渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Visio.Document オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Visio.Interfaces.DocumentData 型) を返します。

toJSON(): Visio.Interfaces.DocumentData;

返品

ダイアグラムのデータが更新されたときに発生します。

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

イベントの種類

注釈

API セット: 1.1

セッションで予期されたエラー、または予期しないエラーが発生した場合に発生します。

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

イベントの種類

注釈

API セット: 1.1

ドキュメントの読み込み、更新、または変更時に発生します。

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

イベントの種類

注釈

API セット: 1.1

ページの読み込みが完了したときに発生します。

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

イベントの種類

注釈

API セット: 1.1

現在選択されている図形が変更されたときに発生します。

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

イベントの種類

注釈

API セット: 1.1

ユーザーが図形の境界ボックスにマウス ポインターを移動したときに発生します。

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

イベントの種類

注釈

API セット: 1.1

ユーザーが図形の境界ボックスの外にマウスを移動したときに発生します。

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

イベントの種類

注釈

API セット: 1.1

作業ウィンドウの状態が変更されるたびに発生します。

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

イベントの種類

注釈

API セット: 1.1