Adobe InDesign CS2 (4.0) Object Model JS: Spread

InDesign CS2

Class

Spread

 A spread.

QuickLinks

createGuides, detach, duplicate, extractLabel, getElements, insertLabel, move, place, remove, removeOverride, toSource, toSpecifier

Hierarchy

Document
Spread
Button | FlattenerPreference | FormField | GraphicLine | Group | Guide | Oval | Page | PageItem | Polygon | Rectangle | TextFrame

Properties

PropertyTypeAccessDescription
allGraphics Array of Graphic readonlyLists all graphics contained by the Spread.
allPageItems Array of PageItem readonlyLists all page items contained by the Spread.
appliedMasterMasterSpreadNothingEnum r/wThe master spread applied to the Spread. Can also accept: NothingEnum enumerator.
buttonsButtons readonlyA collection of buttons.
flattenerOverrideSpreadFlattenerLevel:
SpreadFlattenerLevel.DEFAULT_VALUE
SpreadFlattenerLevel.NONE
SpreadFlattenerLevel.CUSTOM
r/wThe transparency flattener preferences override for the spread.
flattenerPreferencesFlattenerPreference readonlyFlattener preference settings.
formFieldsFormFields readonlyA collection of form fields.
graphicLinesGraphicLines readonlyA collection of graphic lines.
groupsGroups readonlyA collection of groups.
guidesGuides readonlyA collection of guides.
idnumber readonlyThe unique ID of the Spread.
indexnumber readonlyThe index of the Spread within its containing object.
keepTogetherbool r/wIf 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.
labelstring r/wA property that can be set to any string.
ovalsOvals readonlyA collection of ellipses.
pageItemsPageItems readonlyThe 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.
pagesPages readonlyA collection of pages.
parentDocument readonlyThe parent of the Spread (a Document).
polygonsPolygons readonlyA collection of polygons.
propertiesObject r/wA property that allows setting of several properties at the same time.
rectanglesRectangles readonlyA collection of rectangles.
showMasterItemsbool r/wIf true, displays master page items on document pages in the spread.
textFramesTextFrames readonlyA 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.

ParameterTypeDescription
numberOfRowsnumber (range: 0 - 40)The number of rows to create on each page. (Optional) (default: 0)
numberOfColumnsnumber (range: 0 - 40)The number of columns to create on each page. (Optional) (default: 0)
rowGutterMeasurement Unit (Number or String) (range: 0 - 1440)The height of the gutter between rows. (Optional) (default: 0)
columnGutterMeasurement 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)
fitMarginsboolIf 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)
removeExistingboolIf true, removes existing guides when creating new ones. (Optional) (default: false)
layerLayerThe 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.

ParameterTypeDescription
toLocationOptions:
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)
referenceDocument
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.

ParameterTypeDescription
keystringThe key.

Array of Object 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Spread move ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
Moves the spread.

ParameterTypeDescription
toLocationOptions:
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)
referenceDocument
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: Layer][, showingOptions: bool=false][, autoflowing: bool=false][, withProperties: Object])
Place a file

ParameterTypeDescription
fileNameFileThe file to place
placePoint Array of Measurement Unit (Number or String)The point at which to place (Optional)
destinationLayerLayerThe layer on which to place (Optional)
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
autoflowingboolWhether to autoflow placed text (Optional) (default: false)
withPropertiesObjectInitial 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.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

FlattenerPreference.parent

Guide.parent

LayoutWindow.activeSpread

Used in:

void Button.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

void FormField.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

void Graphic.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

void GraphicLine.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

void PICT.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

Page Pages.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

void Polygon.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

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)

void TextFrame.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

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)][, transformingContent: bool=true])

Return

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.3dContents :: Index