XMLComments
A collection of XML comments.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
XMLComment [] (index:Number)
Returns the XMLComment with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
XMLComment add ([value:String=String], storyOffset:Varies InsertionPoint LongInteger, withProperties:Object)
Creates a new XML comment.
|
Parameter |
Type |
Description |
|---|---|---|
|
value |
The value of the comment. (Optional) (default: ) |
|
|
storyOffset |
LongInteger |
The location within the story, specified as an insertion point. Can accept: InsertionPoint or Long Integer. (Optional) |
|
withProperties |
Initial values for properties of the new XMLComment (Optional) |
XMLComment anyItem ()
Returns any XMLComment in the collection.
Number count ()
Displays the number of elements in the XMLComment.
XMLComment everyItem ()
Returns every XMLComment in the collection.
XMLComment firstItem ()
Returns the first XMLComment in the collection.
XMLComment item (index:Varies LongInteger String)
Returns the XMLComment with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
XMLComment itemByID (id:Number)
Returns the XMLComment with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
XMLComment itemByRange (from:Varies LongInteger XMLComment String, to:Varies LongInteger XMLComment String)
Returns the XMLComments within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The XMLComment, index, or name at the beginning of the range. Can accept: XMLComment, Long Integer or String. |
|
to |
LongInteger |
The XMLComment, index, or name at the end of the range. Can accept: XMLComment, Long Integer or String. |
XMLComment lastItem ()
Returns the last XMLComment in the collection.
XMLComment middleItem ()
Returns the middle XMLComment in the collection.
XMLComment nextItem (obj:XMLComment)
Returns the XMLComment whose index follows the specified XMLComment in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The XMLComment whose index comes before the desired XMLComment. |
XMLComment previousItem (obj:XMLComment)
Returns the XMLComment with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the XMLComment that follows the desired XMLComment. |
String toSource ()
Generates a string which, if executed, will return the XMLComment.
Object of
Document.xmlComments
XMLElement.xmlComments