Adobe InCopy CS5 (7.0) Object Model JS: XMLPreference

InCopy CS5

Class

XMLPreference

 XML preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
XMLPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
defaultCellTagColor3 Reals (0 - 255)
UIColors
r/wThe 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.
defaultCellTagNamestring r/wThe name of the default tag to use for new table cell elements. Note: Either specifies an existing tag or creates a new tag.
defaultImageTagColor3 Reals (0 - 255)
UIColors
r/wThe 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.
defaultImageTagNamestring r/wThe default name for new image elements created automatically.
defaultStoryTagColor3 Reals (0 - 255)
UIColors
r/wThe 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.
defaultStoryTagNamestring r/wThe name of the default tag to use for new story elements. Note: Either specifies an existing tag or creates a new tag.
defaultTableTagColor3 Reals (0 - 255)
UIColors
r/wThe 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.
defaultTableTagNamestring r/wThe name of the default tag to use for new table elements. Note: Either specifies an existing tag or creates a new tag.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication
Document
readonlyThe parent of the XMLPreference (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.xmlPreferences

Document.xmlPreferences

Return

Array of XMLPreference XMLPreference.getElements ()

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