Adobe InDesign CS (3.0) Object Model JS: XMLElement

InDesign CS

previous page next page

Class

XMLElement

An XML element. Base Class: XMLItem

QuickLinks

duplicate, exportFile, importXML, markup, move, placeXML, remove, select, untag, validate

Hierarchy

Document | XMLElement | XMLItem

XMLItem

XMLElement

Properties

Property	Type	Access	Description
characters	Characters	readonly	A collection of characters.
contents	SpecialCharactersString	r/w	The contents of the text. Can return: String or SpecialCharacters enumerator.
dtds	DTDs	readonly	A collection of DTDs.
epss	EPSs	readonly	A collection of EPS files.
id	number	readonly	The unique ID of the XMLElement.
images	Images	readonly	A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
index	number	readonly	The index of the XMLElement within its containing object.
insertionPoints	InsertionPoints	readonly	A collection of insertion points.
lines	Lines	readonly	A collection of lines.
markupTag	String XMLTag	r/w	The XML tag applied to the element. Can also accept: String.
pageItems	PageItems	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
paragraphs	Paragraphs	readonly	A collection of paragraphs.
parent	Document XMLElement XMLItem	readonly	The parent of the XMLElement (a Document, XMLElement or XMLItem).
parentStory	Story	readonly	The story that contains the text.
pdfs	PDFs	readonly	A collection of PDF files.
picts	PICTs	readonly	A collection of PICT graphics.
properties	Object	r/w	A property that allows setting of several properties at the same time.
stories	Stories	readonly	A collection of stories.
storyOffset	number	readonly	The index of the character containing the table (from the beginning of the story).
textColumns	TextColumns	readonly	A collection of text columns.
textStyleRanges	TextStyleRanges	readonly	A collection of text style ranges.
texts	Texts	readonly	A collection of text objects.
wmfs	WMFs	readonly	A collection of WMF graphics.
words	Words	readonly	A collection of words.
xmlAttributes	XMLAttributes	readonly	A collection of XML attributes.
xmlComments	XMLComments	readonly	A collection of XML comments.
xmlElements	XMLElements	readonly	A collection of XML elements.
xmlInstructions	XMLInstructions	readonly	A collection of XML instructions.
xmlItems	XMLItems	readonly	A collection of XML items.

Methods

Instances

XMLElement duplicate ()
Duplicates the XMLElement.

void exportFile (format: any, to: File[, showingOptions: bool=false][, using: PDFExportPreset])
Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat String	The export format. Can accept: ExportFormat enumerator or String.
to	File	The path of the export file.
showingOptions	bool	If true, prompts the user to select export options. (Optional) (default: false)
using	PDFExportPreset	The export style to use. (Optional)

void importXML (from: File)
Imports an XML file.

Parameter	Type	Description
from	File	The path to the XML file.

void markup (using: any)
Associates the object with the specified XML element while preserving existing content.

Parameter	Type	Description
using	PageItem Story Text	The object to mark up. Can accept: Text, Story or PageItem.

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 placeXML (using: any)
Places XML content into the story, replacing the existing content.

Parameter	Type	Description
using	PageItem Story	The story into which to place the XML content. Can accept: Story or PageItem.

void remove ()
Deletes the XMLElement.

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)

void untag ()
Untags an element.

Array of ValidationError validate ([maximumErrors: number=250])
Validates the element against a DTD.

Parameter	Type	Description
maximumErrors	number	The maximum number of validation errors to generate. (Optional) (default: 250)

Element of

Button.associatedXMLElement

Character.associatedXMLElements

Character.parent

DTD.parent

Document.associatedXMLElement

EPS.associatedXMLElement

FormField.associatedXMLElement

GraphicLine.associatedXMLElement

Group.associatedXMLElement

Image.associatedXMLElement

InsertionPoint.associatedXMLElements

InsertionPoint.parent

Line.associatedXMLElements

Line.parent

Movie.associatedXMLElement

Oval.associatedXMLElement

PDF.associatedXMLElement

PICT.associatedXMLElement

PageItem.associatedXMLElement

Paragraph.associatedXMLElements

Paragraph.parent

Polygon.associatedXMLElement

Rectangle.associatedXMLElement

Sound.associatedXMLElement

Story.associatedXMLElements

Story.parent

Text.associatedXMLElements

Text.parent

TextColumn.associatedXMLElements

TextColumn.parent

TextFrame.associatedXMLElement

TextStyleRange.associatedXMLElements

TextStyleRange.parent

ValidationError.element

WMF.associatedXMLElement

Word.associatedXMLElements

Word.parent

XMLAttribute.parent

XMLComment.parent

XMLElement.parent

XMLInstruction.parent

XMLItem.parent

Used in:

void Button.markup (using: XMLElement)

void Button.placeXML (using: XMLElement)

void Character.markup (using: XMLElement)

void EPS.markup (using: XMLElement)

void EPS.placeXML (using: XMLElement)

void FormField.markup (using: XMLElement)

void FormField.placeXML (using: XMLElement)

void GraphicLine.markup (using: XMLElement)

void GraphicLine.placeXML (using: XMLElement)

void Group.markup (using: XMLElement)

void Group.placeXML (using: XMLElement)

void Image.markup (using: XMLElement)

void Image.placeXML (using: XMLElement)

void InsertionPoint.markup (using: XMLElement)

void Line.markup (using: XMLElement)

void Movie.markup (using: XMLElement)

void Oval.markup (using: XMLElement)

void Oval.placeXML (using: XMLElement)

void PDF.markup (using: XMLElement)

void PDF.placeXML (using: XMLElement)

void PageItem.markup (using: XMLElement)

void PageItem.placeXML (using: XMLElement)

void Paragraph.markup (using: XMLElement)

void Polygon.markup (using: XMLElement)

void Polygon.placeXML (using: XMLElement)

void Rectangle.markup (using: XMLElement)

void Rectangle.placeXML (using: XMLElement)

void Sound.markup (using: XMLElement)

void Story.markup (using: XMLElement)

void Story.placeXML (using: XMLElement)

void Text.markup (using: XMLElement)

void TextColumn.markup (using: XMLElement)

void TextFrame.markup (using: XMLElement)

void TextFrame.placeXML (using: XMLElement)

void TextStyleRange.markup (using: XMLElement)

void Word.markup (using: XMLElement)

Return

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

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

XMLElement XMLElement.duplicate ()

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

XMLElement XMLElements.add (markupTag: any[, xmlContent: any][, withProperties: Object])

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

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

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index

previous page start next page