XMLXMLComments

Instance Properties

Methods

add(

[value=""], storyOffset ​[, withProperties])

→ XMLComment

Creates a new XML comment.

value	string The value of the comment. (Optional)
storyOffset	The location within the story, specified as an insertion point. Can accept: InsertionPoint or Long Integer. (Optional)
withProperties	Object Initial values for properties of the new XMLComment (Optional)

anyItem(

)

→ XMLComment

Returns any XMLComment in the collection.

count(

)

→ number

Displays the number of elements in the XMLComment.

everyItem(

)

→ XMLComment

Returns every XMLComment in the collection.

firstItem(

)

→ XMLComment

Returns the first XMLComment in the collection.

item(

index)

→ XMLComment

Returns the XMLComment with the specified index or name.

index

The index or name. Can accept: Long Integer or String.

itemByID(

id)

→ XMLComment

Returns the XMLComment with the specified ID.

id	number The ID.

itemByRange(

from, to)

→ XMLComment

Returns the XMLComments within the specified range.

from	The XMLComment, index, or name at the beginning of the range. Can accept: XMLComment, Long Integer or String.
to	The XMLComment, index, or name at the end of the range. Can accept: XMLComment, Long Integer or String.

lastItem(

)

→ XMLComment

Returns the last XMLComment in the collection.

middleItem(

)

→ XMLComment

Returns the middle XMLComment in the collection.

nextItem(

obj)

→ XMLComment

Returns the XMLComment whose index follows the specified XMLComment in the collection.

obj	XMLComment The XMLComment whose index comes before the desired XMLComment.

previousItem(

obj)

→ XMLComment

Returns the XMLComment with the index previous to the specified index.

obj	XMLComment The index of the XMLComment that follows the desired XMLComment.

toSource(

)

→ string

Generates a string which, if executed, will return the XMLComment.