MasterSpread
QuickLinks
Hierarchy
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. |
| 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. |
| 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. |
| 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. |
| 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. |
| textFrames | TextFrames | readonly | A collection of text frames. |
Methods
Instances
void createGuides ([numberOfRows:
number=0][, numberOfColumns:
number=0][, rowGutter:
Measurement Unit (Number or String)=0][, columnGutter:
Measurement Unit (Number or String)=0][, guideColor:
any][, 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:
any])
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.
void removeOverride ()
Removes the override from a previously overridden master page item.
string toSource ()
Generates a string which, if executed, will return the MasterSpread.
string toSpecifier ()
Retrieves the object specifier.
Element of
LayoutWindow.activeSpread
MasterSpread.appliedMaster
Page.appliedMaster
Page.parent
Spread.appliedMaster
Used in:
Button Buttons.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
GraphicLine GraphicLines.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Group Groups.add (groupItems: Array of PageItem[, layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
array of Story Index.generate ([on: any][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, autoflowing: bool=false][, includeOverset: bool=false])
any MasterSpread.duplicate ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
array of MasterSpread MasterSpreads.itemByRange (from: any, to: any)
MasterSpread MasterSpreads.nextItem (obj: MasterSpread)
MasterSpread MasterSpreads.previousItem (obj: MasterSpread)
Movie Movies.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Oval Ovals.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Page Pages.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Polygon Polygons.add ([layer: Layer][, numberOfSides: number][, insetPercentage: number][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Rectangle Rectangles.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Sound Sounds.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
any Spread.duplicate ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
TextFrame TextFrames.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
PageItem XMLElement.placeIntoCopy (on: any, placePoint: Array of Measurement Unit (Number or String), copyItem: PageItem[, retainExistingFrame: bool=false])
PageItem XMLElement.placeIntoFrame (on: any, geometricBounds: Array of Measurement Unit (Number or String))
Return
Array of MasterSpread MasterSpread.getElements ()
MasterSpread MasterSpreads.[] (index: number)
MasterSpread MasterSpreads.add ([pagesPerSpread: number][, withProperties: Object])
MasterSpread MasterSpreads.anyItem ()
Array of MasterSpread MasterSpreads.everyItem ()
MasterSpread MasterSpreads.firstItem ()
MasterSpread MasterSpreads.item (index: any)
MasterSpread MasterSpreads.itemByID (id: number)
MasterSpread MasterSpreads.itemByName (name: string)
Array of MasterSpread MasterSpreads.itemByRange (from: any, to: any)
MasterSpread MasterSpreads.lastItem ()
MasterSpread MasterSpreads.middleItem ()
MasterSpread MasterSpreads.nextItem (obj: MasterSpread)
MasterSpread MasterSpreads.previousItem (obj: MasterSpread)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |