InDesign2026
API 21.5.1.73
Object

LayoutWindow

A layout window.

Window LayoutWindow
Hierarchy

Document

LayoutWindow

Properties

NameType AccessDescription
Layer | String read/write The active layer. Can also accept: String.
Page read/write The front-most page.
Spread | MasterSpread read/write The front-most spread. Can return: Spread or MasterSpread.
Number[] read/write The bounds of the window (specified in pixels) in the form [top, left, bottom, right].
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The index of the LayoutWindow within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String readonly The name of the LayoutWindow.
Boolean read/write If true, display a simulation of overprinting.
Document readonly The parent of the LayoutWindow (a Document).
Boolean read/write If true, leaves color values unchanged for CMYK objects without embedded profiles and native objects such as line art or type. Note: Converts images whose profiles differ from the profile of the simulated device. Valid only when proofing type is custom.
String read/write The profile used for proofing colors.
ProofingType
read/write The method of proofing colors.
Object read/write A property that allows setting of several properties at the same time.
ScreenModeOptions
read/write The screen mode for layout view.
Object[] | Object[] | NothingEnum[]
read/write The selected object(s). Can also accept: Object or NothingEnum enumerator.
PageItem | NothingEnum
read/write The key object of the selection. Can also accept: NothingEnum enumerator.
Boolean read/write If true, simulates the dark gray produced by many printers in place of solid black, according to the proofing profile. Note: Valid only when proofing type is custom.
Boolean read/write If true, simulates the dingy white of real paper, according to the proofing profile. Note: Valid only when proofing type is custom.
AnchorPoint[] | 2 Units[]
read/write The default anchor point around which to transform objects. Can return: AnchorPoint enumerator or Array of 2 Units.
ViewDisplaySettings
read/write The display performance preferences override for the view.
Number 5–4000 read/write The size (as a percentage) to which to enlarge or reduce the view of the document. (Range: 5 to 4000)

Events

NameDescription
Dispatched after the LayoutWindow becomes active. This event bubbles. This event is not cancelable.
Dispatched when the value of a property changes on this LayoutWindow. This event bubbles. This event is not cancelable.
Dispatched when a LayoutWindow is closing. Since the close has been committed, it can no longer be canceled. This event bubbles. This event is not cancelable.
Dispatched after a LayoutWindow is opened. This event bubbles. This event is not cancelable.
Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable.
Dispatched after the active selection changes. This event bubbles. This event is not cancelable.
Dispatched before a LayoutWindow is closed. This event bubbles. This event is cancelable.
Dispatched before the LayoutWindow becomes inactive. This event bubbles. This event is not cancelable.

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

Brings the object to the front.

void

Closes the LayoutWindow.

LayoutWindow[]

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

void

Maximizes the window.

void

Minimizes the window.

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

Restores the window.

void

Selects the specified object(s).

selectableItems Objects[] | NothingEnum[] | Object[] | SelectAll[] The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelection? SelectionOptions The selection status of the LayoutWindow in relation to previously selected objects.
String

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

String

Retrieves the object specifier.

void

Magnifies or reduces the window to the specified display size.

given ZoomOptions The display size.

Object of 4

Properties elsewhere that hold a LayoutWindow.

Parameter of 3

Method parameters that accept a LayoutWindow.

Return 12

Methods that return a LayoutWindow.