Class
An XML comment. Base Class: XMLItem duplicate, move, remove, select
XMLComment
QuickLinks
Hierarchy
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 | DocumentXMLElement 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. |
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
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | Location |
| reference | Text 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.
| Parameter | Type | Description |
|---|---|---|
| existingSelection | SelectionOptions: 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.3d | Contents :: Index |