XMLComment
An XML comment.
Go to Property Listing | Method Listing
Methods:
addEventListener, duplicate, getElements, move, remove, removeEventListener, select, toSource, toSpecifier
Objects:
Boolean, EventListeners, Events, InsertionPoint, Number, Object, String,
Hierarchy:
Superclass: XMLItem
Class: XMLComment
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
The unique ID of the XMLComment. |
||
|
readonly |
The index of the XMLComment within its containing object. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
readonly |
The parent of the XMLComment (a Document or XMLElement). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
The insertion point before the table in the story containing the table. |
||
|
read/write |
The text of the XML comment. |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
XMLComment duplicate ()
Duplicates the XMLComment.
XMLComment getElements ()
Resolves the object specifier, creating an array of object references.
XMLComment move (to:LocationOptions, reference:Varies XMLItem Text)
Moves the element to the specified location.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The location in relation to the reference object or within the containing object. |
|
|
reference |
The reference object. Note: Required when the to parameter specifies before or after. . Can accept: XMLItem or Text. (Optional) |
undefined remove ()
Deletes the XMLComment.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined select ([existingSelection:SelectionOptions=SelectionOptions])
Selects the object.
|
Parameter |
Type |
Description |
|---|---|---|
|
existingSelection |
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.
Object of
Event.parent
EventListener.parent
MutationEvent.parent