BuildingBlocks

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

プロパティ

Ver.プロパティ名R/O値説明
[12][13][14][15]
[16][17][18][19]		 length○ 数値オブジェクト数

メソッド

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

BuildingBlock

ハイパーリンクの定義

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

Ver.プロパティR/O値
[12][13][14][15]
[16][17][18][19]		 parent○ CrossReferenceFormat
[12][13][14][15]
[16][17][18][19]		 eventListeners○ EventListeners
[12][13][14][15]
[16][17][18][19]		 events○ Events

プロパティ

Ver.プロパティ名R/O値説明
[12][13][14][15]
[16][17][18][19]		 appliedCharacterStyle CharacterStyle適用される文字スタイル
[12][13][14][15]
[16][17][18][19]		 appliedDelimiter 文字列値Delimiter character for paragraph text and full paragraph building blocks. It is ignored for other types of building blocks.
[12][13][14][15]
[16][17][18][19]		 blockType BuildingBlockTypes
BuildingBlockTypes
Ver.値10進数/文字列説明
[12][13][14][15]
[16][17][18][19]		BOOKMARK_NAME_BUILDING_BLOCK1650614894
bbbn		Bookmark name building block type.
[12][13][14][15]
[16][17][18][19]		CHAPTER_NUMBER_BUILDING_BLOCK1650615150
bbcn		Chapter number building block type.
[12][13][14][15]
[16][17][18][19]		CUSTOM_STRING_BUILDING_BLOCK1650615155
bbcs		Custom string building block type.
[12][13][14][15]
[16][17][18][19]		FILE_NAME_BUILDING_BLOCK1650615918
bbfn		File name building block type.
[12][13][14][15]
[16][17][18][19]		FULL_PARAGRAPH_BUILDING_BLOCK1650615920
bbfp		Full paragraph building block type.
[12][13][14][15]
[16][17][18][19]		PAGE_NUMBER_BUILDING_BLOCK1650618478
bbpn		Page number building block type.
[12][13][14][15]
[16][17][18][19]		PARAGRAPH_NUMBER_BUILDING_BLOCK1651533678
bpgn		Paragraph number building block type.
[12][13][14][15]
[16][17][18][19]		PARAGRAPH_TEXT_BUILDING_BLOCK1650618484
bbpt		Paragraph text building block type.
Type of the building block.
[12][13][14][15]
[16][17][18][19]		 customText 文字列値Building block custom text. Currently this is only useful in custom string building block. It is ignored for other types of building blocks.
[12][13][14][15]
[16][17][18][19]		 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.
[12][13][14][15]
[16][17][18][19]		 index○ 数値インデックス
[12][13][14][15]
[16][17][18][19]		 isValid○ 真偽値オブジェクトが有効かどうか
[12][13][14][15]
[16][17][18][19]		 properties Object

メソッド

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