XMLInstructions

A collection of XML instructions.

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
length	Number	readonly	The number of objects in the collection.

Method Listing

XMLInstruction [] (index:Number)

Returns the XMLInstruction with the specified index.

Parameter	Type	Description
index	Number	The index.

XMLInstruction add (target:String, [data:String=String], storyOffset:Varies InsertionPoint LongInteger, withProperties:Object)

Creates a new XML processing instruction.

Parameter	Type	Description
target	String	A name that identifies the processing instruction to an application reading the exported XML file.
data	String	A value that tells the application what to do with the processing instruction identified in the target. (Optional) (default: )
storyOffset	InsertionPoint LongInteger	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 XMLInstruction (Optional)

XMLInstruction anyItem ()

Returns any XMLInstruction in the collection.

Number count ()

Displays the number of elements in the XMLInstruction.

XMLInstruction everyItem ()

Returns every XMLInstruction in the collection.

XMLInstruction firstItem ()

Returns the first XMLInstruction in the collection.

XMLInstruction item (index:Varies LongInteger String)

Returns the XMLInstruction with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

XMLInstruction itemByID (id:Number)

Returns the XMLInstruction with the specified ID.

Parameter	Type	Description
id	Number	The ID.

XMLInstruction itemByRange (from:Varies LongInteger XMLInstruction String, to:Varies LongInteger XMLInstruction String)

Returns the XMLInstructions within the specified range.

Parameter	Type	Description
from	LongInteger XMLInstruction String	The XMLInstruction, index, or name at the beginning of the range. Can accept: XMLInstruction, Long Integer or String.
to	LongInteger XMLInstruction String	The XMLInstruction, index, or name at the end of the range. Can accept: XMLInstruction, Long Integer or String.

Parameter

Type

Description

from

LongInteger

XMLInstruction

String

The XMLInstruction, index, or name at the beginning of the range. Can accept: XMLInstruction, Long Integer or String.

LongInteger

XMLInstruction

String

The XMLInstruction, index, or name at the end of the range. Can accept: XMLInstruction, Long Integer or String.

XMLInstruction lastItem ()

Returns the last XMLInstruction in the collection.

XMLInstruction middleItem ()

Returns the middle XMLInstruction in the collection.

XMLInstruction nextItem (obj:XMLInstruction)

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

Parameter	Type	Description
obj	XMLInstruction	The XMLInstruction whose index comes before the desired XMLInstruction.

XMLInstruction previousItem (obj:XMLInstruction)

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

Parameter	Type	Description
obj	XMLInstruction	The index of the XMLInstruction that follows the desired XMLInstruction.

String toSource ()

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

Object of

Document.xmlInstructions

XMLElement.xmlInstructions