XMLInstruction

An XML processing instruction.

Methods:

duplicate, move, remove, select

Objects:

Number, Object, String,

Hierarchy:

Superclass: XMLItem

Class: XMLInstruction

Property Listing

Property

Type

Access

Description

data

String

read/write

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

XMLElement

Document

XMLItem

readonly

The parent of the XMLInstruction (a Document, XMLElement or XMLItem).

properties

Object

read/write

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

read/write

A name that identifies the processing instruction to an application reading the exported XML file.

Method Listing

XMLInstruction duplicate ()

Duplicates the XMLInstruction.

XMLElement move (to:LocationOptions, reference:Varies XMLItem Text)

Move element before/after another element or text object, or to beginning/end

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

Location

reference

XMLItem

Text

Before/after this object. Can accept: XMLItem or Text. (Optional)

undefined remove ()

Deletes the XMLInstruction.

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

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

XMLInstructions.add()

XMLInstruction.duplicate()