K4 InDesign Javascript API Documentation

BasicsContentPlacerObject

Represents the content placer object.

Extends

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
loaded bool Whether the Content Placer is currently loaded with content for placing. read-only
parent Application The parent of the ContentPlacerObject (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → ContentPlacerObject
load(
pageItems ​[, linkPageItems] ​[, linkStories] ​[, mapStyles] ​[, showingOptions])
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → ContentPlacerObject
Resolves the object specifier, creating an array of object references.
load(
pageItems ​[, linkPageItems=false] ​[, linkStories=false] ​[, mapStyles=false] ​[, showingOptions=false])
Load the Content Placer with one or more objects.
pageItems Array<PageItem> One or more page items to place or load
linkPageItems bool Whether to link pageItems in content placer (if true it will override link stories value) (Optional)
linkStories bool 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) (Optional)
mapStyles bool Whether to map styles in content placer (Optional)
showingOptions bool Whether to display the link options dialog (Optional)
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the ContentPlacerObject.
toSpecifier(
)
  → string
Retrieves the object specifier.