Adobe InDesign CS (3.0) Object Model JS: XMLItem

InDesign CS

Class

XMLItem

 

An XML item.

Superclass of DTD, XMLComment, XMLElement, and XMLInstruction

QuickLinks

duplicate, move, remove, select

Hierarchy

Document | XMLElement | XMLItem
XMLItem
DTD | XMLComment | XMLElement | XMLInstruction
DTD | XMLComment | XMLElement | XMLInstruction | XMLItem

Properties

PropertyTypeAccessDescription
dtdsDTDs readonlyA collection of DTDs.
idnumber readonlyThe unique ID of the XMLItem.
indexnumber readonlyThe index of the XMLItem within its containing object.
parentDocumentXMLElement
XMLItem
readonlyThe parent of the XMLItem (a Document, XMLElement or XMLItem).
propertiesObject r/wA property that allows setting of several properties at the same time.
xmlCommentsXMLComments readonlyA collection of XML comments.
xmlElementsXMLElements readonlyA collection of XML elements.
xmlInstructionsXMLInstructions readonlyA collection of XML instructions.
xmlItemsXMLItems readonlyA collection of XML items.

Methods

Instances

XMLItem duplicate ()
Duplicates the XMLItem.

XMLElement move (to: LocationOptions[, reference: any])
Move element before/after another element or text object, or to beginning/end

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
Location
referenceText
XMLItem
Before/after this object. Can accept: XMLItem or Text. (Optional)

void remove ()
Deletes the XMLItem.

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE])
Select this object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE
How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE)

Element of

DTD.parent

XMLComment.parent

XMLElement.parent

XMLInstruction.parent

XMLItem.parent

Used in:

XMLElement DTD.move (to: LocationOptions[, reference: any])

XMLElement XMLComment.move (to: LocationOptions[, reference: any])

XMLElement XMLElement.move (to: LocationOptions[, reference: any])

XMLElement XMLInstruction.move (to: LocationOptions[, reference: any])

XMLElement XMLItem.move (to: LocationOptions[, reference: any])

Return

XMLItem XMLItem.duplicate ()

Jongware, 27-Jun-2010 v3.0.3dContents :: Index