Adobe InDesign CS2 (4.0) Object Model JS: XMLComment

InDesign CS2

Class

XMLComment

 An XML comment. Base Class: XMLItem

QuickLinks

duplicate, getElements, move, remove, select, toSource, toSpecifier

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.

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

XMLComment move (to: LocationOptions[, reference: any])
Moves the element to the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location in relation to the reference object or within the containing object.
referenceText
XMLItem
The reference object. Note: Required when the to parameter specifies before or after. . Can accept: XMLItem or Text. (Optional)

void remove ()
Deletes the XMLComment.

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 XMLComment in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of XMLComment XMLComments.itemByRange (from: any, to: any)

XMLComment XMLComments.nextItem (obj: XMLComment)

XMLComment XMLComments.previousItem (obj: XMLComment)

Return

XMLComment XMLComment.duplicate ()

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

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

XMLComment XMLComments.anyItem ()

Array of XMLComment XMLComments.everyItem ()

XMLComment XMLComments.firstItem ()

XMLComment XMLComments.item (index: any)

XMLComment XMLComments.itemByID (id: number)

XMLComment XMLComments.itemByName (name: string)

Array of XMLComment XMLComments.itemByRange (from: any, to: any)

XMLComment XMLComments.lastItem ()

XMLComment XMLComments.middleItem ()

XMLComment XMLComments.nextItem (obj: XMLComment)

XMLComment XMLComments.previousItem (obj: XMLComment)

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