Adobe InDesign CS3 (5.0) Object Model JS: XMLItem

InDesign CS3

Class

XMLItem

 

An XML item.

Superclass of DTD, XMLComment, XMLElement, and XMLInstruction

QuickLinks

duplicate, getElements, remove, select, toSource, toSpecifier

Hierarchy

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

Properties

PropertyTypeAccessDescription
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.

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

void remove ()
Deletes the XMLItem.

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

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
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

Document.associatedXMLElement

EPS.associatedXMLElement

FormField.associatedXMLElement

Graphic.associatedXMLElement

GraphicLine.associatedXMLElement

Group.associatedXMLElement

Image.associatedXMLElement

ImportedPage.associatedXMLElement

InsertionPoint.associatedXMLElements

Line.associatedXMLElements

Movie.associatedXMLElement

Oval.associatedXMLElement

PDF.associatedXMLElement

PICT.associatedXMLElement

PageItem.associatedXMLElement

Paragraph.associatedXMLElements

Polygon.associatedXMLElement

Rectangle.associatedXMLElement

Sound.associatedXMLElement

Story.associatedXMLElement

Table.associatedXMLElement

Text.associatedXMLElements

TextColumn.associatedXMLElements

TextFrame.associatedXMLElement

TextStyleRange.associatedXMLElements

WMF.associatedXMLElement

Word.associatedXMLElements

XMLComment.parent

XMLElement.parent

XMLInstruction.parent

XMLItem.parent

XMLRuleMatchData.element

XmlStory.associatedXMLElement

Used in:

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

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

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

array of XMLItem XMLItems.itemByRange (from: any, to: any)

XMLItem XMLItems.nextItem (obj: XMLItem)

XMLItem XMLItems.previousItem (obj: XMLItem)

Return

XMLItem XMLItem.duplicate ()

Array of XMLItem XMLItem.getElements ()

XMLItem XMLItems.anyItem ()

Array of XMLItem XMLItems.everyItem ()

XMLItem XMLItems.firstItem ()

XMLItem XMLItems.item (index: any)

XMLItem XMLItems.itemByID (id: number)

XMLItem XMLItems.itemByName (name: string)

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

XMLItem XMLItems.lastItem ()

XMLItem XMLItems.middleItem ()

XMLItem XMLItems.nextItem (obj: XMLItem)

XMLItem XMLItems.previousItem (obj: XMLItem)

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