XMLComment
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| id | number | readonly | The unique ID of the XMLComment. |
| index | number | readonly | The index of the XMLComment within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | DocumentXMLElement | readonly | The parent of the XMLComment (a Document or XMLElement). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| storyOffset | InsertionPoint | readonly | The insertion point before the table in the story containing the table. |
| value | string | r/w | The text of the XML comment. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
XMLComment duplicate ()
Duplicates the XMLComment.
Array
of XMLComment getElements ()
Resolves the object specifier, creating an array of object references.
XMLComment move (to:
LocationOptions[, reference:
varies])
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.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
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.
Used in:
XMLComment XMLComments.nextItem (obj: XMLComment)
XMLComment XMLComments.previousItem (obj: XMLComment)
Return
XMLComment XMLComment.duplicate ()
Array of XMLComment XMLComment.getElements ()
XMLComment XMLComment.move (to: LocationOptions[, reference: varies])
XMLComment XMLComments.[] (index: number)
XMLComment XMLComments.add ([value: string=][, storyOffset: varies][, withProperties: Object])
XMLComment XMLComments.anyItem ()
Array of XMLComment XMLComments.everyItem ()
XMLComment XMLComments.firstItem ()
XMLComment XMLComments.item (index: varies)
XMLComment XMLComments.itemByID (id: number)
Array of XMLComment XMLComments.itemByRange (from: varies, to: varies)
XMLComment XMLComments.lastItem ()
XMLComment XMLComments.middleItem ()
XMLComment XMLComments.nextItem (obj: XMLComment)
XMLComment XMLComments.previousItem (obj: XMLComment)
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |