Adobe InDesign CS6 Server (8.0) Object Model JS: PasteboardPreference

InDesign Server CS6

Class

PasteboardPreference

 Pasteboard preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
PasteboardPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
bleedGuideColor3 Reals (0 - 255)
UIColors
r/wThe 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.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication
Document
readonlyThe parent of the PasteboardPreference (a Application or Document).
pasteboardMarginsArray of Measurement Unit (Number or String) r/wThe minimum horizontal and vertical pasteboard margins. A horizontal margin of -1 means one document page width
previewBackgroundColor3 Reals (0 - 255)
UIColors
r/wThe 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.
propertiesObject r/wA property that allows setting of several properties at the same time.
slugGuideColor3 Reals (0 - 255)
UIColors
r/wThe 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

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.pasteboardPreferences

Document.pasteboardPreferences

Return

Array of PasteboardPreference PasteboardPreference.getElements ()

Jongware, 28-Apr-2012 v3.0.3iContents :: Index