K4 InDesign Javascript API Documentation

PreferencesXMLViewPreference

XML view preferences

Extends

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the XMLViewPreference (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
showAttributes bool If true, displays attributes as well as elements in the structure view. Note: Valid only when show structure is true. read-write
showStructure bool If true, displays the structure view. read-write
showTagMarkers bool If true, displays XML tags. read-write
showTagOptions bool If true, displays the tag options dialog when tagging any item whose parent is not tagged. read-only
showTaggedFrames bool If true, displays XML tags in tagged frames. read-write
showTextSnippets bool If true, the structure view displays text snippets of element content. Note: Valid only when show structure is true. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → XMLViewPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → XMLViewPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the XMLViewPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.