Class
An XML processing instruction. Base Class: XMLItem
duplicate, move, remove, select
XMLInstruction
QuickLinks
Hierarchy
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 | number | readonly | The index of the character containing the table (from the beginning of the story). |
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.
XMLElement move (to:
LocationOptions[, reference:
any])
Move element before/after another element or text object, or to beginning/end
Parameter | Type | Description |
---|---|---|
to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | Location |
reference | Text XMLItem | Before/after this object. Can accept: XMLItem or Text. (Optional) |
void remove ()
Deletes the XMLInstruction.
void select ([existingSelection:
SelectionOptions=SelectionOptions.REPLACE])
Select this object.
Parameter | Type | Description |
---|---|---|
existingSelection | SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE | How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE) |
Return
XMLInstruction XMLInstruction.duplicate ()
XMLInstruction XMLInstructions.add (storyOffset: any[, target: string=][, data: string=][, withProperties: Object])
Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |