K4 InDesign Javascript API Documentation

PreferencesXMLPreference

XML preferences.

Extends

Instance Properties

Name Description Access
defaultCellTagColor 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. read-write
defaultCellTagName string The name of the default tag to use for new table cell elements. Note: Either specifies an existing tag or creates a new tag. read-write
defaultImageTagColor 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. read-write
defaultImageTagName string The default name for new image elements created automatically. read-write
defaultStoryTagColor 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. read-write
defaultStoryTagName string The name of the default tag to use for new story elements. Note: Either specifies an existing tag or creates a new tag. read-write
defaultTableTagColor 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. read-write
defaultTableTagName string The name of the default tag to use for new table elements. Note: Either specifies an existing tag or creates a new tag. read-write
deleteElementOnContentDeletion bool The preference for deleting the element when deleting the associated content like a page item or a text fragment. read-write
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 XMLPreference (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → XMLPreference
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(
)
  → XMLPreference
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 XMLPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.