InDesign Server2025
API 20.5.0.49
Object

PreflightOption

Preflight options.

Preference PreflightOption
Hierarchy

Application | Document

PreflightOption

Properties

NameType AccessDescription
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.
Application | Document readonly The parent of the PreflightOption (a Application or Document).
Boolean read/write If true, embed working profile when creating new document.
Boolean read/write If true, include objects that do not print when preflighting.
Boolean read/write If true, include objects on pasteboard when preflighting.
Boolean read/write If true, preflight is turned off for all documents or for this document.
PreflightProfileOptions
read/write The 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.
PreflightScopeOptions | String
read/write The 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.
PreflightLayerOptions
read/write Which layers to preflight.
PreflightProfile | String read/write The working preflight profile. Can return: PreflightProfile or String.
Object read/write A property that allows setting of several properties at the same time.

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

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

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a PreflightOption.

Parameter of 1

Method parameters that accept a PreflightOption.

Return 1

Methods that return a PreflightOption.