PasteboardPreference

Pasteboard preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, String, UIColors,

Hierarchy:

Superclass: Preference

Class: PasteboardPreference

Property Listing

Property

Type

Access

Description

bleedGuideColor

Array of 3 Reals (0 - 255)

UIColors

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

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Application

Document

readonly

The parent of the PasteboardPreference (a Application or Document).

pasteboardMargins

Array of Number

Array of String

read/write

The minimum horizontal and vertical pasteboard margins. A horizontal margin of -1 means one document page width

previewBackgroundColor

Array of 3 Reals (0 - 255)

UIColors

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.

properties

Object

read/write

A property that allows setting of several properties at the same time.

slugGuideColor

Array of 3 Reals (0 - 255)

UIColors

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.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

PasteboardPreference getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.pasteboardPreferences

Document.pasteboardPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

PasteboardPreference.getElements()