Adobe InDesign CS2 (4.0) Object Model JS: XMLComment

previous page next page

Class

XMLComment

An XML comment. Base Class: XMLItem

XMLComment

Property	Type	Access	Description
id	number	readonly	The unique ID of the XMLComment.
index	number	readonly	The index of the XMLComment within its containing object.
parent	Document XMLElement XMLItem	readonly	The parent of the XMLComment (a Document, XMLElement or XMLItem).
properties	Object	r/w	A property that allows setting of several properties at the same time.
storyOffset	number	readonly	The index of the character containing the table (from the beginning of the story).
value	string	r/w	The text of the XML comment.

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.

Parameter	Type	Description
to	LocationOptions: 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.
reference	Text 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.

Parameter	Type	Description
existingSelection	SelectionOptions: 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.