K4 InDesign Javascript API Documentation

BasicsPlaceGun

Represents the place gun.

Extends

Instance Properties

Name Description Access
buttons Buttons A collection of buttons. read-only
checkBoxes CheckBoxes A collection of checkboxes. read-only
comboBoxes ComboBoxes A collection of comboboxes. read-only
epss EPSs A collection of EPS files. read-only
epstexts EPSTexts EPSTexts read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
formFields FormFields A collection of form fields. read-only
graphicLines GraphicLines A collection of graphic lines. read-only
graphics Graphics A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). read-only
groups Groups A collection of groups. read-only
images Images A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). read-only
importedPages ImportedPages Imported InDesign pages. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
listBoxes ListBoxes A collection of listboxes. read-only
loaded bool Whether the place gun is currently loaded with content for placing. read-only
multiStateObjects MultiStateObjects A collection of multi-state objects. read-only
ovals Ovals A collection of ellipses. read-only
pageItems PageItems 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. read-only
parent Document The parent of the PlaceGun (a Document). read-only
pdfs PDFs A collection of PDF files. read-only
picts PICTs A collection of PICT graphics. read-only
polygons Polygons A collection of polygons. read-only
properties Object A property that allows setting of several properties at the same time. read-write
radioButtons RadioButtons A collection of radio buttons. read-only
rectangles Rectangles A collection of rectangles. read-only
signatureFields SignatureFields A collection of signature fields. read-only
snippets Snippets A collection of IDML snippets. read-only
splineItems SplineItems The spline items collection. read-only
textBoxes TextBoxes A collection of text boxes. read-only
textFrames TextFrames A collection of text frames. read-only
wmfs WMFs A collection of WMF graphics. read-only

Methods

abortPlaceGun(
)
addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → PlaceGun
loadPlaceGun(
fileName ​[, showingOptions] ​[, withProperties])
removeEventListener(
eventType, handler ​[, captures])
  → bool
rotate(
[direction])
toSource(
)
  → string
toSpecifier(
)
  → string
abortPlaceGun(
)
Delete the contents of the place gun.
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(
)
  → PlaceGun
Resolves the object specifier, creating an array of object references.
loadPlaceGun(
fileName ​[, showingOptions=false] ​[, withProperties])
Load the place gun with one or more files.
fileName One or more files to place. Can accept: File or Array of Files.
showingOptions bool Whether to display the import options dialog (Optional)
withProperties Object Initial values for properties of the placed object(s) (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)
rotate(
[direction=RotationDirection.FORWARD])
Rotate the contents of the place gun.
direction RotationDirection Which direction to rotate the contents (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the PlaceGun.
toSpecifier(
)
  → string
Retrieves the object specifier.