BookContent(ブック内のドキュメント)のコレクション
Ver. | プロパティ名 | R/O | 値 | 説明 |
---|---|---|---|---|
length | ○ | 数値 | オブジェクト数 |
Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||
---|---|---|---|---|---|
パラメータ | 値 | パラメータの説明 | |||
add(fullName, [at], [withProperties]) | BookContent | ドキュメントをブックに追加する | |||
fullName | ファイル | ファイルのフルパス名 | |||
[at] | 数値 | 位置 (既定値=-1) | |||
[withProperties] | Object | プロパティを設定 | |||
anyItem() | BookContent | どれかのオブジェクトを返す | |||
count() | 数値 | 要素数を返す | |||
everyItem() | Array( BookContent ) | 全てのオブジェクトを返す | |||
firstItem() | BookContent | 最初のオブジェクトを返す | |||
item(index) | BookContent | インデックスまたは名前で指定したオブジェクトを返す | |||
index | 数値, 文字列値 | インデックスまたは名前 | |||
itemByID(id) | BookContent | IDで指定したオブジェクトを返す | |||
id | 数値 | ||||
itemByName(name) | BookContent | 名前で指定したオブジェクトを返す | |||
name | 文字列値 | ||||
itemByRange(from, to) | Array( BookContent ) | 範囲で指定したオブジェクトを返す | |||
from | BookContent, 数値, 文字列値 | 範囲の開始 | |||
to | BookContent, 数値, 文字列値 | 範囲の終了 | |||
lastItem() | BookContent | 最後のオブジェクトを返す | |||
middleItem() | BookContent | 真ん中のオブジェクトを返す | |||
nextItem(obj) | BookContent | 一つ後のオブジェクトを返す | |||
obj | BookContent | 位置の基準になるオブジェクト | |||
previousItem(obj) | BookContent | 一つ前のオブジェクトを返す | |||
obj | BookContent | 位置の基準になるオブジェクト | |||
toSource() | 文字列値 | ソースコードを表す文字列を返す |
ブック内のドキュメント
Ver. | プロパティ | R/O | 値 |
---|---|---|---|
parent | ○ | Book | |
eventListeners | ○ | EventListeners | |
events | ○ | Events |
Ver. | プロパティ名 | R/O | 値 | 説明 | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
date | ○ | 日時値 | 更新日時 | |||||||||||||||||||||||||||||
documentPageRange | ○ | 文字列値 | ページ範囲 | |||||||||||||||||||||||||||||
filePath | ○ | ファイル | ファイルパス | |||||||||||||||||||||||||||||
fullName | ○ | ファイル | フルパス名 | |||||||||||||||||||||||||||||
id | ○ | 数値 | オブジェクトのID | |||||||||||||||||||||||||||||
index | ○ | 数値 | インデックス | |||||||||||||||||||||||||||||
isValid | ○ | 真偽値 | オブジェクトが有効かどうか | |||||||||||||||||||||||||||||
label | 文字列値 | スクリプトラベル | ||||||||||||||||||||||||||||||
name | ○ | 文字列値 | ファイル名 | |||||||||||||||||||||||||||||
properties | Object | |||||||||||||||||||||||||||||||
size | ○ | 数値 | ファイルサイズ | |||||||||||||||||||||||||||||
status | ○ |
BookContentStatus
| 内容のステータス |
Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ | 値 | パラメータの説明 | |||||||||||||||||||||||||||||||
addEventListener(eventType, handler, [captures]) | EventListener | EventListenerを作成 | |||||||||||||||||||||||||||||||
eventType | 文字列値 | ||||||||||||||||||||||||||||||||
handler | ファイル, JavaScript関数 | ||||||||||||||||||||||||||||||||
[captures] | 真偽値 | (廃止) | |||||||||||||||||||||||||||||||
extractLabel(key) | 文字列値 | キーに関連づけられた値を取得 | |||||||||||||||||||||||||||||||
key | 文字列値 | キー | |||||||||||||||||||||||||||||||
getElements() | Array( BookContent ) | オブジェクト参照を返す | |||||||||||||||||||||||||||||||
insertLabel(key, value) | なし | キーに関連づけられた値を設定 | |||||||||||||||||||||||||||||||
key | 文字列値 | キー | |||||||||||||||||||||||||||||||
value | 文字列値 | 値 | |||||||||||||||||||||||||||||||
move([to], [reference]) | BookContent | 前後への移動 | |||||||||||||||||||||||||||||||
[to] |
LocationOptions
| 移動先 (既定値=LocationOptions.AT_END) | |||||||||||||||||||||||||||||||
[reference] | BookContent | 位置の基準になるオブジェクト | |||||||||||||||||||||||||||||||
preflight([to], [autoOpen]) | なし | プリフライトを実行 | |||||||||||||||||||||||||||||||
[to] | ファイル | レポートファイルの保存ファイル名 | |||||||||||||||||||||||||||||||
[autoOpen] | 真偽値 | 実行後にレポートファイルを開くか (既定値=false) | |||||||||||||||||||||||||||||||
remove() | なし | 削除 | |||||||||||||||||||||||||||||||
removeEventListener(eventType, handler, [captures]) | 真偽値 | EventListenerを削除 | |||||||||||||||||||||||||||||||
eventType | 文字列値 | ||||||||||||||||||||||||||||||||
handler | ファイル, JavaScript関数 | ||||||||||||||||||||||||||||||||
[captures] | 真偽値 | (廃止) | |||||||||||||||||||||||||||||||
replace(using) | BookContent | ドキュメントの置換 | |||||||||||||||||||||||||||||||
using | ファイル | フルパス名 | |||||||||||||||||||||||||||||||
synchronize() | なし | ブックを同期 | |||||||||||||||||||||||||||||||
toSource() | 文字列値 | ソースコードを表す文字列を返す | |||||||||||||||||||||||||||||||
toSpecifier() | 文字列値 | Retrieves the object specifier. |