Visio.Application class

アプリケーションを表します。

Extends

プロパティ

context

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

showBorders

iframe アプリケーションの境界線を表示または非表示にします。

showToolbars

標準ツールバーの表示と非表示を切り替えます。

メソッド

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

showToolbar(id, show)

アプリケーション内の特定のツールバーの表示設定を設定します。

showToolbar(id, show)

アプリケーション内の特定のツールバーの表示設定を設定します。

toJSON()

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

showBorders

iframe アプリケーションの境界線を表示または非表示にします。

showBorders: boolean;

プロパティ値

boolean

注釈

API セット: 1.1

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

標準ツールバーの表示と非表示を切り替えます。

showToolbars: boolean;

プロパティ値

boolean

注釈

API セット: 1.1

メソッドの詳細

load(options)

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

load(options?: Visio.Interfaces.ApplicationLoadOptions): Visio.Application;

パラメーター

options
Visio.Interfaces.ApplicationLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

set(properties, options)

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

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

パラメーター

properties
Visio.Interfaces.ApplicationUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

返品

void

set(properties)

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

set(properties: Visio.Application): void;

パラメーター

properties
Visio.Application

返品

void

showToolbar(id, show)

アプリケーション内の特定のツールバーの表示設定を設定します。

showToolbar(id: Visio.ToolBarType, show: boolean): void;

パラメーター

id
Visio.ToolBarType

ツールバーの種類。

show

boolean

ツール バーが表示されているかどうか。

返品

void

注釈

API セット: 1.1

showToolbar(id, show)

アプリケーション内の特定のツールバーの表示設定を設定します。

showToolbar(id: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;

パラメーター

id

"CommandBar" | "PageNavigationBar" | "StatusBar"

ツールバーの種類。

show

boolean

ツール バーが表示されているかどうか。

返品

void

注釈

API セット: 1.1

toJSON()

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

toJSON(): Visio.Interfaces.ApplicationData;

返品