Word.Hyperlink class

ハイパーリンクのアドレス (ファイル名や URL など) を指定します。

address: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

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

context: RequestContext;

プロパティ値

ハイパーリンクの件名の文字列を指定します。

emailSubject: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

ハイパーリンクを解決するために追加情報が必要な場合は true を返します。

readonly isExtraInfoRequired: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

Hyperlink オブジェクトの名前を返します。

readonly name: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

ハイパーリンク内にあるドキュメントの一部を表す Range オブジェクトを返します。

readonly range: Word.Range;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

ハイパーリンクの上にマウス ポインターを置いたときにポップ ヒントとして表示されるテキストを指定します。

screenTip: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

ハイパーリンクのリンク先の名前付き場所を指定します。

subAddress: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

ハイパーリンクを読み込むフレームまたはウィンドウの名前を指定します。

target: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

文書内でのハイパーリンクの表示テキストを指定します。

textToDisplay: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

ハイパーリンクの種類を取得します。

readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

ドキュメントまたはハイパーリンクへのショートカットを作成して、 お気に入り フォルダーに追加します。

addToFavorites(): void;

返品

注釈

API セット: WordApiDesktop 1.3

ハイパーリンクにリンクされた新しい文書を作成します。

createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

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

delete(): void;

返品

注釈

API セット: WordApiDesktop 1.3

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

set(properties: Word.Hyperlink): void;

パラメーター

返品

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

toJSON(): Word.Interfaces.HyperlinkData;

返品

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.Hyperlink;

返品

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.Hyperlink;

返品