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. |
| index | number | readonly | The index of the MasterSpread within its containing object. |
| 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 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 | Measurement Unit (Number or String) | The amount of gutter between rows (Optional) (default: 0) |
| columnGutter | Measurement Unit (Number or String) | The amount of gutter between columns (Optional) (default: 0) |
| 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 | bool | Whether the guides should fit to margins or fit to page (Optional) (default: false) |
| removeExisting | bool | 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. |
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. |
any place (fileName:
File[, placePoint:
Array
of Measurement Unit (Number or String)][, destinationLayer:
any][, showingOptions:
bool=false][, autoflowing:
bool=false][, retainingFormatting:
bool=true][, convertingQuotes:
bool=true][, withProperties:
Object])
Places a file in the document.
| Parameter | Type | Description |
|---|---|---|
| fileName | File | The file to place. |
| placePoint | Array of Measurement Unit (Number or String) | The point where to place the object (only applicable if you are telling a page or spread to place) (Optional) |
| destinationLayer |
Array
of Layers Layer | 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 | bool | Whether to display the import options dialog (Optional) (default: false) |
| autoflowing | bool | Whether to autoflow placed text (Optional) (default: false) |
| retainingFormatting | bool | Whether to keep formatting of placed text files (Optional) (default: true) |
| convertingQuotes | bool | Whether to convert to typographer's quotes (Optional) (default: true) |
| withProperties | Object | Initial values for properties of the placed object(s) (Optional) |
Element of
Guide.parent
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])
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])
TextFrame TextFrames.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Return
MasterSpread MasterSpread.duplicate ()
MasterSpread MasterSpreads.add ([pagesPerSpread: number][, withProperties: Object])
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |