Adobe InDesign CS5 (7.0) Object Model JS: MasterSpread

InDesign CS5

previous page next page

Class

MasterSpread

A master spread.

QuickLinks

addEventListener, createGuides, detach, duplicate, extractLabel, getElements, insertLabel, place, remove, removeEventListener, removeOverride, resolve, select, toSource, toSpecifier, transform, transformValuesOf

Hierarchy

Document

MasterSpread

Properties

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	MasterSpreadNothingEnum	r/w	The master spread applied to the MasterSpread. Can also accept: NothingEnum enumerator.
baseName	string	r/w	The name of the master spread.
buttons	Buttons	readonly	A collection of buttons.
epstexts	EPSTexts	readonly	EPSTexts
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
formFields	FormFields	readonly	A collection of form fields.
graphicLines	GraphicLines	readonly	A collection of graphic lines.
groups	Groups	readonly	A collection of groups.
guides	Guides	readonly	A collection of guides.
id	number	readonly	The unique ID of the MasterSpread.
idmlComponentName	string	r/w	The IDML component name of the MasterSpread.
index	number	readonly	The index of the MasterSpread within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
multiStateObjects	MultiStateObjects	readonly	A collection of multi-state objects.
name	string	readonly	The name of the MasterSpread.
namePrefix	string	r/w	The prefix of the master spread name.
ovals	Ovals	readonly	A collection of ellipses.
pageColor	3 Reals (0 - 255) PageColorOptions UIColors	r/w	The color label of the MasterSpread, 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 return: Array of 3 Reals (0 - 255) or UIColors enumerator or PageColorOptions enumerator.
pageItems	PageItems	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	readonly	A collection of pages.
parent	Document	readonly	The parent of the MasterSpread (a Document).
polygons	Polygons	readonly	A collection of polygons.
preferences	Preferences	readonly	A collection of preferences objects.
properties	Object	r/w	A property that allows setting of several properties at the same time.
rectangles	Rectangles	readonly	A collection of rectangles.
showMasterItems	bool	r/w	If true, displays master page items on document pages in the spread.
splineItems	SplineItems	readonly	The spline items collection.
textFrames	TextFrames	readonly	A collection of text frames.
timingSettings	TimingSetting	readonly	The object timing settings.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void createGuides ([numberOfRows: number=0][, numberOfColumns: number=0][, rowGutter: Measurement Unit (Number or String)=0][, columnGutter: Measurement Unit (Number or String)=0][, guideColor: varies][, fitMargins: bool=false][, removeExisting: bool=false][, 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	Measurement Unit (Number or String) (range: 0 - 1440)	The height of the gutter between rows. (Optional) (default: 0)
columnGutter	Measurement Unit (Number or String) (range: 0 - 1440)	The width of the gutter between columns. (Optional) (default: 0)
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	bool	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	bool	If true, removes existing guides when creating new ones. (Optional) (default: false)
layer	Layer	The layer on which to create the guides. (Optional)

void detach ()
Detaches an overridden master page item from the master page.

any duplicate ([to: LocationOptions=LocationOptions.AT_END][, reference: varies])
Duplicates the spread.

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

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of MasterSpread getElements ()
Resolves the object specifier, creating an array of object references.

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

Array of any place (fileName: File[, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, showingOptions: bool=false][, autoflowing: bool=false][, withProperties: Object])
Places the file.

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

void remove ()
Deletes the MasterSpread.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void removeOverride ()
Removes the override from a previously overridden master page item.

any resolve (location: varies, in: CoordinateSpaces[, consideringRulerUnits: bool=false])
Get the coordinates of the given location in the specified coordinate system.

Parameter	Type	Description
location	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use.
consideringRulerUnits	bool	If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

Parameter	Type	Description
existingSelection	SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH	The selection status of the MasterSpread in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

string toSource ()
Generates a string which, if executed, will return the MasterSpread.

string toSpecifier ()
Retrieves the object specifier.

void transform (in: CoordinateSpaces, from: varies, withMatrix: varies[, replacingCurrent: varies][, consideringRulerUnits: bool=false])
Transform the page item.

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use
from	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
withMatrix	Array of 6 Reals TransformationMatrix	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent	Array of MatrixContent Long Integer MatrixContent	Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
consideringRulerUnits	bool	If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false)

Array of TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use