XMLInstruction

An XML processing instruction. Base Class: XMLItem

XMLInstruction

Property	Type	Access	Description
data	string	r/w	A value that tells the application reading the exported XML file what to do with the processing instruction.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	number	readonly	The unique ID of the XMLInstruction.
index	number	readonly	The index of the XMLInstruction within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
parent	Document XMLElement	readonly	The parent of the XMLInstruction (a Document or XMLElement).
properties	Object	r/w	A property that allows setting of several properties at the same time.
storyOffset	InsertionPoint	readonly	The insertion point before the table in the story containing the table.
target	string	r/w	A name that identifies the processing instruction to an application reading the exported XML file.

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

XMLInstruction duplicate ()
Duplicates the XMLInstruction.

Array of XMLInstruction getElements ()
Resolves the object specifier, creating an array of object references.

XMLInstruction move (to: LocationOptions[, reference: varies])
Moves the element to the specified location.

Parameter	Type	Description
to	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN	The location in relation to the reference object or within the containing object.
reference	Text XMLItem	The reference object. Note: Required when the to parameter specifies before or after. . Can accept: XMLItem or Text. (Optional)

void remove ()
Deletes the XMLInstruction.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

XMLInstruction XMLInstructions.nextItem (obj: XMLInstruction)

XMLInstruction XMLInstructions.previousItem (obj: XMLInstruction)

XMLInstruction XMLInstruction.duplicate ()

Array of XMLInstruction XMLInstruction.getElements ()

XMLInstruction XMLInstruction.move (to: LocationOptions[, reference: varies])

XMLInstruction XMLInstructions.[] (index: number)

XMLInstruction XMLInstructions.add (target: string[, data: string=][, storyOffset: varies][, withProperties: Object])

XMLInstruction XMLInstructions.anyItem ()

XMLInstruction XMLInstructions.firstItem ()

XMLInstruction XMLInstructions.item (index: varies)

XMLInstruction XMLInstructions.itemByID (id: number)

Array of XMLInstruction XMLInstructions.itemByRange (from: varies, to: varies)

XMLInstruction XMLInstructions.lastItem ()

XMLInstruction XMLInstructions.middleItem ()

XMLInstruction XMLInstructions.nextItem (obj: XMLInstruction)

XMLInstruction XMLInstructions.previousItem (obj: XMLInstruction)

Jongware, 28-Apr-2012 v3.0.3i