Word.DocumentFollowHyperlinkOptions interface
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Document.followHyperlink メソッドの構成オプションを指定します。
プロパティ
| add |
指定した場合は、閲覧の履歴にリンクを追加するかどうかを指定します。 既定値は |
| address | ハイパーリンクを指定する場合は、指定するハイパーリンク アドレスを指定します。 既定値は空の文字列です。 |
| extra |
指定した場合は、要求で渡す追加情報を指定します。 既定値は空の文字列です。 |
| header |
指定した場合は、HTTP 要求のヘッダー情報を指定します。 既定値は空の文字列です。 |
| http |
指定した場合は、要求に使用する HTTP メソッドを指定します。 既定値は "GET" です。 |
| new |
指定されている場合は、新しいウィンドウでリンクを開くかどうかを指定します。 既定値は |
| sub |
指定した場合は、ドキュメント内のサブアドレスを指定します。 既定値は空の文字列です。 |
プロパティの詳細
addHistory
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、閲覧の履歴にリンクを追加するかどうかを指定します。 既定値は true です。
addHistory?: boolean;プロパティ値
boolean
注釈
address
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ハイパーリンクを指定する場合は、指定するハイパーリンク アドレスを指定します。 既定値は空の文字列です。
address?: string;プロパティ値
string
注釈
extraInfo
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、要求で渡す追加情報を指定します。 既定値は空の文字列です。
extraInfo?: string;プロパティ値
string
注釈
headerInfo
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、HTTP 要求のヘッダー情報を指定します。 既定値は空の文字列です。
headerInfo?: string;プロパティ値
string
注釈
httpMethod
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、要求に使用する HTTP メソッドを指定します。 既定値は "GET" です。
httpMethod?: string;プロパティ値
string
注釈
newWindow
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定されている場合は、新しいウィンドウでリンクを開くかどうかを指定します。 既定値は false です。
newWindow?: boolean;プロパティ値
boolean
注釈
subAddress
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、ドキュメント内のサブアドレスを指定します。 既定値は空の文字列です。
subAddress?: string;プロパティ値
string