XMLComments
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
XMLComment add ([value:
string=][, storyOffset:
any][, withProperties:
Object])
Creates a new XML comment.
| Parameter | Type | Description |
|---|---|---|
| value | string | The value of the comment. (Optional) (default: ) |
| storyOffset | InsertionPoint Long Integer | 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) |
XMLComment anyItem ()
Returns any XMLComment in the collection.
number count ()
Displays the number of elements in the XMLComment.
Array
of XMLComment everyItem ()
Returns every XMLComment in the collection.
XMLComment firstItem ()
Returns the first XMLComment in the collection.
XMLComment item (index:
any)
Returns the XMLComment with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | 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 | number | The ID. |
XMLComment itemByName (name:
string)
Returns the XMLComment with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of XMLComment itemByRange (from:
any, to:
any)
Returns the XMLComments within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer String XMLComment | The XMLComment, index, or name at the beginning of the range. Can accept: XMLComment, Long Integer or String. |
| to | Long Integer String XMLComment | 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 | XMLComment | 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 | XMLComment | The index of the XMLComment that follows the desired XMLComment. |
string toSource ()
Generates a string which, if executed, will return the XMLComment.
Element of
Document.xmlComments
XMLElement.xmlComments
XMLItem.xmlComments
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |