Adobe InDesign CS6 (8.0) Object Model JS: XMLItem

InDesign CS6

Class

XMLItem

 

An XML item.

Superclass of DTD, XMLComment, XMLElement, and XMLInstruction

QuickLinks

addEventListener, duplicate, getElements, remove, removeEventListener, select, toSource, toSpecifier

Hierarchy

Document | XMLElement
XMLItem
DTD | XMLComment | XMLElement | XMLInstruction
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the XMLItem.
indexnumber readonlyThe index of the XMLItem within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentDocumentXMLElement readonlyThe parent of the XMLItem (a Document or XMLElement).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

XMLItem duplicate ()
Duplicates the XMLItem.

Array of XMLItem getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the XMLItem.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
SelectionOptions.SET_KEY
The selection status of the XMLItem in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

string toSource ()
Generates a string which, if executed, will return the XMLItem.

string toSpecifier ()
Retrieves the object specifier.

Element of

Button.associatedXMLElement

Cell.associatedXMLElement

Character.associatedXMLElements

CheckBox.associatedXMLElement

ComboBox.associatedXMLElement

Document.associatedXMLElement

EPS.associatedXMLElement

EPSText.associatedXMLElement

FormField.associatedXMLElement

Graphic.associatedXMLElement

GraphicLine.associatedXMLElement

Group.associatedXMLElement

HtmlItem.associatedXMLElement

Image.associatedXMLElement

ImportedPage.associatedXMLElement

InsertionPoint.associatedXMLElements

Line.associatedXMLElements

ListBox.associatedXMLElement

MediaItem.associatedXMLElement

Movie.associatedXMLElement

MultiStateObject.associatedXMLElement

Oval.associatedXMLElement

PDF.associatedXMLElement

PICT.associatedXMLElement

PageItem.associatedXMLElement

Paragraph.associatedXMLElements

Polygon.associatedXMLElement

RadioButton.associatedXMLElement

Rectangle.associatedXMLElement

SignatureField.associatedXMLElement

Sound.associatedXMLElement

SplineItem.associatedXMLElement

Story.associatedXMLElement

Table.associatedXMLElement

Text.associatedXMLElements

TextBox.associatedXMLElement

TextColumn.associatedXMLElements

TextFrame.associatedXMLElement

TextStyleRange.associatedXMLElements

WMF.associatedXMLElement

Word.associatedXMLElements

XMLRuleMatchData.element

XmlStory.associatedXMLElement

Used in:

XMLItem XMLItems.nextItem (obj: XMLItem)

XMLItem XMLItems.previousItem (obj: XMLItem)

Return

Array of XMLItem XMLElement.evaluateXPathExpression (using: string[, prefixMappingTable: Array of varies])

XMLItem XMLItem.duplicate ()

Array of XMLItem XMLItem.getElements ()

XMLItem XMLItems.[] (index: number)

XMLItem XMLItems.anyItem ()

Array of XMLItem XMLItems.everyItem ()

XMLItem XMLItems.firstItem ()

XMLItem XMLItems.item (index: varies)

XMLItem XMLItems.itemByID (id: number)

Array of XMLItem XMLItems.itemByRange (from: varies, to: varies)

XMLItem XMLItems.lastItem ()

XMLItem XMLItems.middleItem ()

XMLItem XMLItems.nextItem (obj: XMLItem)

XMLItem XMLItems.previousItem (obj: XMLItem)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index