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. |
| allowPageShuffle | bool | r/w | If true, guarantees that when pages are added to a spread it will contain a maximum of two pages. If false, allows pages to be added or moved into existing spreads. For override information, see preserve layout when shuffling. |
| 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. |
| 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 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 Spread | The reference object. Note: Required only when the to parameter specifies before or after. Can accept: Spread, 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 Spread 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. |
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) |
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) |
PageItem placeXML (using:
XMLElement, placePoint:
Array
of Measurement Unit (Number or String)[, autoflowing:
bool=false])
Places the XML element onto a page. If the place point is above an existing page item, place the XML element into the page item.
| Parameter | Type | Description |
|---|---|---|
| using | XMLElement | The XML element to place. |
| placePoint | Array of Measurement Unit (Number or String) | The point at which to place the object, specified in the format [x, y]. |
| autoflowing | bool | If true, autoflows placed text. (Optional) (default: false) |
void remove ()
Deletes the Spread.
void removeOverride ()
Removes the override from a previously overridden master page item.
PageItem setContent (using:
string[, relativeBasePath:
string])
Replaces the content of XML element with content imported from a file.
| Parameter | Type | Description |
|---|---|---|
| using | string | The file path to the import file. |
| relativeBasePath | string | Base path used to resolve relative paths. (Optional) |
string toSource ()
Generates a string which, if executed, will return the Spread.
Element of
FlattenerPreference.parent
Guide.parent
LayoutWindow.activeSpread
Used in:
PageItem Button.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
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])
PageItem EPS.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
void EPS.move ([to: any][, by: Array of Measurement Unit (Number or String)])
PageItem FormField.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
void FormField.move ([to: any][, by: Array of Measurement Unit (Number or String)])
PageItem Graphic.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
void Graphic.move ([to: any][, by: Array of Measurement Unit (Number or String)])
PageItem GraphicLine.duplicate ([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])
PageItem Group.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
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])
PageItem Image.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
void Image.move ([to: any][, by: Array of Measurement Unit (Number or String)])
PageItem ImportedPage.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
void ImportedPage.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])
PageItem Oval.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
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])
PageItem PDF.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
void PDF.move ([to: any][, by: Array of Measurement Unit (Number or String)])
PageItem PICT.duplicate ([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])
PageItem PageItem.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
void PageItem.move ([to: any][, by: Array of Measurement Unit (Number or String)])
Page Pages.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
PageItem Polygon.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
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])
PageItem Rectangle.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
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])
any 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])
array of Spread Spreads.itemByRange (from: any, to: any)
Spread Spreads.nextItem (obj: Spread)
Spread Spreads.previousItem (obj: Spread)
PageItem TextFrame.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
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])
PageItem WMF.duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
void WMF.move ([to: any][, by: Array of Measurement Unit (Number or String)])
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 Spread Spread.getElements ()
Spread Spread.move ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
Spread Spreads.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Spread Spreads.anyItem ()
Array of Spread Spreads.everyItem ()
Spread Spreads.firstItem ()
Spread Spreads.item (index: any)
Spread Spreads.itemByID (id: number)
Spread Spreads.itemByName (name: string)
Array of Spread Spreads.itemByRange (from: any, to: any)
Spread Spreads.lastItem ()
Spread Spreads.middleItem ()
Spread Spreads.nextItem (obj: Spread)
Spread Spreads.previousItem (obj: Spread)
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |