MasterSpread

Methods:

createGuides, duplicate, extractLabel, insertLabel, place, remove

Objects:

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

Property Listing

Property	Type	Access	Description
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the MasterSpread.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the MasterSpread.
appliedMaster	MasterSpread NothingEnum.NOTHING	read/write	The master spread applied to the MasterSpread. Can also accept: NothingEnum enumerator.
baseName	String	read/write	The name of the master spread.
buttons	Buttons Button	readonly	A collection of buttons.
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 MasterSpread.
index	Number	readonly	The index of the MasterSpread within its containing object.
label	String	read/write	A property that can be set to any string.
name	String	readonly	The name of the MasterSpread.
namePrefix	String	read/write	The prefix of the master spread name.
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 MasterSpread (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 a spread

Parameter	Type	Description
numberOfRows	Number	Number of rows of guides on a page (Optional) (default: 0)
numberOfColumns	Number	Number of columns of guides on a page (Optional) (default: 0)
rowGutter	Number String	The amount of gutter between rows (Optional)
columnGutter	Number String	The amount of gutter between columns (Optional)
guideColor	Array of 3 Reals (0 - 255) UIColors	The guide's color. Can accept: Array of 3 Reals (0 - 255) or UIColors enumerator. (Optional)
fitMargins	Boolean	Whether the guides should fit to margins or fit to page (Optional) (default: false)
removeExisting	Boolean	Whether to remove existing guides (Optional) (default: false)
layer	Layer	The layer on which to create the MasterSpread (Optional)

MasterSpread duplicate ()

Duplicates the MasterSpread.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

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.

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

Places a file in the document.

Parameter	Type	Description
fileName	File	The file to place.
placePoint	Array of Number Array of String	The point where to place the object (only applicable if you are telling a page or spread to place) (Optional)
destinationLayer	Layer Array of Layers.	The layer(s) to place the file on (only valid if you are telling a page or spread to place). Can accept: Layer or Array of Layers. (Optional)
showingOptions	Boolean	Whether to display the import options dialog (Optional) (default: false)
autoflowing	Boolean	Whether to autoflow placed text (Optional) (default: false)
retainingFormatting	Boolean	Whether to keep formatting of placed text files (Optional) (default: true)
convertingQuotes	Boolean	Whether to convert to typographer's quotes (Optional) (default: true)
withProperties	Object	Initial values for properties of the placed object(s) (Optional)