Object

Spread

A spread.

Hierarchy

Spread

3 preference objects

FlattenerPreference | Preference | TimingSetting

Properties

Type	Access	Description
Graphic[]	readonly	Lists all graphics contained by the Spread.
PageItem[]	readonly	Lists all page items contained by the Spread.
Boolean	read/write	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.
MasterSpread \| NothingEnum	read/write	The master spread applied to the Spread. Can also accept: NothingEnum enumerator.
Buttons<Button>	readonly	A collection of buttons.
CheckBoxes<CheckBox>	readonly	A collection of checkboxes.
ComboBoxes<ComboBox>	readonly	A collection of comboboxes.
EndnoteTextFrames<EndnoteTextFrame>	readonly	A collection of endnote text frames.
EPSTexts<EPSText>	readonly	EPSTexts
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
SpreadFlattenerLevel	read/write	The transparency flattener preferences override for the spread.
FlattenerPreference	readonly	Flattener preference settings.
FlexObjects<FlexObject>	readonly	A collection of flex objects.
FormFields<FormField>	readonly	A collection of form fields.
GraphicLines<GraphicLine>	readonly	A collection of graphic lines.
Graphics<Graphic>	readonly	A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
Groups<Group>	readonly	A collection of groups.
Guides<Guide>	readonly	A collection of guides.
Number	readonly	The unique ID of the Spread.
String	read/write	The IDML component name of the Spread.
Number	readonly	The index of the Spread within its containing object.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	read/write	A property that can be set to any string.
ListBoxes<ListBox>	readonly	A collection of listboxes.
MultiStateObjects<MultiStateObject>	readonly	A collection of multi-state objects.
String	read/write	The name of the Spread; this is an alias to the Spread's label property.
Ovals<Oval>	readonly	A collection of ellipses.
PageItems<PageItem>	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.
PageTransitionDirectionOptions +5 more	read/write	The direction of the page transition.
PageTransitionDurationOptions	read/write	The duration of the page transition.
PageTransitionTypeOptions +1 more	read/write	The type of page transition.
Pages<Page>	readonly	A collection of pages.
Document	readonly	The parent of the Spread (a Document).
Polygons<Polygon>	readonly	A collection of polygons.
Preferences<Preference>	readonly	A collection of preferences objects.
Object	read/write	A property that allows setting of several properties at the same time.
RadioButtons<RadioButton>	readonly	A collection of radio buttons.
Rectangles<Rectangle>	readonly	A collection of rectangles.
Boolean	read/write	If true, displays master page items on document pages in the spread.
SignatureFields<SignatureField>	readonly	A collection of signature fields.
SplineItems<SplineItem>	readonly	The spline items collection.
Boolean	read/write	If true, denotes that the spread is hidden. If false, denotes that the spread is not hidden. For override, pass true to hide and false to unhide
SVGs<SVG>	readonly	A collection of SVG files.
TextBoxes<TextBox>	readonly	A collection of text boxes.
TextFrames<TextFrame>	readonly	A collection of text frames.
TimingSetting	readonly	The object timing settings.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.

handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ Varies[]

Duplicate an object and place it into the target.

pageItems PageItem[] One or more page items to place or load

linkPageItems? Boolean Whether to link pageItems in content placer (if true it will override link stories value)

linkStories? Boolean Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item)

mapStyles? Boolean Whether to map styles in content placer

placePoint? Number[] | String[] unit The point at which to place

destinationLayer? Layer The layer on which to place

showingOptions? Boolean Whether to display the link options dialog

→ void

Creates multiple guides on all pages of the spread.

numberOfRows? Number 0–40 The number of rows to create on each page.

numberOfColumns? Number 0–40 The number of columns to create on each page.

rowGutter? Number | String unit The height of the gutter between rows.

columnGutter? Number | String unit The width of the gutter between columns.

guideColor? 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.

fitMargins? 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.

removeExisting? Boolean If true, removes existing guides when creating new ones.

layer? Layer The layer on which to create the guides.

→ void

Detaches an overridden master page item from the master page.

→ Varies

Duplicates the spread.

to? LocationOptions The location of the spread relative to the reference object or within the document.

reference? Document | Spread | MasterSpread The reference object. Note: Required only when the to parameter specifies before or after. Can accept: Spread, Document or MasterSpread.

→ String

Gets the label value associated with the specified key.

key String The key.

→ Spread[]

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

→ void

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

key String The key.

value String The value.

→ Spread

Moves the spread.

to? LocationOptions The location of the spread relative to the reference object or within the document.

reference? Page | Spread | Document The reference object. Note: Required when the to parameter specifies before or after. Can accept: Spread, Page or Document.

→ Varies[]

Places the file.

fileName File The file to place

placePoint? Number[] | String[] unit The point at which to place

destinationLayer? Layer The layer on which to place

showingOptions? Boolean Whether to display the import options dialog

autoflowing? Boolean Whether to autoflow placed text

withProperties? Object Initial values for properties of the placed object(s)

→ Story

