BookContents

BookContent（ブック内のドキュメント）のコレクション

プロパティ

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

メソッド

Ver.メソッドの書式戻り値メソッドの説明
　　パラメータ値パラメータの説明
[18][19][20][21] add(fullName, [at], [withProperties]) BookContentドキュメントをブックに追加する
fullName ファイルファイルのフルパス名
[at] 数値位置 (既定値=-1)
[withProperties] Objectプロパティを設定
[18][19][20][21] anyItem() BookContentどれかのオブジェクトを返す
[18][19][20][21] count() 数値要素数を返す
[18][19][20][21] everyItem() BookContent (Array)全てのオブジェクトを返す
[18][19][20][21] firstItem() BookContent最初のオブジェクトを返す
[18][19][20][21] item(index) BookContentインデックスまたは名前で指定したオブジェクトを返す
index 数値, 文字列値インデックスまたは名前
[18][19][20][21] itemByID(id) BookContentIDで指定したオブジェクトを返す
id 数値
[18][19][20][21] itemByName(name) BookContent名前で指定したオブジェクトを返す
name 文字列値
[18][19][20][21] itemByRange(from, to) BookContent (Array)範囲で指定したオブジェクトを返す
from BookContent, 数値, 文字列値範囲の開始
to BookContent, 数値, 文字列値範囲の終了
[18][19][20][21] lastItem() BookContent最後のオブジェクトを返す
[18][19][20][21] middleItem() BookContent真ん中のオブジェクトを返す
[18][19][20][21] nextItem(obj) BookContent一つ後のオブジェクトを返す
obj BookContent位置の基準になるオブジェクト
[18][19][20][21] previousItem(obj) BookContent一つ前のオブジェクトを返す
obj BookContent位置の基準になるオブジェクト
[18][19][20][21] toSource() 文字列値ソースコードを表す文字列を返す

BookContent

ブック内のドキュメント

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

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

プロパティ

Ver.プロパティ名R/O値説明
[18][19][20][21] date○ 日時値更新日時
[18][19][20][21] documentPageRange○ 文字列値ページ範囲
[18][19][20][21] filePath○ ファイルファイルパス
[18][19][20][21] fullName○ ファイルフルパス名
[18][19][20][21] id○ 数値オブジェクトのID
[18][19][20][21] index○ 数値インデックス
[18][19][20][21] isValid○ 真偽値オブジェクトが有効かどうか
[18][19][20][21] label 文字列値スクリプトラベル
[18][19][20][21] name○ 文字列値ファイル名
[18][19][20][21] properties Object
[18][19][20][21] size○ 数値ファイルサイズ
[18][19][20][21] status○ BookContentStatus
BookContentStatus
Ver.プロパティ値/管理用文字説明
[18][19][20][21]DOCUMENT_IN_USE1148150601
DocI		ドキュメントは使用中またはロックされています。
[18][19][20][21]DOCUMENT_IS_OPEN1148150607
DocO		ドキュメントが開いています。
[18][19][20][21]DOCUMENT_OUT_OF_DATE1148150596
DocD		ドキュメントは、ブック外で変更されました。
[18][19][20][21]MISSING_DOCUMENT1148150605
DocM		ドキュメントが見つかりません。
[18][19][20][21]NORMAL1852797549
norm		ドキュメントは使用可能です。
内容のステータス

メソッド

Ver.メソッドの書式戻り値メソッドの説明
　　パラメータ値パラメータの説明
[18][19][20][21] addEventListener(eventType, handler, [captures]) EventListenerEventListenerを作成
eventType 文字列値
handler ファイル, JavaScript関数
[captures] 真偽値（廃止）
[18][19][20][21] extractLabel(key) 文字列値キーに関連づけられた値を取得
key 文字列値キー
[18][19][20][21] getElements() Array( BookContent )オブジェクト参照を返す
[18][19][20][21] insertLabel(key, value) なしキーに関連づけられた値を設定
key 文字列値キー
value 文字列値値
[18][19][20][21] move([to], [reference]) BookContent前後への移動
[to] LocationOptions
LocationOptions
Ver.プロパティ値/管理用文字説明
[18][19][20][21]AFTER1634104421
afte		後
[18][19][20][21]AT_BEGINNING1650945639
bgng		先頭
[18][19][20][21]AT_END1701733408
end 		最後
[18][19][20][21]BEFORE1650812527
befo		前
[18][19][20][21]UNKNOWN1433299822
Unkn		No location
移動先 (既定値=LocationOptions.AT_END)
[reference] BookContent位置の基準になるオブジェクト
[18][19][20][21] preflight([to], [autoOpen]) なしプリフライトを実行
[to] ファイルレポートファイルの保存ファイル名
[autoOpen] 真偽値実行後にレポートファイルを開くか (既定値=false)
[18][19][20][21] remove() なし削除
[18][19][20][21] removeEventListener(eventType, handler, [captures]) 真偽値EventListenerを削除
eventType 文字列値
handler ファイル, JavaScript関数
[captures] 真偽値（廃止）
[18][19][20][21] replace(using) BookContentドキュメントの置換
using ファイルフルパス名
[18][19][20][21] synchronize() なしブックを同期
[18][19][20][21] toSource() 文字列値ソースコードを表す文字列を返す
[18][19][20][21] toSpecifier() 文字列値Retrieves the object specifier.