XMLComment

An XML comment.

Methods:

duplicate, getElements, move, remove, select, toSource, toSpecifier

Objects:

Number, Object, String,

Hierarchy:

Superclass: XMLItem

Class: XMLComment

Property Listing

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.

Method Listing

XMLComment duplicate ()

Duplicates the XMLComment.

Object 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

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.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)

undefined remove ()

Deletes the XMLComment.

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

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.

String toSpecifier ()

Retrieves the object specifier.

Return

XMLComments.add()

XMLComment.duplicate()

XMLComment.move()

XMLComments.anyItem()

XMLComments.everyItem()

XMLComments.nextItem()

XMLComments.previousItem()

XMLComments.itemByID()

XMLComments.item()

XMLComments.itemByName()

XMLComments.itemByRange()

XMLComments.firstItem()

XMLComments.lastItem()

XMLComments.middleItem()