Packagecom.adobe.indesign
Classpublic class MasterSpread
InheritanceMasterSpread Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  allGraphics : Object
[read-only] Lists all graphics contained by the MasterSpread.
MasterSpread
  allPageItems : Object
[read-only] Lists all page items contained by the MasterSpread.
MasterSpread
  appliedMaster : MasterSpread
The master spread applied to the MasterSpread.
MasterSpread
  baseName : String
The name of the master spread.
MasterSpread
  buttons : Buttons
[read-only] A collection of buttons.
MasterSpread
  epstexts : EPSTexts
[read-only] EPSTexts
MasterSpread
  eventListeners : EventListeners
[read-only] A collection of event listeners.
MasterSpread
  events : Events
[read-only] A collection of events.
MasterSpread
  formFields : FormFields
[read-only] A collection of form fields.
MasterSpread
  graphicLines : GraphicLines
[read-only] A collection of graphic lines.
MasterSpread
  groups : Groups
[read-only] A collection of groups.
MasterSpread
  guides : Guides
[read-only] A collection of guides.
MasterSpread
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the MasterSpread.
MasterSpread
  idmlComponentName : String
The IDML component name of the MasterSpread.
MasterSpread
  index : Number
[read-only] The index of the MasterSpread within its containing object.
MasterSpread
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
MasterSpread
  label : String
A property that can be set to any string.
MasterSpread
  multiStateObjects : MultiStateObjects
[read-only] A collection of multi-state objects.
MasterSpread
  name : String
[read-only] The name of the MasterSpread.
MasterSpread
  namePrefix : String
The prefix of the master spread name.
MasterSpread
  ovals : Ovals
[read-only] A collection of ellipses.
MasterSpread
  pageColor : Object
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.
MasterSpread
  pageItems : PageItems
[read-only] 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.
MasterSpread
  pages : Pages
[read-only] A collection of pages.
MasterSpread
  parent : Document
[read-only] The parent of the MasterSpread (a Document).
MasterSpread
  polygons : Polygons
[read-only] A collection of polygons.
MasterSpread
  preferences : Preferences
[read-only] A collection of preferences objects.
MasterSpread
  properties : Object
A property that allows setting of several properties at the same time.
MasterSpread
  rectangles : Rectangles
[read-only] A collection of rectangles.
MasterSpread
  showMasterItems : Boolean
If true, displays master page items on document pages in the spread.
MasterSpread
  splineItems : SplineItems
[read-only] The spline items collection.
MasterSpread
  textFrames : TextFrames
[read-only] A collection of text frames.
MasterSpread
  timingSettings : TimingSetting
[read-only] The object timing settings.
MasterSpread
Public Methods
 MethodDefined By
  
addEventListenerMasterSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
MasterSpread
  
createGuides(numberOfRowsParam:Number = 0, numberOfColumnsParam:Number = 0, rowGutterParam:Object = 0, columnGutterParam:Object = 0, guideColorParam:Object = null, fitMarginsParam:Boolean = false, removeExistingParam:Boolean = false, layerParam:Layer = null):void
Creates multiple guides on all pages of the spread.
MasterSpread
  
detach():void
Detaches an overridden master page item from the master page.
MasterSpread
  
duplicate(toParam:LocationOptions = null, referenceParam:Object = null):Object
Duplicates the spread.
MasterSpread
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
MasterSpread
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
Resolves the object specifier, creating an array of object references.
MasterSpread
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
MasterSpread
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
place(fileNameParam:File = null, placePointParam:Array = null, destinationLayerParam:Layer = null, showingOptionsParam:Boolean = false, autoflowingParam:Boolean = false, withPropertiesParam:Object = null):Object
Places the file.
MasterSpread
  
remove():void
Deletes the MasterSpread.
MasterSpread
  
removeEventListenerMasterSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
MasterSpread
  
Removes the override from a previously overridden master page item.
MasterSpread
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
Get the coordinates of the given location in the specified coordinate system.
MasterSpread
  
