InDesign Hacking with JavaScript 概要

Object


			    
			       callScripts(<String> sarray)

スクリプト名の配列順にスクリプトを実行する

String


			    
			       endBenchMark(<Long> starttime, <String> prefix)

ベンチマーク用に時間差を返す

Object[]


			    
			       findContentFromObjectByStyles(<Object> obj, <String[]> pnames, <String> type)

オブジェクトから指定の段落スタイルを検索し、コンテンツを返す

Object[]


			    
			       findContentFromPageByStyles(<Page> page, <String[]> pnames, <String> type)

ページから指定の段落スタイルを検索し、コンテンツを返す

Object[]


			    
			       findMasterSpread(<Object> spreads, <String> search, <String> type)

スプレッドから指定の文字列を検索し、スプレッドの配列を返す

TextFrame[]


			    
			       findStringFromObject(<Object> obj, <String> search)

オブジェクトから指定の文字列を検索し、テキストフレームの配列を返す

TextFrame[]


			    
			       findStringFromObjectWithGroup(<Object> obj, <String> search)

グループオブジェクトから指定の文字列を検索し、テキストフレームの配列を返す

CharacterStyle[]


			    
			       getAllCharacterStyles(<Document> document)

グループを含め、全文字スタイルオブジェクトの配列を返す

Nothing


			    
			       getAllCharacterStylesFromGroup(<CharacterStyleGroups> cgroups, <CharacterStyle> array)

getAllCharacterStylesの実体として、再帰で文字スタイルグループを処理する

CellStyle


			    
			       getCellStyleByName(<Document> document, <String> name)

指定の名前のセルスタイルオブジェクトを返す

CellStyle


			    
			       getCellStyleByNameFromGroup(<CellStyleGroups> egroups, <String> name)

指定の名前のセルスタイルオブジェクトを返す(セルスタイルグループ)

CellStyle[]


			    
			       getCellStyles(<Document> document)

セルスタイルのハッシュリストを返す

CharacterStyle


			    
			       getCharacterStyleByName(<Document> document, <String> name)

指定の名前の文字スタイルオブジェクトを返す

CharacterStyle


			    
			       getCharacterStyleByNameFromGroup(<CharacterStyleGroups> cgroups, <String> name)

指定の名前の文字スタイルオブジェクトを返す(文字スタイルグループ)

CharacterStyle[]


			    
			       getCharacterStyles(<Document> document)

文字スタイルのハッシュリストを返す

String


			    
			       getCSPath()

スクリプトフォルダのパスを返す

Float


			    
			       getCSVersion()

InDesignのCSバージョンを返す

String


			    
			       getDocAttr(<Document> document, <String> attrname)

ドキュメントのルート要素の属性値を取得する

Long


			    
			       getEndStoryPoint(<XMLElement|XMLItem> element)

XML要素のストーリーオブジェクト上の終端オフセット値を返す

insertionPoint


			    
			       getEndStoryPoint2(<XMLElement|XMLItem> element)

XML要素のストーリーオブジェクト上の終端オフセット値を返す。終端オフセットの文字が65279(タグ等)であれば、さらに前にさかのぼる

insertionPoint


			    
			       getEndStoryPoint3(<XMLElement|XMLItem> element)

XML要素のストーリーオブジェクト上の終端オフセット値を返す。終端オフセットの文字が65279(タグ等)であれば、さらに後ろを探す

insertionPoint


			    
			       getEndStoryPoint4(<XMLElement|XMLItem> element)

XML要素のストーリーオブジェクト上の終端オフセット値を返す。終端オフセットの文字が65279(タグ等)であれば、さらに前にさかのぼる

String


			    
			       getFilePath(<Document> document, <String> filename)

指定のファイルを探すのに1つ上のディレクトリも探す

File


			    
			       getHwjStateFileObj(<String> name)

~/.hwj-Scripts内設定ファイルのオブジェクトを取得する

String


			    
			       getMetaInfo(<Document> document, <String> key)

最初に登場するコメントをメタ情報として取得し、指定属性名の値を返す

ObjectStyle


			    
			       getObjectStyleByName(<Document> document, <String> name)

指定の名前のオブジェクトスタイルオブジェクトを返す

ObjectStyle


			    
			       getObjectStyleByNameFromGroup(<ObjectStyleGroups> ogroups, <String> name)

指定の名前のオブジェクトスタイルオブジェクトを返す(オブジェクトスタイルグループ)

ObjectStyle[]


			    
			       getObjectStyles(<Document> document)

オブジェクトスタイルのハッシュリストを返す

PageItem


			    
			       getPageItem(<Page> page, label)

ページまたはマスターページ中のページアイテムのうち、指定ラベルを持つオブジェクトを返す。本来はitemメソッドで取れるはずなのだが、CSのバグがある模様

ParagraphStyle


			    
			       getParagraphStyleByName(<Document> document, <String> name)

指定の名前の段落スタイルオブジェクトを返す

