Word.DocumentFollowHyperlinkOptions interface

パッケージ:

word

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

Document.followHyperlink メソッドの構成オプションを提供します。

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

プロパティ

addHistory	指定した場合は、閲覧履歴にリンクを追加するかどうかを指定します。 既定値は trueです。
address	指定した場合は、後に続くハイパーリンク アドレスを指定します。 既定値は空の文字列です。
extraInfo	指定した場合は、要求に渡す追加情報を指定します。 既定値は空の文字列です。
headerInfo	指定した場合は、HTTP 要求のヘッダー情報を指定します。 既定値は空の文字列です。
httpMethod	指定した場合は、要求に使用する HTTP メソッドを指定します。 既定値は "GET" です。
newWindow	指定した場合は、リンクを新しいウィンドウで開くかどうかを指定します。 既定値は falseです。
subAddress	指定した場合は、ドキュメント内のサブアドレスを指定します。 既定値は空の文字列です。

プロパティの詳細

addHistory

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定した場合は、閲覧履歴にリンクを追加するかどうかを指定します。 既定値は trueです。

addHistory?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

address

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定した場合は、後に続くハイパーリンク アドレスを指定します。 既定値は空の文字列です。

address?: string;

プロパティ値

string

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

extraInfo

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定した場合は、要求に渡す追加情報を指定します。 既定値は空の文字列です。

extraInfo?: string;

プロパティ値

string

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

headerInfo

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定した場合は、HTTP 要求のヘッダー情報を指定します。 既定値は空の文字列です。

headerInfo?: string;

プロパティ値

string

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

httpMethod

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定した場合は、要求に使用する HTTP メソッドを指定します。 既定値は "GET" です。

httpMethod?: string;

プロパティ値

string

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

newWindow

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定した場合は、リンクを新しいウィンドウで開くかどうかを指定します。 既定値は falseです。

newWindow?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

subAddress

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定した場合は、ドキュメント内のサブアドレスを指定します。 既定値は空の文字列です。

subAddress?: string;

プロパティ値

string

注釈

[ API セット: WordApi BETA (プレビューのみ) ]