select(existingSelectionParam:SelectionOptions = null):void
Selects the object.
MasterSpread
  
toSpecifier():String
Retrieves the object specifier.
MasterSpread
  
transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
Transform the page item.
MasterSpread
  
transformValuesOf(inParam:CoordinateSpaces = null):Object
Get the transformation values of the page item.
MasterSpread
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
allGraphicsproperty
allGraphics:Object  [read-only]

Lists all graphics contained by the MasterSpread.


Implementation
    public function get allGraphics():Object
allPageItemsproperty 
allPageItems:Object  [read-only]

Lists all page items contained by the MasterSpread.


Implementation
    public function get allPageItems():Object
appliedMasterproperty 
appliedMaster:MasterSpread

The master spread applied to the MasterSpread. Can also accept: NothingEnum enumerator.


Implementation
    public function get appliedMaster():MasterSpread
    public function set appliedMaster(value:MasterSpread):void
baseNameproperty 
baseName:String

The name of the master spread.


Implementation
    public function get baseName():String
    public function set baseName(value:String):void
buttonsproperty 
buttons:Buttons  [read-only]

A collection of buttons.


Implementation
    public function get buttons():Buttons
epstextsproperty 
epstexts:EPSTexts  [read-only]

EPSTexts


Implementation
    public function get epstexts():EPSTexts
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
formFieldsproperty 
formFields:FormFields  [read-only]

A collection of form fields.


Implementation
    public function get formFields():FormFields
graphicLinesproperty 
graphicLines:GraphicLines  [read-only]

A collection of graphic lines.


Implementation
    public function get graphicLines():GraphicLines
groupsproperty 
groups:Groups  [read-only]

A collection of groups.


Implementation
    public function get groups():Groups
guidesproperty 
guides:Guides  [read-only]

A collection of guides.


Implementation
    public function get guides():Guides
idproperty 
id:Number  [read-only]

The unique ID of the MasterSpread.


Implementation
    public function get id():Number
idmlComponentNameproperty 
idmlComponentName:String

The IDML component name of the MasterSpread.


Implementation
    public function get idmlComponentName():String
    public function set idmlComponentName(value:String):void
indexproperty 
index:Number  [read-only]

The index of the MasterSpread within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
multiStateObjectsproperty 
multiStateObjects:MultiStateObjects  [read-only]

A collection of multi-state objects.


Implementation
    public function get multiStateObjects():MultiStateObjects
nameproperty 
name:String  [read-only]

The name of the MasterSpread.


Implementation
    public function get name():String
namePrefixproperty 
namePrefix:String

The prefix of the master spread name.


Implementation
    public function get namePrefix():String
    public function set namePrefix(value:String):void
ovalsproperty 
ovals:Ovals  [read-only]

A collection of ellipses.


Implementation
    public function get ovals():Ovals
pageColorproperty 
pageColor:Object

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.


Implementation
    public function get pageColor():Object
    public function set pageColor(value:Object):void
pageItemsproperty 
pageItems:PageItems  [read-only]

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.


Implementation
    public function get pageItems():PageItems
pagesproperty 
pages:Pages  [read-only]

A collection of pages.


Implementation
    public function get pages():Pages
parentproperty 
parent:Document  [read-only]

The parent of the MasterSpread (a Document).


Implementation
    public function get parent():Document
polygonsproperty 
polygons:Polygons  [read-only]

A collection of polygons.


Implementation
    public function get polygons():Polygons
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rectanglesproperty 
rectangles:Rectangles  [read-only]

A collection of rectangles.


Implementation
    public function get rectangles():Rectangles
showMasterItemsproperty 
showMasterItems:Boolean

If true, displays master page items on document pages in the spread.


Implementation
    public function get showMasterItems():Boolean
    public function set showMasterItems(value:Boolean):void
splineItemsproperty 
splineItems:SplineItems  [read-only]

The spline items collection.


