PageReference

索引の参照先

プロパティ(オブジェクト)

Ver.プロパティ名説明
345
677.5
parentTopic
3
parentStoryStory

77.5
eventListenersEventListeners

77.5
eventsEventsイベント

プロパティ

Ver.プロパティ名R/O説明
345
677.5
id 数値型 オブジェクトのID
345
677.5
index 数値型 インデックス

677.5
isValid ブール型
345
677.5
label 文字列型 スクリプトラベル

77.5
name 文字列型 オブジェクトの名前。ラベルのエイリアス
345
677.5
pageNumberStyleOverride CharacterStyle The character style applied to page numbers.
345
677.5
pageReferenceLimit ParagraphStyle, 数値型 The paragraph style, number of paragraphs, 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, a number of paragraphs, pages. .
345
677.5
pageReferenceType PageReferenceType
PageReferenceType
Ver.10進数説明
345
677.5
CURRENT_PAGE1668444263The page on which the index entry is located.
345
677.5
FOR_NEXT_N_PAGES1718513767The range of pages from the page containing the inedex entry to the nth page after that page.
345
677.5
FOR_NEXT_N_PARAGRAPHS1718513778The range of pages from the page containing the index entry to the page containing the nth full paragraph from the paragraph containing the index entry.
345
677.5
SUPPRESS_PAGE_NUMBERS1852863079Turns off page numbers for the index topic.
345
677.5
TO_END_OF_DOCUMENT1701799011The last page in the document.
345
677.5
TO_END_OF_SECTION1701802851The last page in the numbered section containing the index entry.
345
677.5
TO_END_OF_STORY1701802868The last page in the story containing the index entry.
345
677.5
TO_NEXT_STYLE_CHANGE1953395555The range of pages from the page containing the index entry to the page containing the next paragraph style change.
345
677.5
TO_NEXT_USE_OF_STYLE1953396083The range of pages from the page containing the index entry to the page that contains the next occurrance of the specified paragraph style. If no paragraph style is specified, the paragraph style of the index entry paragraph is used.
Options for index page references.
45
677.5
sourceText Text 参照先のテキスト類(Text, TextColumn, Paragraph, Line, TextStyleRange, Word, Character, InsertionPoint)
3
storyOffset 数値型 参照先のInsertionPointのindex

メソッド

Ver.メソッドの書式戻り値メソッドの説明
  パラメータパラメータの説明

77.5
addEventListener(eventType, handler, [captures])EventListenerEventListenerを作成
eventType 文字列型
handler File型, JavaScript関数
[captures] ブール型(既定値=false) This parameter is obsolete.
345
677.5
extractLabel(key)文字列型キーに関連づけられたラベルを取得
key 文字列型 キー
45
677.5
getElements()PageReference
345
677.5
insertLabel(key, value)なしキーに関連づけられたラベルを設定
key 文字列型 キー
value 文字列型 ラベルの値
345
677.5
remove()なし削除

77.5
removeEventListener(eventType, handler, [captures])ブール型EventListenerを削除
eventType 文字列型
handler File型, JavaScript関数
[captures] ブール型(既定値=false) This parameter is obsolete.
45
677.5
toSource()文字列型
45
677.5
toSpecifier()文字列型

コレクションオブジェクトのプロパティ PageReferences

Ver.プロパティ名R/O説明
345
677.5
length 数値型 オブジェクト数

コレクションオブジェクトのメソッド PageReferences

Ver.メソッドの書式戻り値メソッドの説明
  パラメータパラメータの説明
