Spread
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allGraphics | Array of Graphic | readonly | Lists all graphics contained by the Spread. |
| allPageItems | Array of PageItem | readonly | Lists all page items contained by the Spread. |
| appliedMaster | MasterSpreadNothingEnum | r/w | The master spread applied to the Spread. Can also accept: NothingEnum enumerator. |
| buttons | Buttons | readonly | A collection of buttons. |
| flattenerOverride | SpreadFlattenerLevel: SpreadFlattenerLevel.DEFAULT_VALUE SpreadFlattenerLevel.NONE SpreadFlattenerLevel.CUSTOM |
r/w | The transparency flattener preferences override for the spread. |
| flattenerPreferences | FlattenerPreference | readonly | Flattener preference settings. |
| 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 Spread. |
| index | number | readonly | The index of the Spread within its containing object. |
| keepTogether | bool | r/w | If true, keeps the spread's pages together when the spread is moved. Also, allows the addition of pages in the spread by moving or creating pages before or after any of the existing pages in the spread. If false, the pages in the spread are redistributed to match the facing pages pattern for the document. |
| label | string | r/w | A property that can be set to any string. |
| 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 Spread (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 Spread (Optional) |
Spread duplicate ([to:
LocationOptions=LocationOptions.AT_END][, reference:
any])
Duplicate the Spread at before/after another Spread, or at the beginning/end of a document
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | Location (Optional) (default: LocationOptions.AT_END) |
| reference | Document Spread | Before/after an existing spread or at the beginning/end of a parent. Can accept: Spread or Document. (Optional) |
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. |
Spread move ([to:
LocationOptions=LocationOptions.AT_END][, reference:
any])
Moves 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 Page Spread | The reference object. Note: Required when the to parameter specifies before or after. Can accept: Spread, Page or Document. (Optional) |
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) |
void remove ()
Deletes the Spread.
void removeOverride ()
Removes the override from a previously overridden master page item.
Element of
FlattenerPreference.parent
Guide.parent
LayoutWindow.activeSpread
Used in:
void Button.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Button Buttons.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void EPS.move ([to: any][, by: Array of Measurement Unit (Number or String)])
void FormField.move ([to: any][, by: Array of Measurement Unit (Number or String)])
void Graphic.move ([to: any][, by: Array of Measurement Unit (Number or String)])
void GraphicLine.move ([to: any][, by: Array of Measurement Unit (Number or String)])
GraphicLine GraphicLines.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void Group.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Group Groups.add (groupItems: Array of PageItem[, layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void Image.move ([to: any][, by: Array of Measurement Unit (Number or String)])
array of Story Index.generate ([on: any][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, autoflowing: bool=false][, includeOverset: bool=false])
void Movie.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Movie Movies.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void Oval.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Oval Ovals.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void PDF.move ([to: any][, by: Array of Measurement Unit (Number or String)])
void PICT.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Page Page.duplicate ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
Page Page.move ([to: LocationOptions=LocationOptions.AT_END][, reference: any][, binding: BindingOptions=BindingOptions.DEFAULT_VALUE])
void PageItem.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Page Pages.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void Polygon.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Polygon Polygons.add ([layer: Layer][, numberOfSides: number][, insetPercentage: number][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void Rectangle.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Rectangle Rectangles.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void Sound.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Sound Sounds.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Spread Spread.duplicate ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
Spread Spread.move ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
Spread Spreads.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void TextFrame.move ([to: any][, by: Array of Measurement Unit (Number or String)])
TextFrame TextFrames.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
void WMF.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Return
Spread Spread.duplicate ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
Spread Spread.move ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
Spread Spreads.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |