BuildingBlocks

BuildingBlock（ハイパーリンクの定義）のコレクション

プロパティ

Ver.プロパティ名R/O値説明
[18][19][20][21] length○ 数値オブジェクト数

メソッド

Ver.メソッドの書式戻り値メソッドの説明
　　パラメータ値パラメータの説明
[18][19][20][21] add(blockType, [appliedCharacterStyle], [customText], [withProperties]) BuildingBlock新しいオブジェクトを作成し、それを返す
blockType BuildingBlockTypes
BuildingBlockTypes
Ver.プロパティ値/管理用文字説明
[18][19][20][21]BOOKMARK_NAME_BUILDING_BLOCK1650614894
bbbn		Bookmark name building block type.
[18][19][20][21]CHAPTER_NUMBER_BUILDING_BLOCK1650615150
bbcn		Chapter number building block type.
[18][19][20][21]CUSTOM_STRING_BUILDING_BLOCK1650615155
bbcs		Custom string building block type.
[18][19][20][21]FILE_NAME_BUILDING_BLOCK1650615918
bbfn		File name building block type.
[18][19][20][21]FULL_PARAGRAPH_BUILDING_BLOCK1650615920
bbfp		Full paragraph building block type.
[18][19][20][21]PAGE_NUMBER_BUILDING_BLOCK1650618478
bbpn		Page number building block type.
[18][19][20][21]PARAGRAPH_NUMBER_BUILDING_BLOCK1651533678
bpgn		Paragraph number building block type.
[18][19][20][21]PARAGRAPH_TEXT_BUILDING_BLOCK1650618484
bbpt		Paragraph text building block type.
[appliedCharacterStyle] CharacterStyle適用される文字スタイル
[customText] 文字列値
[withProperties] Objectプロパティを設定
[18][19][20][21] anyItem() BuildingBlockどれかのオブジェクトを返す
[18][19][20][21] count() 数値要素数を返す
[18][19][20][21] everyItem() BuildingBlock (Array)全てのオブジェクトを返す
[18][19][20][21] firstItem() BuildingBlock最初のオブジェクトを返す
[18][19][20][21] item(index) BuildingBlockインデックスまたは名前で指定したオブジェクトを返す
index 数値, 文字列値インデックスまたは名前
[18][19][20][21] itemByRange(from, to) BuildingBlock (Array)範囲で指定したオブジェクトを返す
from BuildingBlock, 数値, 文字列値範囲の開始
to BuildingBlock, 数値, 文字列値範囲の終了
[18][19][20][21] lastItem() BuildingBlock最後のオブジェクトを返す
[18][19][20][21] middleItem() BuildingBlock真ん中のオブジェクトを返す
[18][19][20][21] nextItem(obj) BuildingBlock一つ後のオブジェクトを返す
obj BuildingBlock位置の基準になるオブジェクト
[18][19][20][21] previousItem(obj) BuildingBlock一つ前のオブジェクトを返す
obj BuildingBlock位置の基準になるオブジェクト
[18][19][20][21] toSource() 文字列値ソースコードを表す文字列を返す

BuildingBlock

ハイパーリンクの定義

プロパティ（parentとその逆）

Ver.プロパティR/O値
[18][19][20][21] parent○ CrossReferenceFormat
[18][19][20][21] eventListeners○ EventListeners
[18][19][20][21] events○ Events

プロパティ

Ver.プロパティ名R/O値説明
[18][19][20][21] appliedCharacterStyle CharacterStyle適用される文字スタイル
[18][19][20][21] appliedDelimiter 文字列値Delimiter character for paragraph text and full paragraph building blocks. It is ignored for other types of building blocks.
[18][19][20][21] blockType BuildingBlockTypes
BuildingBlockTypes
Ver.プロパティ値/管理用文字説明
[18][19][20][21]BOOKMARK_NAME_BUILDING_BLOCK1650614894
bbbn		Bookmark name building block type.
[18][19][20][21]CHAPTER_NUMBER_BUILDING_BLOCK1650615150
bbcn		Chapter number building block type.
[18][19][20][21]CUSTOM_STRING_BUILDING_BLOCK1650615155
bbcs		Custom string building block type.
[18][19][20][21]FILE_NAME_BUILDING_BLOCK1650615918
bbfn		File name building block type.
[18][19][20][21]FULL_PARAGRAPH_BUILDING_BLOCK1650615920
bbfp		Full paragraph building block type.
[18][19][20][21]PAGE_NUMBER_BUILDING_BLOCK1650618478
bbpn		Page number building block type.
[18][19][20][21]PARAGRAPH_NUMBER_BUILDING_BLOCK1651533678
bpgn		Paragraph number building block type.
[18][19][20][21]PARAGRAPH_TEXT_BUILDING_BLOCK1650618484
bbpt		Paragraph text building block type.
Type of the building block.
[18][19][20][21] customText 文字列値Building block custom text. Currently this is only useful in custom string building block. It is ignored for other types of building blocks.
[18][19][20][21] includeDelimiter 真偽値If true, the source generated for the building block includes the delimiter. It is ignored if no delimiter is specified on the building block.
[18][19][20][21] index○ 数値インデックス
[18][19][20][21] isValid○ 真偽値オブジェクトが有効かどうか
[18][19][20][21] properties Object

メソッド

Ver.メソッドの書式戻り値メソッドの説明
　　パラメータ値パラメータの説明
[18][19][20][21] addEventListener(eventType, handler, [captures]) EventListenerEventListenerを作成
eventType 文字列値
handler ファイル, JavaScript関数
[captures] 真偽値（廃止）
[18][19][20][21] getElements() Array( BuildingBlock )オブジェクト参照を返す
[18][19][20][21] remove() なし削除
[18][19][20][21] removeEventListener(eventType, handler, [captures]) 真偽値EventListenerを削除
eventType 文字列値
handler ファイル, JavaScript関数
[captures] 真偽値（廃止）
[18][19][20][21] toSource() 文字列値ソースコードを表す文字列を返す
[18][19][20][21] toSpecifier() 文字列値Retrieves the object specifier.