K4 InDesign Javascript API Documentation

PreferencesPasteboardPreference

Pasteboard preferences.

Extends

Instance Properties

Name Description Access
bleedGuideColor 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. 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
matchPreviewBackgroundToThemeColor bool If true, match the Preview Background color to Theme Color, else use the color-value specified in Preview Background color drop down. read-write
parent The parent of the PasteboardPreference (a Application or Document). read-only
pasteboardMargins Measurement Unit (Number or String)=any The minimum horizontal and vertical pasteboard margins. A horizontal margin of -1 means one document page width read-write
previewBackgroundColor 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. read-write
properties Object A property that allows setting of several properties at the same time. read-write
slugGuideColor 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. read-write

Methods

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