Class
XML import preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
XMLImportPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allowTransform | bool | r/w | If true, transforms the XML using an XSLT file. |
| createLinkToXML | bool | r/w | If true, creates a link to the imported XML file. If false, embeds the file. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| ignoreUnmatchedIncoming | bool | r/w | If true, ignores elements that do not match the existing structure. Note: Valid only when import style is merge. |
| ignoreWhitespace | bool | r/w | If 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. |
| importCALSTables | bool | r/w | If true, imports CALS tables as InDesign tables. (default: true) |
| importStyle | XMLImportStyles: XMLImportStyles.APPEND_IMPORT XMLImportStyles.MERGE_IMPORT |
r/w | The style of incorporating imported XML content into the document. |
| importTextIntoTables | bool | r/w | If true, imports text into tables if tags match placeholder tables and their cells. Note: Valid only when import style is merge. |
| importToSelected | bool | r/w | If true, imports into the selected XML element. If false, imports at the root element. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | Application Document |
readonly | The parent of the XMLImportPreference (a Application or Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| removeUnmatchedExisting | bool | r/w | If 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. |
| repeatTextElements | bool | r/w | If true, repeating text elements inherit the formatting applied to placeholder text. Note: Valid only when import style is merge. |
| transformFilename | File XMLTransformFile |
r/w | The 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/w | Stylesheet 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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, 20-Jun-2010 v3.0.3d | Contents :: Index |