Adobe InCopy CS5 (7.0) Object Model JS: MasterSpread

InCopy CS5

Class

MasterSpread

 A master spread.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, removeEventListener, toSource, toSpecifier

Hierarchy

Document
MasterSpread
Button | EPSText | Event | EventListener | FormField | GraphicLine | Group | Guide | MultiStateObject | MutationEvent | Oval | Page | PageItem | Polygon | Rectangle | SplineItem | TextFrame

Properties

PropertyTypeAccessDescription
allGraphics Array of Graphic readonlyLists all graphics contained by the MasterSpread.
allPageItems Array of PageItem readonlyLists all page items contained by the MasterSpread.
appliedMasterMasterSpreadNothingEnum readonlyThe master spread applied to the MasterSpread. Can also accept: NothingEnum enumerator.
baseNamestring readonlyThe name of the master spread.
buttonsButtons readonlyA collection of buttons.
epstextsEPSTexts readonlyEPSTexts
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
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 MasterSpread.
idmlComponentNamestring r/wThe IDML component name of the MasterSpread.
indexnumber readonlyThe index of the MasterSpread within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
multiStateObjectsMultiStateObjects readonlyA collection of multi-state objects.
namestring readonlyThe name of the MasterSpread.
namePrefixstring readonlyThe prefix of the master spread name.
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 MasterSpread (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.
splineItemsSplineItems readonlyThe spline items collection.
textFramesTextFrames readonlyA collection of text frames.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Guide.parent

MasterSpread.appliedMaster

Page.appliedMaster

Page.parent

Spread.appliedMaster

Window.activeSpread

Used in:

MasterSpread MasterSpreads.nextItem (obj: MasterSpread)

MasterSpread MasterSpreads.previousItem (obj: MasterSpread)

Return

Array of MasterSpread MasterSpread.getElements ()

MasterSpread MasterSpreads.[] (index: number)

MasterSpread MasterSpreads.anyItem ()

Array of MasterSpread MasterSpreads.everyItem ()

MasterSpread MasterSpreads.firstItem ()

MasterSpread MasterSpreads.item (index: varies)

MasterSpread MasterSpreads.itemByID (id: number)

MasterSpread MasterSpreads.itemByName (name: string)

Array of MasterSpread MasterSpreads.itemByRange (from: varies, to: varies)

MasterSpread MasterSpreads.lastItem ()

MasterSpread MasterSpreads.middleItem ()

MasterSpread MasterSpreads.nextItem (obj: MasterSpread)

MasterSpread MasterSpreads.previousItem (obj: MasterSpread)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index