XMLViewPreference

XML view preferences

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Object

Preferences:

Boolean

Hierarchy:

Superclass: Preference

Class: XMLViewPreference

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Application

Document

readonly

The parent of the XMLViewPreference (a Application or Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

showAttributes

Boolean

read/write

If true, displays attributes as well as elements in the structure view. Note: Valid only when show structure is true.

showStructure

Boolean

read/write

If true, displays the structure view.

showTagMarkers

Boolean

read/write

If true, displays XML tags.

showTagOptions

Boolean

readonly

If true, displays the tag options dialog when tagging any item whose parent is not tagged.

showTaggedFrames

Boolean

read/write

If true, displays XML tags in tagged frames.

showTextSnippets

Boolean

read/write

If true, the structure view displays text snippets of element content. Note: Valid only when show structure is true.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

XMLViewPreference getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the XMLViewPreference.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Application.xmlViewPreferences

Document.xmlViewPreferences

Return

XMLViewPreference.getElements()