Word.Hyperlink class
Word ドキュメント内のハイパーリンクを表します。
- Extends
注釈
プロパティ
| address | ハイパーリンクのアドレス (ファイル名や URL など) を指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| email |
ハイパーリンクの件名行のテキスト文字列を指定します。 |
| is |
ハイパーリンクを解決するために追加情報が必要な場合は、 |
| name |
|
| range | ハイパーリンクに含まれるドキュメントの部分を表す |
| screen |
マウス ポインターをハイパーリンクの上に配置するときにヒントとして表示されるテキストを指定します。 |
| sub |
ハイパーリンクの宛先の名前付き場所を指定します。 |
| target | ハイパーリンクを読み込むフレームまたはウィンドウの名前を指定します。 |
| text |
文書内のハイパーリンクの表示テキストを指定します。 |
| type | ハイパーリンクの種類を取得します。 |
メソッド
| add |
ドキュメントまたはハイパーリンクへのショートカットを作成し、[ お気に入り ] フォルダーに追加します。 |
| create |
ハイパーリンクにリンクされた新しいドキュメントを作成します。 |
| delete() | ハイパーリンクを削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
address
ハイパーリンクのアドレス (ファイル名や URL など) を指定します。
address: string;プロパティ値
string
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
emailSubject
isExtraInfoRequired
ハイパーリンクを解決するために追加情報が必要な場合は、 true を返します。
readonly isExtraInfoRequired: boolean;プロパティ値
boolean
注釈
name
range
ハイパーリンクに含まれるドキュメントの部分を表す Range オブジェクトを返します。
readonly range: Word.Range;プロパティ値
注釈
screenTip
マウス ポインターをハイパーリンクの上に配置するときにヒントとして表示されるテキストを指定します。
screenTip: string;プロパティ値
string
注釈
subAddress
target
textToDisplay
type
ハイパーリンクの種類を取得します。
readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape";プロパティ値
Word.HyperlinkType | "Range" | "Shape" | "InlineShape"
注釈
メソッドの詳細
addToFavorites()
ドキュメントまたはハイパーリンクへのショートカットを作成し、[ お気に入り ] フォルダーに追加します。
addToFavorites(): void;戻り値
void
注釈
createNewDocument(fileName, editNow, overwrite)
ハイパーリンクにリンクされた新しいドキュメントを作成します。
createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void;パラメーター
- fileName
-
string
ファイルの名前を指定します。
- editNow
-
boolean
true 編集を今すぐ開始します。
- overwrite
-
boolean
true 同じ名前の別のファイルがある場合は上書きします。
戻り値
void
注釈
delete()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.Hyperlink;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Hyperlink;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.HyperlinkUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.Hyperlink): void;パラメーター
- properties
- Word.Hyperlink
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.Hyperlink オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.HyperlinkData として型指定) を返します。
toJSON(): Word.Interfaces.HyperlinkData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.Hyperlink;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): Word.Hyperlink;