ParagraphStyle


			    
			       getParagraphStyleByNameFromGroup(<ParagraphStyleGroups> pgroups, <String> name)

指定の名前の段落スタイルオブジェクトを返す(段落スタイルグループ)

ParagraphStyle[]


			    
			       getParagraphStyles(<Document> document)

段落スタイルのハッシュリストを返す

TableStyle


			    
			       getTableStyleByName(<Document> document, <String> name)

指定の名前の表スタイルオブジェクトを返す

TableStyle


			    
			       getTableStyleByNameFromGroup(<TableStyleGroups> tgroups, <String> name)

指定の名前の表スタイルオブジェクトを返す(表スタイルグループ)

TableStyle[]


			    
			       getTableStyles(<Document> document)

表スタイルのハッシュリストを返す

Nothing


			    
			       insertItemMark(<Document> document, <String[]> pnames, <String> prefix, <String> cname, <String> postfix)

特定の段落スタイルに指定の先頭文字を挿入する

Nothing


			    
			       insertPrefix(<Document> document, <Object> obj, <String> chars, <String> cname, <String> postfix, <boolean> remove)

コンテンツオブジェクトの前に文字列を挿入する

Object


			    
			       locateObject(<Document> document, <Page> page, <Object> obj, <Long[4]> unit)

オブジェクトをコピーして指定の位置に配置する

Nothing


			    
			       overridePageItems(<Page> page, <String> items)

ページ中のマスターページアイテムのうち、指定ラベルを持つオブジェクトをオーバライドする

Float


			    
			       pttomm(<Float> pt)

ポイント値をmm値に変換して返す

String[]


			    
			       readHwjStateFile(<String> fObj)

ファイルオブジェクトから各行を配列で返し、オブジェクトを閉じる

Nothing


			    
			       removeGroupObjectByLabel(<Document> document, <String> name)

指定のラベルを持つグループを削除する

Nothing


			    
			       revertMmMode(<Document> document, <Long[2]> unit)

mmから単位を元に戻す

Long


			    
			       setCharacterStyle(<Document> document, <Object> obj, <String> splitter, <String> cname, <boolean> limit)

区切り文字が現れるまで文字スタイルを割り当てる

Nothing


			    
			       showInteraction(<Boolean> flag)

ダイアログ表示モードの有無を指定する

Long


			    
			       startBenchMark()

ベンチマーク用に開始時間を返す

Long[2]


			    
			       toMmMode(<Document> document)

mmに単位を変更する

boolean


			    
			       writeHwjStateFile(<String> fObj, array)

ファイルオブジェクトから各行を配列で返し、オブジェクトを閉じる

