Adobe InDesign CS (3.0) Object Model JS: XMLInstruction

InDesign CS

Class

XMLInstruction

 An XML processing instruction. Base Class: XMLItem

QuickLinks

duplicate, move, remove, select

Hierarchy

Document | XMLElement | XMLItem
XMLItem
XMLInstruction

Properties

PropertyTypeAccessDescription
datastring r/wA value that tells the application reading the exported XML file what to do with the processing instruction.
idnumber readonlyThe unique ID of the XMLInstruction.
indexnumber readonlyThe index of the XMLInstruction within its containing object.
parentDocumentXMLElement
XMLItem
readonlyThe parent of the XMLInstruction (a Document, XMLElement or XMLItem).
propertiesObject r/wA property that allows setting of several properties at the same time.
storyOffsetnumber readonlyThe index of the character containing the table (from the beginning of the story).
targetstring r/wA 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

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
Location
referenceText
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.

ParameterTypeDescription
existingSelectionSelectionOptions:
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.3dContents :: Index