PageReference(索引の参照先)のコレクション
Ver. | プロパティ名 | R/O | 値 | 説明 |
---|---|---|---|---|
length | ○ | 数値 | オブジェクト数 |
Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ | 値 | パラメータの説明 | |||||||||||||||||||||||||||||||||||||||||||||||
add(source, [pageReferenceType], [pageReferenceLimit], [pageNumberStyleOverride], [withProperties]) | PageReference | 新しいオブジェクトを作成し、それを返す | |||||||||||||||||||||||||||||||||||||||||||||||
source | Text | The text or insertion point to which the page reference points. | |||||||||||||||||||||||||||||||||||||||||||||||
[pageReferenceType] |
PageReferenceType
| The page number for an index page reference or the last page in an index page reference page range. (既定値=PageReferenceType.CURRENT_PAGE) | |||||||||||||||||||||||||||||||||||||||||||||||
[pageReferenceLimit] | ParagraphStyle, 数値 | The paragraph style or number of paragraphs or pages that defines the last page in a page range. Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. | |||||||||||||||||||||||||||||||||||||||||||||||
[pageNumberStyleOverride] | CharacterStyle | ページ番号の文字スタイル | |||||||||||||||||||||||||||||||||||||||||||||||
[withProperties] | Object | プロパティを設定 | |||||||||||||||||||||||||||||||||||||||||||||||
anyItem() | PageReference | どれかのオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
count() | 数値 | 要素数を返す | |||||||||||||||||||||||||||||||||||||||||||||||
everyItem() | Array( PageReference ) | 全てのオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
firstItem() | PageReference | 最初のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
item(index) | PageReference | インデックスまたは名前で指定したオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
index | 数値, 文字列値 | インデックスまたは名前 | |||||||||||||||||||||||||||||||||||||||||||||||
itemByID(id) | PageReference | IDで指定したオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
id | 数値 | ||||||||||||||||||||||||||||||||||||||||||||||||
itemByName(name) | PageReference | 名前で指定したオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
name | 文字列値 | ||||||||||||||||||||||||||||||||||||||||||||||||
itemByRange(from, to) | Array( PageReference ) | 範囲で指定したオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
from | PageReference, 数値, 文字列値 | 範囲の開始 | |||||||||||||||||||||||||||||||||||||||||||||||
to | PageReference, 数値, 文字列値 | 範囲の終了 | |||||||||||||||||||||||||||||||||||||||||||||||
lastItem() | PageReference | 最後のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
middleItem() | PageReference | 真ん中のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
nextItem(obj) | PageReference | 一つ後のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
obj | PageReference | 位置の基準になるオブジェクト | |||||||||||||||||||||||||||||||||||||||||||||||
previousItem(obj) | PageReference | 一つ前のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||||||
obj | PageReference | 位置の基準になるオブジェクト | |||||||||||||||||||||||||||||||||||||||||||||||
toSource() | 文字列値 | ソースコードを表す文字列を返す |
索引の参照先
Ver. | プロパティ | R/O | 値 |
---|---|---|---|
parent | ○ | Topic | |
eventListeners | ○ | EventListeners | |
events | ○ | Events |
Ver. | プロパティ名 | R/O | 値 | 説明 | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | ○ | 数値 | オブジェクトのID | |||||||||||||||||||||||||||||||||||||||||||||
index | ○ | 数値 | インデックス | |||||||||||||||||||||||||||||||||||||||||||||
isValid | ○ | 真偽値 | オブジェクトが有効かどうか | |||||||||||||||||||||||||||||||||||||||||||||
label | 文字列値 | スクリプトラベル | ||||||||||||||||||||||||||||||||||||||||||||||
name | 文字列値 | オブジェクトの名前 - label のエイリアス | ||||||||||||||||||||||||||||||||||||||||||||||
pageNumberStyleOverride | CharacterStyle | The character style applied to page numbers. | ||||||||||||||||||||||||||||||||||||||||||||||
pageReferenceLimit | ParagraphStyle, 数値 | The paragraph style or number of paragraphs or pages that defines the last page in a page range. Note: Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. | ||||||||||||||||||||||||||||||||||||||||||||||
pageReferenceType |
PageReferenceType
| Options for index page references. | ||||||||||||||||||||||||||||||||||||||||||||||
properties | Object | |||||||||||||||||||||||||||||||||||||||||||||||
sourceText | ○ | Text | 参照先のテキスト |
Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||
---|---|---|---|---|---|
パラメータ | 値 | パラメータの説明 | |||
addEventListener(eventType, handler, [captures]) | EventListener | EventListenerを作成 | |||
eventType | 文字列値 | ||||
handler | ファイル, JavaScript関数 | ||||
[captures] | 真偽値 | (廃止) | |||
extractLabel(key) | 文字列値 | キーに関連づけられた値を取得 | |||
key | 文字列値 | キー | |||
getElements() | Array( PageReference ) | オブジェクト参照を返す | |||
insertLabel(key, value) | なし | キーに関連づけられた値を設定 | |||
key | 文字列値 | キー | |||
value | 文字列値 | 値 | |||
remove() | なし | 削除 | |||
removeEventListener(eventType, handler, [captures]) | 真偽値 | EventListenerを削除 | |||
eventType | 文字列値 | ||||
handler | ファイル, JavaScript関数 | ||||
[captures] | 真偽値 | (廃止) | |||
toSource() | 文字列値 | ソースコードを表す文字列を返す | |||
toSpecifier() | 文字列値 | Retrieves the object specifier. |