InDesign Server2025
API 20.5.0.49
Object

XMLPreference

XML preferences.

Preference XMLPreference
Hierarchy

Application | Document

XMLPreference

Properties

NameType AccessDescription
3 Reals (0 - 255)[] | UIColors[]
+25 more
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.
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.
3 Reals (0 - 255)[] | UIColors[]
+25 more
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.
String read/write The default name for new image elements created automatically.
3 Reals (0 - 255)[] | UIColors[]
+25 more
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.
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.
3 Reals (0 - 255)[] | UIColors[]
+25 more
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.
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.
Boolean read/write The preference for deleting the element when deleting the associated content like a page item or a text fragment.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Application | Document readonly The parent of the XMLPreference (a Application or Document).
Object read/write A property that allows setting of several properties at the same time.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
XMLPreference[]

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

Boolean

Removes the event listener.

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

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

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a XMLPreference.

Return 1

Methods that return a XMLPreference.