関数の要約
`Object`	`callScripts(<String> sarray)` スクリプト名の配列順にスクリプトを実行する
`String`	`endBenchMark(<Long> starttime, <String> prefix)` ベンチマーク用に時間差を返す
`Object[]`	`findContentFromObjectByStyles(<Object> obj, <String[]> pnames, <String> type)` オブジェクトから指定の段落スタイルを検索し、コンテンツを返す
`Object[]`	`findContentFromPageByStyles(<Page> page, <String[]> pnames, <String> type)` ページから指定の段落スタイルを検索し、コンテンツを返す
`Object[]`	`findMasterSpread(<Object> spreads, <String> search, <String> type)` スプレッドから指定の文字列を検索し、スプレッドの配列を返す
`TextFrame[]`	`findStringFromObject(<Object> obj, <String> search)` オブジェクトから指定の文字列を検索し、テキストフレームの配列を返す
`TextFrame[]`	`findStringFromObjectWithGroup(<Object> obj, <String> search)` グループオブジェクトから指定の文字列を検索し、テキストフレームの配列を返す
`CharacterStyle[]`	`getAllCharacterStyles(<Document> document)` グループを含め、全文字スタイルオブジェクトの配列を返す
`Nothing`	`getAllCharacterStylesFromGroup(<CharacterStyleGroups> cgroups, <CharacterStyle> array)` getAllCharacterStylesの実体として、再帰で文字スタイルグループを処理する
`CellStyle`	`getCellStyleByName(<Document> document, <String> name)` 指定の名前のセルスタイルオブジェクトを返す
`CellStyle`	`getCellStyleByNameFromGroup(<CellStyleGroups> egroups, <String> name)` 指定の名前のセルスタイルオブジェクトを返す(セルスタイルグループ)
`CellStyle[]`	`getCellStyles(<Document> document)` セルスタイルのハッシュリストを返す
`CharacterStyle`	`getCharacterStyleByName(<Document> document, <String> name)` 指定の名前の文字スタイルオブジェクトを返す
`CharacterStyle`	`getCharacterStyleByNameFromGroup(<CharacterStyleGroups> cgroups, <String> name)` 指定の名前の文字スタイルオブジェクトを返す(文字スタイルグループ)
`CharacterStyle[]`	`getCharacterStyles(<Document> document)` 文字スタイルのハッシュリストを返す
`String`	`getCSPath()` スクリプトフォルダのパスを返す
`Float`	`getCSVersion()` InDesignのCSバージョンを返す
`String`	`getDocAttr(<Document> document, <String> attrname)` ドキュメントのルート要素の属性値を取得する
`Long`	`getEndStoryPoint(<XMLElement\|XMLItem> element)` XML要素のストーリーオブジェクト上の終端オフセット値を返す
`insertionPoint`	`getEndStoryPoint2(<XMLElement\|XMLItem> element)` XML要素のストーリーオブジェクト上の終端オフセット値を返す。終端オフセットの文字が65279(タグ等)であれば、さらに前にさかのぼる
`insertionPoint`	`getEndStoryPoint3(<XMLElement\|XMLItem> element)` XML要素のストーリーオブジェクト上の終端オフセット値を返す。終端オフセットの文字が65279(タグ等)であれば、さらに後ろを探す
`insertionPoint`	`getEndStoryPoint4(<XMLElement\|XMLItem> element)` XML要素のストーリーオブジェクト上の終端オフセット値を返す。終端オフセットの文字が65279(タグ等)であれば、さらに前にさかのぼる
`String`	`getFilePath(<Document> document, <String> filename)` 指定のファイルを探すのに1つ上のディレクトリも探す
`File`	`getHwjStateFileObj(<String> name)` ~/.hwj-Scripts内設定ファイルのオブジェクトを取得する
`String`	`getMetaInfo(<Document> document, <String> key)` 最初に登場するコメントをメタ情報として取得し、指定属性名の値を返す
`ObjectStyle`	`getObjectStyleByName(<Document> document, <String> name)` 指定の名前のオブジェクトスタイルオブジェクトを返す
`ObjectStyle`	`getObjectStyleByNameFromGroup(<ObjectStyleGroups> ogroups, <String> name)` 指定の名前のオブジェクトスタイルオブジェクトを返す(オブジェクトスタイルグループ)
`ObjectStyle[]`	`getObjectStyles(<Document> document)` オブジェクトスタイルのハッシュリストを返す
`PageItem`	`getPageItem(<Page> page, label)` ページまたはマスターページ中のページアイテムのうち、指定ラベルを持つオブジェクトを返す。本来はitemメソッドで取れるはずなのだが、CSのバグがある模様
`ParagraphStyle`	`getParagraphStyleByName(<Document> document, <String> name)` 指定の名前の段落スタイルオブジェクトを返す
`ParagraphStyle`	`getParagraphStyleByNameFromGroup(<ParagraphStyleGroups> pgroups, <String> name)` 指定の名前の段落スタイルオブジェクトを返す(段落スタイルグループ)
`ParagraphStyle[]`	`getParagraphStyles(<Document> document)` 段落スタイルのハッシュリストを返す
`TableStyle`	`getTableStyleByName(<Document> document, <String> name)` 指定の名前の表スタイルオブジェクトを返す
`TableStyle`	`getTableStyleByNameFromGroup(<TableStyleGroups> tgroups, <String> name)` 指定の名前の表スタイルオブジェクトを返す(表スタイルグループ)
`TableStyle[]`	`getTableStyles(<Document> document)` 表スタイルのハッシュリストを返す
`Nothing`	`insertItemMark(<Document> document, <String[]> pnames, <String> prefix, <String> cname, <String> postfix)` 特定の段落スタイルに指定の先頭文字を挿入する
`Nothing`	`insertPrefix(<Document> document, <Object> obj, <String> chars, <String> cname, <String> postfix, <boolean> remove)` コンテンツオブジェクトの前に文字列を挿入する
`Object`	`locateObject(<Document> document, <Page> page, <Object> obj, <Long[4]> unit)` オブジェクトをコピーして指定の位置に配置する
`Nothing`	`overridePageItems(<Page> page, <String> items)` ページ中のマスターページアイテムのうち、指定ラベルを持つオブジェクトをオーバライドする
`Float`	`pttomm(<Float> pt)` ポイント値をmm値に変換して返す
`String[]`	`readHwjStateFile(<String> fObj)` ファイルオブジェクトから各行を配列で返し、オブジェクトを閉じる
`Nothing`	`removeGroupObjectByLabel(<Document> document, <String> name)` 指定のラベルを持つグループを削除する
`Nothing`	`revertMmMode(<Document> document, <Long[2]> unit)` mmから単位を元に戻す
`Long`	`setCharacterStyle(<Document> document, <Object> obj, <String> splitter, <String> cname, <boolean> limit)` 区切り文字が現れるまで文字スタイルを割り当てる
`Nothing`	`showInteraction(<Boolean> flag)` ダイアログ表示モードの有無を指定する
`Long`	`startBenchMark()` ベンチマーク用に開始時間を返す
`Long[2]`	`toMmMode(<Document> document)` mmに単位を変更する
`boolean`	`writeHwjStateFile(<String> fObj, array)` ファイルオブジェクトから各行を配列で返し、オブジェクトを閉じる

libCommon.jsx

要約