Spread

A spread.

Go to Property Listing | Method Listing

Methods:

createGuides, detach, duplicate, extractLabel, getElements, insertLabel, move, place, placeXML, remove, removeOverride, setContent, toSource, toSpecifier

Objects:

Boolean, Buttons, FlattenerPreference, FormFields, Graphic, GraphicLines, Groups, Guides, MasterSpread, NothingEnum, Number, Object, Ovals, PageItem, PageItems, Pages, Polygons, Rectangles, SpreadFlattenerLevel, String, TextFrames

Preferences:

FlattenerPreference

Property Listing

Property	Type	Access	Description
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Spread.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Spread.
allowPageShuffle	Boolean	read/write	If true, guarantees that when pages are added to a spread it will contain a maximum of two pages. If false, allows pages to be added or moved into existing spreads. For override information, see preserve layout when shuffling.
appliedMaster	MasterSpread NothingEnum.NOTHING	read/write	The master spread applied to the Spread. Can also accept: NothingEnum enumerator.
buttons	Buttons Button	readonly	A collection of buttons.
flattenerOverride	SpreadFlattenerLevel SpreadFlattenerLevel.CUSTOM SpreadFlattenerLevel.DEFAULT_VALUE SpreadFlattenerLevel.NONE	read/write	The transparency flattener preferences override for the spread.
flattenerPreferences	FlattenerPreference	readonly	Flattener preference settings.
formFields	FormFields FormField	readonly	A collection of form fields.
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
groups	Groups Group	readonly	A collection of groups.
guides	Guides Guide	readonly	A collection of guides.
id	Number	readonly	The unique ID of the Spread.
index	Number	readonly	The index of the Spread within its containing object.
label	String	read/write	A property that can be set to any string.
ovals	Ovals Oval	readonly	A collection of ellipses.
pageItems	PageItems PageItem	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
pages	Pages Page	readonly	A collection of pages.
parent	Document	readonly	The parent of the Spread (a Document).
polygons	Polygons Polygon	readonly	A collection of polygons.
properties	Object	read/write	A property that allows setting of several properties at the same time.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
showMasterItems	Boolean	read/write	If true, displays master page items on document pages in the spread.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.

Method Listing

undefined createGuides ([numberOfRows:Number=Number], [numberOfColumns:Number=Number], [rowGutter:Number String], [columnGutter:Number String], guideColor:Array of Varies 3 Reals (0 - 255) UIColors, [fitMargins:Boolean=Boolean], [removeExisting:Boolean=Boolean], layer:Layer)

Creates multiple guides on all pages of the spread.

Parameter	Type	Description
numberOfRows	Number (range 0 - 40)	The number of rows to create on each page. (Optional) (default: 0)
numberOfColumns	Number (range 0 - 40)	The number of columns to create on each page. (Optional) (default: 0)
rowGutter	Number String	The height of the gutter between rows. (Optional)
columnGutter	Number String	The width of the gutter between columns. (Optional)
guideColor	Array of 3 Reals (0 - 255) UIColors	The color to make the guides, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can accept: Array of 3 Reals (0 - 255) or UIColors enumerator. (Optional)
fitMargins	Boolean	If true, the row height and column width are calculated based on the space within the page margins. If false, row height and column width are calculated based on the full page. (Optional) (default: false)
removeExisting	Boolean	If true, removes existing guides when creating new ones. (Optional) (default: false)
layer	Layer	The layer on which to create the guides. (Optional)

undefined detach ()

Detaches an overridden master page item from the master page.

Varies duplicate ([to:LocationOptions=LocationOptions], reference:Varies Document Spread MasterSpread)

Duplicates the spread.

Parameter	Type	Description
to	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location of the spread relative to the reference object or within the document. (Optional) (default: LocationOptions.AT_END)
reference	Document Spread MasterSpread	The reference object. Note: Required only when the to parameter specifies before or after. Can accept: Spread, Document or MasterSpread. (Optional)

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location of the spread relative to the reference object or within the document. (Optional)

(default: LocationOptions.AT_END)

reference

Document

Spread

MasterSpread

The reference object. Note: Required only when the to parameter specifies before or after. Can accept: Spread, Document or MasterSpread. (Optional)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

Spread getElements ()

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

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

Spread move ([to:LocationOptions=LocationOptions], reference:Varies Page Spread Document)

Moves the spread.

Parameter	Type	Description
to	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location of the spread relative to the reference object or within the document. (Optional) (default: LocationOptions.AT_END)
reference	Page Spread Document	The reference object. Note: Required when the to parameter specifies before or after. Can accept: Spread, Page or Document. (Optional)

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location of the spread relative to the reference object or within the document. (Optional)

(default: LocationOptions.AT_END)

reference

Page

Spread

Document

The reference object. Note: Required when the to parameter specifies before or after. Can accept: Spread, Page or Document. (Optional)

Varies place (fileName:File, placePoint:Array of Number String, destinationLayer:Layer, [showingOptions:Boolean=Boolean], [autoflowing:Boolean=Boolean], withProperties:Object)

Places the file.

Parameter	Type	Description
fileName	File	The file to place
placePoint	Array of Number Array of String	The point at which to place (Optional)
destinationLayer	Layer	The layer on which to place (Optional)
showingOptions	Boolean	Whether to display the import options dialog (Optional) (default: false)
autoflowing	Boolean	Whether to autoflow placed text (Optional) (default: false)
withProperties	Object	Initial values for properties of the placed object(s) (Optional)

PageItem placeXML (using:XMLElement, placePoint:Array of Number String, [autoflowing:Boolean=Boolean])

Places the XML element onto a page. If the place point is above an existing page item, place the XML element into the page item.

Parameter	Type	Description
using	XMLElement	The XML element to place.
placePoint	Array of Number Array of String	The point at which to place the object, specified in the format [x, y].
autoflowing	Boolean	If true, autoflows placed text. (Optional) (default: false)

Parameter

Type

Description

using

XMLElement

The XML element to place.

placePoint

Array of Number

Array of String

The point at which to place the object, specified in the format [x, y].

autoflowing

Boolean