An XML comment.
Properties
| 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 | any | 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 | InsertionPoint | readonly | The location of the XMLComment in the parent story. |
| value | string | r/w | The text of the XML comment. |
Methods
XMLCommentduplicate ()
Duplicates the XMLComment.
Array of XMLCommentgetElements ()
Resolves the object specifier, creating an array of object references.
XMLCommentmove (to:
LocationOptions[, reference:
any])
Moves the element to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location in relation to the reference object or within the containing object. |
| reference | XMLItem Text |
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=REPLACE_WITH ])
Selects the XMLComment.
| Parameter | Type | Description |
|---|---|---|
| existingSelection | SelectionOptions : ADD_TO REMOVE_FROM REPLACE_WITH |
The selection status of the XMLComment in relation to previously selected objects. (Optional) (default: REPLACE_WITH ) |
string toSource ()
Generates a string which, if executed, will return the XMLComment.
string toSpecifier ()
Retrieves the object specifier.
Used in:
XMLComments.previousItem (
obj:
XMLComment )
XMLComments.nextItem (
obj:
XMLComment )
Returned by:
XMLComment XMLComment .duplicate (
)
Array of XMLComment XMLComment .getElements (
)
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
)