XMLElements

XMLElement（An XML element.）のコレクション

プロパティ

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

メソッド

Ver.メソッドの書式戻り値メソッドの説明
　　パラメータ値パラメータの説明
[18][19][20][21] add(markupTag, [xmlContent], [withProperties]) XMLElement新しいオブジェクトを作成し、それを返す
markupTag 文字列値, XMLTagXMLタグ
[xmlContent] Text, Story, PageItem, Movie, Sound, Graphic, Table, Cell関連付けるテキスト
[withProperties] Objectプロパティを設定
[18][19][20][21] anyItem() XMLElementどれかのオブジェクトを返す
[18][19][20][21] count() 数値要素数を返す
[18][19][20][21] everyItem() XMLElement (Array)全てのオブジェクトを返す
[18][19][20][21] firstItem() XMLElement最初のオブジェクトを返す
[18][19][20][21] item(index) XMLElementインデックスまたは名前で指定したオブジェクトを返す
index 数値, 文字列値インデックスまたは名前
[18][19][20][21] itemByID(id) XMLElementIDで指定したオブジェクトを返す
id 数値
[18][19][20][21] itemByRange(from, to) XMLElement (Array)範囲で指定したオブジェクトを返す
from XMLElement, 数値, 文字列値範囲の開始
to XMLElement, 数値, 文字列値範囲の終了
[18][19][20][21] lastItem() XMLElement最後のオブジェクトを返す
[18][19][20][21] middleItem() XMLElement真ん中のオブジェクトを返す
[18][19][20][21] nextItem(obj) XMLElement一つ後のオブジェクトを返す
obj XMLElement位置の基準になるオブジェクト
[18][19][20][21] previousItem(obj) XMLElement一つ前のオブジェクトを返す
obj XMLElement位置の基準になるオブジェクト
[18][19][20][21] toSource() 文字列値ソースコードを表す文字列を返す

XMLElement

An XML element.

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

Ver.プロパティR/O値
[18][19][20][21] parent○ Document, XMLElement
[18][19][20][21] parentStory○ Story
[18][19][20][21] cells○ Cells
[18][19][20][21] characters○ Characters
[18][19][20][21] epss○ EPSs
[18][19][20][21] eventListeners○ EventListeners
[18][19][20][21] events○ Events
[18][19][20][21] graphics○ Graphics
[18][19][20][21] images○ Images
[18][19][20][21] insertionPoints○ InsertionPoints
[18][19][20][21] lines○ Lines
[18][19][20][21] pageItems○ PageItems
[18][19][20][21] paragraphs○ Paragraphs
[18][19][20][21] pdfs○ PDFs
[18][19][20][21] picts○ PICTs
[18][19][20][21] stories○ Stories
[18][19][20][21] svgs○ SVGs
[18][19][20][21] tables○ Tables
[18][19][20][21] textColumns○ TextColumns
[18][19][20][21] texts○ Texts
[18][19][20][21] textStyleRanges○ TextStyleRanges
[18][19][20][21] wmfs○ WMFs
[18][19][20][21] words○ Words
[18][19][20][21] xmlAttributes○ XMLAttributes
[18][19][20][21] xmlComments○ XMLComments
[18][19][20][21] xmlElements○ XMLElements
[18][19][20][21] xmlInstructions○ XMLInstructions
[18][19][20][21] xmlItems○ XMLItems

プロパティ

Ver.プロパティ名R/O値説明
[18][19][20][21] contents 文字列値, SpecialCharacters内容（テキスト）
[18][19][20][21] id○ 数値オブジェクトのID
[18][19][20][21] index○ 数値インデックス
[18][19][20][21] isValid○ 真偽値オブジェクトが有効かどうか
[18][19][20][21] markupTag XMLTag, 文字列値The XML tag applied to the element. Can also accept: String.
[18][19][20][21] properties Object
[18][19][20][21] storyOffset○ InsertionPointThe insertion point before the table in the story containing the table.
[18][19][20][21] xmlContent○ Text, Story, PageItem, Movie, Sound, Graphic, Table, CellThe text content or page item referred to by the element.

