Adobe InDesign CS (3.0) Object Model JS: XMLComment

InDesign CS

Class

XMLComment

 An XML comment. Base Class: XMLItem

QuickLinks

duplicate, move, remove, select

Hierarchy

Document | XMLElement | XMLItem
XMLItem
XMLComment

Properties

PropertyTypeAccessDescription
idnumber readonlyThe unique ID of the XMLComment.
indexnumber readonlyThe index of the XMLComment within its containing object.
parentDocumentXMLElement
XMLItem
readonlyThe parent of the XMLComment (a Document, XMLElement or XMLItem).
propertiesObject r/wA property that allows setting of several properties at the same time.
storyOffsetnumber readonlyThe index of the character containing the table (from the beginning of the story).
valuestring r/wThe text of the XML comment.

Methods

Instances

XMLComment duplicate ()
Duplicates the XMLComment.

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

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)

Return

XMLComment XMLComment.duplicate ()

XMLComment XMLComments.add (storyOffset: any[, value: string=][, withProperties: Object])

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