Adobe InDesign CS6 (8.0) Object Model JS: PreflightOption

InDesign CS6

Class

PreflightOption

 Preflight options. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
PreflightOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplicationDocument readonlyThe parent of the PreflightOption (a Application or Document).
preflightEmbedWorkingProfilebool r/wIf true, embed working profile when creating new document.
preflightIncludeNonprintingObjectsbool r/wIf true, include objects that do not print when preflighting.
preflightIncludeObjectsOnPasteboardbool r/wIf true, include objects on pasteboard when preflighting.
preflightOffbool r/wIf true, preflight is turned off for all documents or for this document.
preflightProfilePolicyPreflightProfileOptions:
PreflightProfileOptions.USE_EMBEDDED_PROFILE
PreflightProfileOptions.USE_WORKING_PROFILE
r/wThe policy for preflighting applied when opening a document or book, whether to use embedded profile or the another profile when the preflight is turned on.
preflightScopePreflightScopeOptions
String
r/wThe pages or documents to preflight, specified either as an enumeration or a string. To specify a range, separate page numbers in the string with a hyphen (-). To specify separate pages, separate page numbers in the string with a comma (,). Can return: PreflightScopeOptions enumerator or String.
preflightWhichLayersPreflightLayerOptions:
PreflightLayerOptions.PREFLIGHT_ALL_LAYERS
PreflightLayerOptions.PREFLIGHT_VISIBLE_LAYERS
PreflightLayerOptions.PREFLIGHT_VISIBLE_PRINTABLE_LAYERS
r/wWhich layers to preflight.
preflightWorkingProfilePreflightProfile
String
r/wThe working preflight profile. Can return: PreflightProfile or String.
propertiesObject r/wA property that allows setting of several properties at the same time.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.preflightOptions

Document.preflightOptions

Used in:

PreflightProcess PreflightProcesses.add (targetObject: Document, appliedProfile: PreflightProfile[, preflightOptions: PreflightOption][, withProperties: Object])

Return

Array of PreflightOption PreflightOption.getElements ()

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