InDesign2026
API 21.5.1.73
Object

PasteboardPreference

Pasteboard preferences.

Preference PasteboardPreference
Hierarchy

Application | Document

PasteboardPreference

Properties

NameType AccessDescription
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write The color of bleed guides, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
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.
Boolean read/write If true, match the Preview Background color to Theme Color, else use the color-value specified in Preview Background color drop down.
Application | Document readonly The parent of the PasteboardPreference (a Application or Document).
Number[] | String[] unit read/write The minimum horizontal and vertical pasteboard margins. A horizontal margin of -1 means one document page width
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write The color of the preview background, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
Object read/write A property that allows setting of several properties at the same time.
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write The color of slug guides, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.

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.
PasteboardPreference[]

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

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a PasteboardPreference.

Return 1

Methods that return a PasteboardPreference.