PowerPoint.Hyperlink class
1 つのハイパーリンクを表します。
- Extends
注釈
[ API セット: PowerPointApi 1.6 ]
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml
// Gets the hyperlinks found in the first selected slide.
await PowerPoint.run(async (context) => {
const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks.load("address,screenTip");
const hyperlinksCount = hyperlinks.getCount();
await context.sync();
console.log(`${hyperlinksCount.value} hyperlinks found in first selected slide:`);
for (let link of hyperlinks.items) {
console.log(`Address: "${link.address}" (Screen tip: "${link.screenTip}")`);
}
});
プロパティ
| address | ハイパーリンクのアドレスを指定します。URL、ファイル名またはファイル パス、または |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| screen |
ハイパーリンクの上にマウス ポインターを置いたときに表示される文字列を指定します。 |
| type | ハイパーリンクが適用されるオブジェクトの種類を返します。 詳細については、「 PowerPoint.HyperlinkType 」を参照してください。 |
メソッド
| delete() | ハイパーリンクを削除します。 |
| get |
ハイパーリンクが適用される PowerPoint.Shape オブジェクトを返します。 ハイパーリンクが |
| get |
ハイパーリンクが適用される PowerPoint.TextRange オブジェクトを返します。 ハイパーリンクが |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
address
ハイパーリンクのアドレスを指定します。URL、ファイル名またはファイル パス、または mailto URI スキームを持つ電子メール アドレスを指定します。
address: string;プロパティ値
string
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
screenTip
ハイパーリンクの上にマウス ポインターを置いたときに表示される文字列を指定します。
screenTip: string;プロパティ値
string
注釈
type
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ハイパーリンクが適用されるオブジェクトの種類を返します。 詳細については、「 PowerPoint.HyperlinkType 」を参照してください。
readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";プロパティ値
PowerPoint.HyperlinkType | "TextRange" | "Shape"
注釈
メソッドの詳細
delete()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ハイパーリンクを削除します。
delete(): void;戻り値
void
注釈
getLinkedShapeOrNullObject()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ハイパーリンクが適用される PowerPoint.Shape オブジェクトを返します。 ハイパーリンクが shape 型ではない場合、または現在 PowerPoint.Shape をサポートしていないドメイン内にある場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getLinkedShapeOrNullObject(): PowerPoint.Shape;戻り値
注釈
getLinkedTextRangeOrNullObject()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ハイパーリンクが適用される PowerPoint.TextRange オブジェクトを返します。 ハイパーリンクが textRange 型ではない場合、または現在 PowerPoint.TextRange をサポートしていないドメイン内にある場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): PowerPoint.Hyperlink;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.Hyperlink;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.Hyperlink オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.HyperlinkData として型指定) を返します。
toJSON(): PowerPoint.Interfaces.HyperlinkData;