Deprecated: Use contentPlace method. Original Description: Create a linked story and place it into the target.

parentStory Story The story to place and link from.

placePoint? Number[] | String[] unit The point at which to place

destinationLayer? Layer The layer on which to place

showingOptions? Boolean Whether to display the link options dialog

→ PageItem

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.

using XMLElement The XML element to place.

placePoint Number[] | String[] unit The point at which to place the object, specified in the format [x, y].

autoflowing? Boolean If true, autoflows placed text.

→ void

Deletes the Spread.

→ Boolean

Removes the event listener.

eventType String The registered event type.

handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ void

Removes the override from a previously overridden master page item.

→ Varies

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

location AnchorPoint[] | AnchorPoints[] | 2 Reals[] | BoundingBoxLimitss[] | CoordinateSpacess[] | Arrays of 2 Reals[] | LongIntegers[] 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.

in CoordinateSpaces The coordinate space to use.

consideringRulerUnits? 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.

→ void

Selects the object.

existingSelection? SelectionOptions The selection status of the Spread in relation to previously selected objects.

→ PageItem

Replaces the content of XML element with content imported from a file.

using String The file path to the import file.

relativeBasePath? String Base path used to resolve relative paths.

→ String

Generates a string which, if executed, will return the Spread.

→ String

Retrieves the object specifier.

→ void

Transform the page item.

in CoordinateSpaces The coordinate space to use

from AnchorPoint[] | AnchorPoints[] | 2 Reals[] | BoundingBoxLimitss[] | CoordinateSpacess[] | Arrays of 2 Reals[] | LongIntegers[] 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.

withMatrix 6 Reals[] | TransformationMatrix[] Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.

replacingCurrent? MatrixContent enumerators[] | MatrixContent[] | LongInteger[] 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.

consideringRulerUnits? 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.

→ TransformationMatrix[]

Get the transformation values of the page item.

in CoordinateSpaces The coordinate space to use

Parameter of 94

Method parameters that accept a Spread.

Button.duplicate(to)Button.move(to)Buttons.add(reference)CheckBox.duplicate(to)CheckBox.move(to)CheckBoxes.add(reference)ComboBox.duplicate(to)ComboBox.move(to)ComboBoxes.add(reference)Document.createAlternateLayout(spreadItems)EPS.duplicate(to)EPS.move(to)EPSText.duplicate(to)EPSText.move(to)EndnoteTextFrame.duplicate(to)EndnoteTextFrame.move(to)EndnoteTextFrames.add(reference)FlexObject.duplicate(to)FlexObject.move(to)FormField.duplicate(to)FormField.move(to)FormFields.add(reference)Graphic.duplicate(to)Graphic.move(to)GraphicLine.duplicate(to)GraphicLine.move(to)GraphicLines.add(reference)Group.duplicate(to)Group.move(to)Groups.add(reference)HtmlItem.duplicate(to)HtmlItem.move(to)HtmlItems.add(reference)Image.duplicate(to)Image.move(to)ImportedPage.duplicate(to)ImportedPage.move(to)Index_.generate(on)ListBox.duplicate(to)ListBox.move(to)ListBoxes.add(reference)MediaItem.duplicate(to)MediaItem.move(to)Movie.move(to)Movies.add(reference)MultiStateObject.duplicate(to)MultiStateObject.move(to)MultiStateObjects.add(reference)Oval.duplicate(to)Oval.move(to)Ovals.add(reference)PDF.duplicate(to)PDF.move(to)PICT.duplicate(to)PICT.move(to)Page.duplicate(reference)Page.move(reference)PageItem.duplicate(to)PageItem.move(to)Pages.add(reference)Polygon.duplicate(to)Polygon.move(to)Polygons.add(reference)RadioButton.duplicate(to)RadioButton.move(to)RadioButtons.add(reference)Rectangle.duplicate(to)Rectangle.move(to)Rectangles.add(reference)SVG.duplicate(to)SVG.move(to)SignatureField.duplicate(to)SignatureField.move(to)SignatureFields.add(reference)Sound.move(to)Sounds.add(reference)SplineItem.duplicate(to)SplineItem.move(to)Spread.duplicate(reference)Spread.move(reference)Spreads.add(reference)Spreads.itemByRange(from)Spreads.nextItem(obj)Spreads.previousItem(obj)TextBox.duplicate(to)TextBox.move(to)TextBoxes.add(reference)TextFrame.duplicate(to)TextFrame.move(to)TextFrames.add(reference)WMF.duplicate(to)WMF.move(to)XMLElement.placeIntoCopy(on)XMLElement.placeIntoFrame(on)

Return 15

Methods that return a Spread.

Spread.getElements()Spread.move()Spreads.[]()Spreads.add()Spreads.anyItem()Spreads.everyItem()Spreads.firstItem()Spreads.item()Spreads.itemByID()Spreads.itemByName()Spreads.itemByRange()Spreads.lastItem()Spreads.middleItem()Spreads.nextItem()Spreads.previousItem()

Spread

Properties

Methods

Object of 31

Parameter of 94

Return 15