メソッド

Ver.メソッドの書式戻り値メソッドの説明
　　パラメータ値パラメータの説明
[18][19][20][21] addEventListener(eventType, handler, [captures]) EventListenerEventListenerを作成
eventType 文字列値
handler ファイル, JavaScript関数
[captures] 真偽値（廃止）
[18][19][20][21] applyCellStyle(using, [clearingOverrides]) なしセルスタイルを適用
using 文字列値, CellStyleセルスタイル
[clearingOverrides] 真偽値既存の属性を消去するか (既定値=true)
[18][19][20][21] applyCharacterStyle(using) なし文字スタイルを適用
using 文字列値, CharacterStyle文字スタイル
[18][19][20][21] applyObjectStyle(using, [clearingOverrides], [clearingOverridesThroughRootObjectStyle]) なしオブジェクトスタイルを適用
using 文字列値, ObjectStyleオブジェクトスタイル
[clearingOverrides] 真偽値既存の属性を消去するか (既定値=true)
[clearingOverridesThroughRootObjectStyle] 真偽値オブジェクトスタイルで設定されていない属性を消去するか (既定値=false)
[18][19][20][21] applyParagraphStyle(using, [clearingOverrides]) なし段落スタイルを適用
using 文字列値, ParagraphStyle段落スタイル
[clearingOverrides] 真偽値既存の属性を消去するか (既定値=true)
[18][19][20][21] applyTableStyle(using, [clearingOverrides]) なし表スタイルを適用
using 文字列値, TableStyle表スタイル
[clearingOverrides] 真偽値既存の属性を消去するか (既定値=true)
[18][19][20][21] asynchronousExportFile(format, to, [showingOptions], [using], [versionComments], [forceSave]) BackgroundTaskバックグラウンドで書き出す
format ExportFormat, 文字列値形式
to ファイル書き出すファイル名
[showingOptions] 真偽値オプションのダイアログを表示させるか (既定値=false)
[using] PDFExportPresetPDF書き出しプリセット
[versionComments] 文字列値Version Cueコメント
[forceSave] 真偽値Version Cue強制的にバージョンを保存 (既定値=false)
[18][19][20][21] changeGrep([reverseOrder]) Array( Text )正規表現置換
[reverseOrder] 真偽値逆順
[18][19][20][21] changeText([reverseOrder]) Array( Text )テキストの置換
[reverseOrder] 真偽値逆順
[18][19][20][21] changeTransliterate([reverseOrder]) Array( Text )文字種変換の置換
[reverseOrder] 真偽値逆順
[18][19][20][21] convertElementToTable(rowTag, cellTag) TableXML elementを表に変換
rowTag XMLTag
cellTag XMLTag
[18][19][20][21] convertToAttribute([using]) XMLAttributeConverts the XMLElement to an attribute of its parent element.
[using] 文字列値
[18][19][20][21] duplicate() XMLElement複製。複製されたオブジェクトを返す
[18][19][20][21] evaluateXPathExpression(using, [prefixMappingTable]) XMLItemEvaluates an XPath expression starting at this XML element in the structure.
using 文字列値The XPath expression.
[prefixMappingTable] Array of Arrays of 2 StringsThe namespace mapping table.
[18][19][20][21] exportFile(format, to, [showingOptions], [using], [versionComments], [forceSave]) なし書き出し
format ExportFormat, 文字列値形式
to ファイルファイル名
[showingOptions] 真偽値オプションのダイアログを表示させるか (既定値=false)
[using] PDFExportPresetPDF書き出しプリセット
[versionComments] 文字列値Version Cueコメント
[forceSave] 真偽値Version Cue強制的にバージョンを保存 (既定値=false)
[18][19][20][21] findGrep([reverseOrder]) Array( Text )正規表現検索
[reverseOrder] 真偽値逆順
[18][19][20][21] findText([reverseOrder]) Array( Text )テキストの検索
[reverseOrder] 真偽値逆順
[18][19][20][21] findTransliterate([reverseOrder]) Array( Text )文字種変換の検索
[reverseOrder] 真偽値逆順
[18][19][20][21] getElements() Array( XMLElement )オブジェクト参照を返す
[18][19][20][21] importXML(from) なしXMLファイルの読み込み
from ファイルXMLファイル名
[18][19][20][21] insertTextAsContent(using, position) TextInserts the specified text as content before, in, or after the XML element.
using 文字列値, SpecialCharactersThe text to be inserted.
position XMLElementPosition
XMLElementPosition
Ver.プロパティ値/管理用文字説明
[18][19][20][21]AFTER_ELEMENT1482778228
Xaft		Specifies the position after the XML element.
[18][19][20][21]BEFORE_ELEMENT1482843494
Xbef		Specifies the position before the XML element.
[18][19][20][21]ELEMENT_END1483042404
Xend		Specifies the position at the end of the XML element.
[18][19][20][21]ELEMENT_START1482844014
Xbgn		Specifies the position at the beginning of the XML element.
[18][19][20][21] markup(using) なしXML要素に関連付ける
using XMLElement
[18][19][20][21] move(to, [reference]) XMLElementXML要素の移動
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
移動先
[reference] XMLItem, Text位置の基準になるオブジェクト
[18][19][20][21] placeIntoCopy(on, placePoint, copyItem, [retainExistingFrame]) PageItemAssociates the XML element with a copy of a page item.
on Spread, Page, MasterSpread配置先
placePoint [ y1, x1 ]The page coordinates of the top left corner of the page item.
copyItem PageItemThe page item to copy.
[retainExistingFrame] 真偽値(既定値=false)
[18][19][20][21] placeIntoFrame(on, geometricBounds) PageItemPlaces the XML element into a new rectangular page item. If the XML element was already associated with a page item, that page item is deleted.
on Spread, Page, MasterSpread配置先
geometricBounds [ y1, x1, y2, x2 ]The bounds of the page item excluding the stroke width.
[18][19][20][21] placeIntoInlineCopy(copyItem, [retainExistingFrame]) PageItemAssociates an existing page item with the XML element and places it into an inline frame.
copyItem PageItemThe page item to copy.
[retainExistingFrame] 真偽値If true, moves the existing page item. If false, moves a copy of the page item.(既定値=false)
[18][19][20][21] placeIntoInlineFrame(dimensions) PageItemPlaces an XML element into an inline frame.
dimensions [ width, height ]width, heightは数値または長さ値
[18][19][20][21] placeXML(using) なしPlaces XML content into the story, replacing the existing content.
using Story, PageItem, Graphic, Movie, SoundThe object to place into.
[18][19][20][21] remove() なし削除
[18][19][20][21] removeEventListener(eventType, handler, [captures]) 真偽値EventListenerを削除
eventType 文字列値
handler ファイル, JavaScript関数
[captures] 真偽値（廃止）
[18][19][20][21] select([existingSelection]) なし選択状態にする
[existingSelection] SelectionOptions
SelectionOptions
Ver.プロパティ値/管理用文字説明
[18][19][20][21]ADD_TO1633969202
add2		追加選択する
[18][19][20][21]REMOVE_FROM1919249734
remF		選択から削除する
[18][19][20][21]REPLACE_WITH1919250519
repW		置き換える
[18][19][20][21]SET_KEY1936028779
setk		整列のキーオブジェクトにする
既に選択されているものがあった場合 (既定値=SelectionOptions.REPLACE_WITH)
[18][19][20][21] setContent(using, [relativeBasePath]) PageItemReplaces the content of XML element with content imported from a file.
using 文字列値フルパス名
[relativeBasePath] 文字列値Base path used to resolve relative paths.
[18][19][20][21] store(using, [withProperties]) Assetライブラリに追加
using Library追加先のライブラリ
[withProperties] Objectプロパティを設定
[18][19][20][21] toSource() 文字列値ソースコードを表す文字列を返す
[18][19][20][21] toSpecifier() 文字列値Retrieves the object specifier.
[18][19][20][21] untag() なしUntags an element.
[18][19][20][21] validate([maximumErrors]) Array( ValidationError )Validates the element against a DTD.
[maximumErrors] 数値最大数(既定値=250)