Adobe InCopy CS5 (7.0) Object Model JS: XMLViewPreference

InCopy CS5

Class

XMLViewPreference

 XML view preferences Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
XMLViewPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplicationDocument readonlyThe parent of the XMLViewPreference (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
showAttributesbool r/wIf true, displays attributes as well as elements in the structure view. Note: Valid only when show structure is true.
showStructurebool r/wIf true, displays the structure view.
showTagMarkersbool r/wIf true, displays XML tags.
showTagOptionsbool readonlyIf true, displays the tag options dialog when tagging any item whose parent is not tagged.
showTaggedFramesbool r/wIf true, displays XML tags in tagged frames.
showTextSnippetsbool r/wIf true, the structure view displays text snippets of element content. Note: Valid only when show structure is true.

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 XMLViewPreference 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 XMLViewPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.xmlViewPreferences

Document.xmlViewPreferences

Return

Array of XMLViewPreference XMLViewPreference.getElements ()

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