XMLPreference

XML preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Object, String, UIColors,

Hierarchy:

Superclass: Preference

Class: XMLPreference

Property Listing

Property

Type

Access

Description

defaultCellTagColor

Array of 3 Reals (0 - 255)

UIColors

read/write

The color of the default cell tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Note: Valid only when default cell tag name value creates a new tag. Does not update the color of an existing tag. . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.

defaultCellTagName

String

read/write

The name of the default tag to use for new table cell elements. Note: Either specifies an existing tag or creates a new tag.

defaultImageTagColor

Array of 3 Reals (0 - 255)

UIColors

read/write

The color to give a new image tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Note: Used only when the tag needs to be created. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.

defaultImageTagName

String

read/write

The default name for new image elements created automatically.

defaultStoryTagColor

Array of 3 Reals (0 - 255)

UIColors

read/write

The color of the default story tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Notes: Valid only when default story tag name value creates a new tag. Does not update the color of an existing tag. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.

defaultStoryTagName

String

read/write

The name of the default tag to use for new story elements. Note: Either specifies an existing tag or creates a new tag.

defaultTableTagColor

Array of 3 Reals (0 - 255)

UIColors

read/write

The color of the default table tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Notes: Valid only when default table tag name value creates a new tag. Does not update the color of an existing tag. . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.

defaultTableTagName

String

read/write

The name of the default tag to use for new table elements. Note: Either specifies an existing tag or creates a new tag.

deleteElementOnContentDeletion

Boolean

read/write

The preference for deleting the element when deleting the associated content like a page item or a text fragment.

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 XMLPreference (a Application or Document).

properties

Object

read/write

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

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)

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.xmlPreferences

Document.xmlPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

XMLPreference.getElements()