Adobe InDesign CS5 Server (7.0) Object Model JS: XMLImportPreference

InDesign Server CS5

Class

XMLImportPreference

 XML import preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
XMLImportPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
allowTransformbool r/wIf true, transforms the XML using an XSLT file.
createLinkToXMLbool r/wIf true, creates a link to the imported XML file. If false, embeds the file.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
ignoreUnmatchedIncomingbool r/wIf true, ignores elements that do not match the existing structure. Note: Valid only when import style is merge.
ignoreWhitespacebool r/wIf true, leaves existing content in place if the matching XML content contains only whitespace characters such as a carriage return or a tab character. Note: Valid only when import style is merge.
importCALSTablesbool r/wIf true, imports CALS tables as InDesign tables. (default: true)
importStyleXMLImportStyles:
XMLImportStyles.APPEND_IMPORT
XMLImportStyles.MERGE_IMPORT
r/wThe style of incorporating imported XML content into the document.
importTextIntoTablesbool r/wIf true, imports text into tables if tags match placeholder tables and their cells. Note: Valid only when import style is merge.
importToSelectedbool r/wIf true, imports into the selected XML element. If false, imports at the root element.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication
Document
readonlyThe parent of the XMLImportPreference (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
removeUnmatchedExistingbool r/wIf true, deletes existing elements or placeholders in the document that do not have matches in the XML file. Note: Valid only when import style is merge.
repeatTextElementsbool r/wIf true, repeating text elements inherit the formatting applied to placeholder text. Note: Valid only when import style is merge.
transformFilenameFile
XMLTransformFile
r/wThe name of the XSLT file. Note: Valid when allow transform is true. Can return: File or XMLTransformFile enumerator.
transformParameters Array of
Ordered array containing name:String
value:String
r/wStylesheet parameters as a list of name/value pairs in the format [[name, value], [name, value], ...]. Can return: Ordered array containing name:String, value:String.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.xmlImportPreferences

Document.xmlImportPreferences

Return

Array of XMLImportPreference XMLImportPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index