Visio.Hyperlink class

  • リファレンス
パッケージ:
visio

ハイパーリンクを表します。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: 1.1 ]

プロパティ

address

ハイパーリンク オブジェクトのアドレスを取得します。
context

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

ハイパーリンクの説明を取得します。
extraInfo

ハイパーリンクの URL を解決するために使用される追加の URL 要求情報を取得します。
subAddress

ハイパーリンク オブジェクトのサブアドレスを取得します。

メソッド

load(options)

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

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

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

モック データを設定する
toJSON()

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

プロパティの詳細

ハイパーリンク オブジェクトのアドレスを取得します。

readonly address: string;

プロパティ値

string

注釈

[ API セット: 1.1 ]

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

context: RequestContext;

プロパティ値

Visio.RequestContext

ハイパーリンクの説明を取得します。

readonly description: string;

プロパティ値

string

注釈

[ API セット: 1.1 ]

ハイパーリンクの URL を解決するために使用される追加の URL 要求情報を取得します。

readonly extraInfo: string;

プロパティ値

string

注釈

[ API セット: 1.1 ]

ハイパーリンク オブジェクトのサブアドレスを取得します。

readonly subAddress: string;

プロパティ値

string

注釈

[ API セット: 1.1 ]

メソッドの詳細

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

load(options?: Visio.Interfaces.HyperlinkLoadOptions): Visio.Hyperlink;

パラメーター

options
Visio.Interfaces.HyperlinkLoadOptions

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

戻り値

Visio.Hyperlink

例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const hyperlink = shape.hyperlinks.getItem(0);
    hyperlink.load();
    return ctx.sync().then(function() {
        console.log(hyperlink.description);
        console.log(hyperlink.address);
        console.log(hyperlink.subAddress);
        console.log(hyperlink.extraInfo);
     });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Visio.Hyperlink

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Visio.Hyperlink

モック データを設定する

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

パラメーター

data
Visio.Interfaces.HyperlinkData

戻り値

void

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

toJSON(): Visio.Interfaces.HyperlinkData;

戻り値

Visio.Interfaces.HyperlinkData