| Ver. | メソッドの書式 | 戻り値 | メソッドの説明 |
|---|
| | パラメータ | 値 | | パラメータの説明 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
add(hyperlinkSource, [hyperlinkDestination], [withProperties]) |
Hyperlink | 新しいオブジェクトを作成し、それを返す |
| hyperlinkSource |
HyperlinkPageItemSource, HyperlinkTextSource, CrossReferenceSource | | |
| [hyperlinkDestination] |
[ fileName, volumn, directoryId, dataLinkClassId, destinationUid ], HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination, ParagraphDestination | | 移動先 fileName:文字列値, volumn:文字列値, directoryId:数値, dataLinkClassId:数値, destinationUid:数値 |
| [withProperties] |
Object | | プロパティを設定 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
anyItem() |
Hyperlink | どれかのオブジェクトを返す |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
count() |
数値 | 要素数を返す |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
everyItem() |
Hyperlink (Array) | 全てのオブジェクトを返す |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
firstItem() |
Hyperlink | 最初のオブジェクトを返す |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
item(index) |
Hyperlink | インデックスまたは名前で指定したオブジェクトを返す |
| index |
数値, 文字列値 | | インデックスまたは名前 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
itemByID(id) |
Hyperlink | IDで指定したオブジェクトを返す |
| id |
数値 | | |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
itemByName(name) |
Hyperlink | 名前で指定したオブジェクトを返す |
| name |
文字列値 | | |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
itemByRange(from, to) |
Hyperlink (Array) | 範囲で指定したオブジェクトを返す |
| from |
Hyperlink, 数値, 文字列値 | | 範囲の開始 |
| to |
Hyperlink, 数値, 文字列値 | | 範囲の終了 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
lastItem() |
Hyperlink | 最後のオブジェクトを返す |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
middleItem() |
Hyperlink | 真ん中のオブジェクトを返す |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
nextItem(obj) |
Hyperlink | 一つ後のオブジェクトを返す |
| obj |
Hyperlink | | 位置の基準になるオブジェクト |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
previousItem(obj) |
Hyperlink | 一つ前のオブジェクトを返す |
| obj |
Hyperlink | | 位置の基準になるオブジェクト |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
toSource() |
文字列値 | ソースコードを表す文字列を返す |
| Ver. | プロパティ名 | R/O | 値 | 説明 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
borderColor | |
[ r, g, b ], UIColors | ハイパーリンクの下線の色 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
borderStyle | |
HyperlinkAppearanceStyle
| HyperlinkAppearanceStyle |
|---|
| Ver. | プロパティ | 値/管理用文字 | 説明 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) | DASHED | 1684108136 dash | Uses a dashed stroke. |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) | SOLID | 1936682084 sold | Uses a solid stroke. |
| ハイパーリンクの下線のスタイル |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
destination | |
HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination, ParagraphDestination | リンク先 |
   ![[21]](21e.svg) |
epubAriaRole | |
文字列値 | (21.1以降)ePubのARIAロール |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
hidden | ○ |
真偽値 | If true, the hyperlink is hidden. |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
highlight | |
HyperlinkAppearanceHighlight
| HyperlinkAppearanceHighlight |
|---|
| Ver. | プロパティ | 値/管理用文字 | 説明 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) | INSET | 1853056372 nset | Highlights the hyperlink border inset. |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) | INVERT | 1853256308 nvrt | Highlights the hyperlink fill color. |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) | NONE | 1852796517 none | Does not highlight the hyperlink. |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) | OUTLINE | 1869900910 otln | Highlights the hyperlink border. |
| The hyperlink highlight style. |
   ![[21]](21e.svg) |
hypherlinkAltText | |
文字列値 | (21.1以降)ハイパーリンクのAltテキスト |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
id | ○ |
数値 | オブジェクトのID |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
index | ○ |
数値 | インデックス |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
isValid | ○ |
真偽値 | オブジェクトが有効かどうか |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
label | |
文字列値 | スクリプトラベル |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
name | |
文字列値 | オブジェクトの名前 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
properties | |
Object | |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
source | |
HyperlinkPageItemSource, HyperlinkTextSource, CrossReferenceSource | The hyperlinked text or page item. |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
visible | |
真偽値 | 表示するかどうか |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) |
width | |
HyperlinkAppearanceWidth
| HyperlinkAppearanceWidth |
|---|
| Ver. | プロパティ | 値/管理用文字 | 説明 |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) | MEDIUM | 1701727588 enMd | Uses a medium border. |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) | THICK | 1952999787 thik | Uses a thick border. |
![[18]](18e.svg) ![[19]](19e.svg) ![[20]](20e.svg) ![[21]](21e.svg) | THIN | 1952999790 thin | Uses a thin border. |
| The stroke weight of the hyperlink border. |