3
add(parentStory, storyOffset, [pageReferenceType], [pageReferenceLimit], [pageNumberStyleOverride], [withProperties])PageReference新しいオブジェクトを作成し、それを返す
parentStory Story 親のストーリー
storyOffset InsertionPoint, 数値型 ストーリーの先頭からの位置
[pageReferenceType] PageReferenceType(既定値=PageReferenceType.CURRENT_PAGE)
PageReferenceType
Ver.10進数説明
345
677.5
CURRENT_PAGE1668444263The page on which the index entry is located.
345
677.5
FOR_NEXT_N_PAGES1718513767The range of pages from the page containing the inedex entry to the nth page after that page.
345
677.5
FOR_NEXT_N_PARAGRAPHS1718513778The range of pages from the page containing the index entry to the page containing the nth full paragraph from the paragraph containing the index entry.
345
677.5
SUPPRESS_PAGE_NUMBERS1852863079Turns off page numbers for the index topic.
345
677.5
TO_END_OF_DOCUMENT1701799011The last page in the document.
345
677.5
TO_END_OF_SECTION1701802851The last page in the numbered section containing the index entry.
345
677.5
TO_END_OF_STORY1701802868The last page in the story containing the index entry.
345
677.5
TO_NEXT_STYLE_CHANGE1953395555The range of pages from the page containing the index entry to the page containing the next paragraph style change.
345
677.5
TO_NEXT_USE_OF_STYLE1953396083The range of pages from the page containing the index entry to the page that contains the next occurrance of the specified paragraph style. If no paragraph style is specified, the paragraph style of the index entry paragraph is used.
The type of page reference
[pageReferenceLimit] ParagraphStyle, Long The page range limit.
[pageNumberStyleOverride] CharacterStyle ページ番号の文字スタイル
[withProperties] Object プロパティの初期値を設定
45
677.5
add(source, [pageReferenceType], [pageReferenceLimit], [pageNumberStyleOverride], [withProperties])PageReference新しいオブジェクトを作成し、それを返す
source Text TextまたはInsertionpoint
[pageReferenceType] PageReferenceType(既定値=PageReferenceType.CURRENT_PAGE)
PageReferenceType
Ver.10進数説明
345
677.5
CURRENT_PAGE1668444263The page on which the index entry is located.
345
677.5
FOR_NEXT_N_PAGES1718513767The range of pages from the page containing the inedex entry to the nth page after that page.
345
677.5
FOR_NEXT_N_PARAGRAPHS1718513778The range of pages from the page containing the index entry to the page containing the nth full paragraph from the paragraph containing the index entry.
345
677.5
SUPPRESS_PAGE_NUMBERS1852863079Turns off page numbers for the index topic.
345
677.5
TO_END_OF_DOCUMENT1701799011The last page in the document.
345
677.5
TO_END_OF_SECTION1701802851The last page in the numbered section containing the index entry.
345
677.5
TO_END_OF_STORY1701802868The last page in the story containing the index entry.
345
677.5
TO_NEXT_STYLE_CHANGE1953395555The range of pages from the page containing the index entry to the page containing the next paragraph style change.
345
677.5
TO_NEXT_USE_OF_STYLE1953396083The range of pages from the page containing the index entry to the page that contains the next occurrance of the specified paragraph style. If no paragraph style is specified, the paragraph style of the index entry paragraph is used.
The page number for an index page reference or the last page in an index page reference page range.
[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 プロパティの初期値を設定
45
677.5
anyItem()PageReference
345
677.5
count()数値型要素数を返す
45
677.5
everyItem()PageReference
45
677.5
firstItem()PageReference最初のオブジェクトを返す
45
677.5
item(index)PageReferenceインデックスまたは名前で指定したオブジェクトを返す
index 数値型, 文字列型 番号もしくは名前
45
677.5
itemByID(id)PageReferenceIDで指定したオブジェクトを返す
id 数値型 オブジェクトのID
45
677.5
itemByName(name)PageReference名前で指定したオブジェクトを返す
name 文字列型 名前
45
677.5
itemByRange(from, to)PageReference範囲で指定したオブジェクトを返す
from PageReference, 数値型, 文字列型 範囲の開始
to PageReference, 数値型, 文字列型 範囲の終了
45
677.5
lastItem()PageReference最後のオブジェクトを返す
45
677.5
middleItem()PageReference
45
677.5
nextItem(obj)PageReference一つ後のオブジェクトを返す
obj PageReference 位置の基準になるオブジェクト
45
677.5
previousItem(obj)PageReference一つ前のオブジェクトを返す
obj PageReference 位置の基準になるオブジェクト
45
677.5
toSource()文字列型