XMLComment

Methods:

Superclass: XMLItem

Class: 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	XMLElement Document XMLItem	readonly	The parent of the XMLComment (a Document, XMLElement or XMLItem).
properties	Object	read/write	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	read/write	The text of the XML comment.

XMLComment duplicate ()

Duplicates the XMLComment.

XMLElement move (to:LocationOptions, reference:Varies XMLItem Text)

Move element before/after another element or text object, or to beginning/end

Parameter	Type	Description
to	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	Location
reference	XMLItem Text	Before/after this object. Can accept: XMLItem or Text. (Optional)

Parameter

Type

Description

to

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

Location

reference

Before/after this object. Can accept: XMLItem or Text. (Optional)

undefined remove ()

Deletes the XMLComment.

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Select this object.

Parameter	Type	Description
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE	How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE)

Parameter

Type

Description

existingSelection

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE

How to handle the existing selection (Optional)

(default: SelectionOptions.REPLACE)