Adobe InDesign CS6 (8.0) Object Model JS: ContentPlacerObject

InDesign CS6

Class

ContentPlacerObject

 Represents the content placer object. Base Class: Preference

QuickLinks

addEventListener, getElements, load, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
ContentPlacerObject
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
loadedbool readonlyWhether the Content Placer is currently loaded with content for placing.
parentApplication readonlyThe parent of the ContentPlacerObject (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.

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)

Array of ContentPlacerObject getElements ()
Resolves the object specifier, creating an array of object references.

void load (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])
Load the Content Placer with one or more objects.

ParameterTypeDescription
pageItemsArray of PageItemOne or more page items to place or load
linkPageItemsboolWhether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false)
linkStoriesboolWhether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) (default: false)
mapStylesboolWhether to map styles in content placer (Optional) (default: false)
showingOptionsboolWhether to display the link options dialog (Optional) (default: false)

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 ContentPlacerObject.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.contentPlacer

Return

Array of ContentPlacerObject ContentPlacerObject.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index