Class

XMLInstruction

 An XML processing instruction. Base Class: XMLItem

QuickLinks

duplicate, getElements, move, remove, select, toSource, toSpecifier

Hierarchy

Document | XMLElement | XMLItem

XMLItem

XMLInstruction

Properties

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.
id	number	readonly	The unique ID of the XMLInstruction.
index	number	readonly	The index of the XMLInstruction within its containing object.
parent	DocumentXMLElement XMLItem	readonly	The parent of the XMLInstruction (a Document, XMLElement or XMLItem).
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.

Methods

Instances

XMLInstruction duplicate ()
Duplicates the XMLInstruction.

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

XMLInstruction move (to: LocationOptions[, reference: any])
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.

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

Parameter	Type	Description
existingSelection	SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH	The selection status of the XMLInstruction in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of XMLInstruction XMLInstructions.itemByRange (from: any, to: any)

XMLInstruction XMLInstructions.nextItem (obj: XMLInstruction)

XMLInstruction XMLInstructions.previousItem (obj: XMLInstruction)

Return

XMLInstruction XMLInstruction.duplicate ()

Array of XMLInstruction XMLInstruction.getElements ()

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

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

XMLInstruction XMLInstructions.anyItem ()

Array of XMLInstruction XMLInstructions.everyItem ()

XMLInstruction XMLInstructions.firstItem ()

XMLInstruction XMLInstructions.item (index: any)

XMLInstruction XMLInstructions.itemByID (id: number)

XMLInstruction XMLInstructions.itemByName (name: string)

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

XMLInstruction XMLInstructions.lastItem ()

XMLInstruction XMLInstructions.middleItem ()

XMLInstruction XMLInstructions.nextItem (obj: XMLInstruction)

XMLInstruction XMLInstructions.previousItem (obj: XMLInstruction)

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index