Implementation
    public function get splineItems():SplineItems
textFramesproperty 
textFrames:TextFrames  [read-only]

A collection of text frames.


Implementation
    public function get textFrames():TextFrames
timingSettingsproperty 
timingSettings:TimingSetting  [read-only]

The object timing settings.


Implementation
    public function get timingSettings():TimingSetting
Method Detail
addEventListenerMasterSpread()method
public function addEventListenerMasterSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
createGuides()method 
public function createGuides(numberOfRowsParam:Number = 0, numberOfColumnsParam:Number = 0, rowGutterParam:Object = 0, columnGutterParam:Object = 0, guideColorParam:Object = null, fitMarginsParam:Boolean = false, removeExistingParam:Boolean = false, layerParam:Layer = null):void

Creates multiple guides on all pages of the spread.

Parameters

numberOfRowsParam:Number (default = 0) — (Number) The number of rows to create on each page. (Optional)
 
numberOfColumnsParam:Number (default = 0) — (Number) The number of columns to create on each page. (Optional)
 
rowGutterParam:Object (default = 0) — (Object) The height of the gutter between rows. (Optional)
 
columnGutterParam:Object (default = 0) — (Object) The width of the gutter between columns. (Optional)
 
guideColorParam:Object (default = null) — (Object) 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)
 
fitMarginsParam:Boolean (default = false) — (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)
 
removeExistingParam:Boolean (default = false) — (Boolean) If true, removes existing guides when creating new ones. (Optional)
 
layerParam:Layer (default = null) — (Layer) The layer on which to create the guides. (Optional)

detach()method 
public function detach():void

Detaches an overridden master page item from the master page.

duplicate()method 
public function duplicate(toParam:LocationOptions = null, referenceParam:Object = null):Object

Duplicates the spread.

Parameters

toParam:LocationOptions (default = null) — (LocationOptions) The location of the spread relative to the reference object or within the document. (Optional)
 
referenceParam:Object (default = null) — (Object) The reference object. Note: Required only when the to parameter specifies before or after. Can accept: MasterSpread, Document or MasterSpread. (Optional)

Returns
Object
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

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

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

place()method 
public function place(fileNameParam:File = null, placePointParam:Array = null, destinationLayerParam:Layer = null, showingOptionsParam:Boolean = false, autoflowingParam:Boolean = false, withPropertiesParam:Object = null):Object

Places the file.

Parameters

fileNameParam:File (default = null) — (File) The file to place
 
placePointParam:Array (default = null) — (Array) The point at which to place (Optional)
 
destinationLayerParam:Layer (default = null) — (Layer) The layer on which to place (Optional)
 
showingOptionsParam:Boolean (default = false) — (Boolean) Whether to display the import options dialog (Optional)
 
autoflowingParam:Boolean (default = false) — (Boolean) Whether to autoflow placed text (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the placed object(s) (Optional)

Returns
Object
remove()method 
public function remove():void

Deletes the MasterSpread.

removeEventListenerMasterSpread()method 
public function removeEventListenerMasterSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
removeOverride()method 
public function removeOverride():void

Removes the override from a previously overridden master page item.

resolve()method 
public function resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object

Get the coordinates of the given location in the specified coordinate system.

Parameters

locationParam:Object (default = null) — (Object) 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.
 
inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use.
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) 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)

Returns
Object
select()method 
public function select(existingSelectionParam:SelectionOptions = null):void

Selects the object.

Parameters

existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the MasterSpread in relation to previously selected objects. (Optional)

toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String
transform()method 
public function transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void

Transform the page item.

Parameters

inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use
 
fromParam:Object (default = null) — (Object) 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.
 
withMatrixParam:Object (default = null) — (Object) Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
 
replacingCurrentParam:Object (default = null) — (Object) 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)
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) 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)

transformValuesOf()method 
public function transformValuesOf(inParam:CoordinateSpaces = null):Object

Get the transformation values of the page item.

Parameters

inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use

Returns
Object