A layout window.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| activeLayer | Layer | r/w | The active layer. Can also accept: String. |
| activePage | Page | r/w | The front-most page. |
| activeSpread | any | r/w | The front-most spread. Can return: Spread or MasterSpread. |
| bounds | Array of number | r/w | The bounds of the window (specified in pixels) in the form [top, left, bottom, right]. |
| index | number | readonly | The index of the LayoutWindow within its containing object. |
| name | string | readonly | The name of the LayoutWindow. |
| overprintPreview | bool | r/w | If true, display a simulation of overprinting. |
| parent | any | readonly | The parent of the LayoutWindow (a Document or Application). |
| preserveColorNumbers | bool | r/w | 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. |
| proofingProfile | string | r/w | The profile used for proofing colors. |
| proofingType | ProofingType : PROOF_OFF DOCUMENT_CMYK WORKING_CMYK CUSTOM |
r/w | The method of proofing colors. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| screenMode | ScreenModeOptions : PREVIEW_OFF PREVIEW_TO_PAGE PREVIEW_TO_BLEED PREVIEW_TO_SLUG |
r/w | The screen mode for layout view. |
| selection | Array of Object | r/w | The selected object(s). Can also accept: Object or NothingEnum enumerator. |
| simulateInkBlack | bool | r/w | 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. |
| simulatePaperWhite | bool | r/w | If true, simulates the dingy white of real paper, according to the proofing profile. Note: Valid only when proofing type is custom. |
| transformReferencePoint | any | r/w | The default anchor point around which to transform objects. Can return: AnchorPoint enumerator or Array of 2 Units. |
| viewDisplaySetting | ViewDisplaySettings : HIGH_QUALITY TYPICAL OPTIMIZED |
r/w | The display performance preferences override for the view. |
| zoomPercentage | number | r/w | The size (as a percentage) to which to enlarge or reduce the view of the document. (Range: 5 to 4000) |
Methods
void bringToFront ()
Brings the LayoutWindow to the front of its layer.
void close ()
Closes the LayoutWindow.
Array of LayoutWindowgetElements ()
Resolves the object specifier, creating an array of object references.
void maximize ()
Maximizes the window.
void minimize ()
Minimizes the window.
void restore ()
Restores the window.
void select (selectableItems:
any[, existingSelection:
SelectionOptions=REPLACE_WITH ])
Selects the specified object(s).
| Parameter | Type | Description |
|---|---|---|
| selectableItems | Object Array of Objects NothingEnum SelectAll |
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. |
| existingSelection | SelectionOptions : ADD_TO REMOVE_FROM REPLACE_WITH |
The selection status of the LayoutWindow in relation to previously selected objects. (Optional) (default: REPLACE_WITH ) |
string toSource ()
Generates a string which, if executed, will return the LayoutWindow.
string toSpecifier ()
Retrieves the object specifier.
void zoom (given:
ZoomOptions)
Magnifies or reduces the window to the specified display size.
| Parameter | Type | Description |
|---|---|---|
| given | ZoomOptions : ZOOM_IN ZOOM_OUT FIT_SPREAD FIT_PAGE SHOW_PASTEBOARD ACTUAL_SIZE |
The display size. |
Used in:
LayoutWindows.previousItem (
obj:
LayoutWindow )
LayoutWindows.nextItem (
obj:
LayoutWindow )
Returned by:
Array of LayoutWindow LayoutWindow .getElements (
)
LayoutWindow LayoutWindows.anyItem (
)
Array of LayoutWindow LayoutWindows.everyItem (
)
LayoutWindow LayoutWindows.firstItem (
)
LayoutWindow LayoutWindows.item (
index:
any
)
LayoutWindow LayoutWindows.itemByName (
name:
string
)
Array of LayoutWindow LayoutWindows.itemByRange (
from:
any, to:
any
)
LayoutWindow LayoutWindows.lastItem (
)
LayoutWindow LayoutWindows.middleItem (
)
LayoutWindow LayoutWindows.nextItem (
obj:
LayoutWindow
)
LayoutWindow LayoutWindows.previousItem (
obj:
LayoutWindow
)