InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

PlaceGun

Represents the place gun.

Preference ›PlaceGun
Hierarchy

Document

PlaceGun

Button | CheckBox | ComboBox | EPS | EPSText | FormField | Graphic | GraphicLine | Group | Image | ImportedPage | ListBox | MultiStateObject | Oval | PDF | PICT | PageItem | Polygon | RadioButton | Rectangle | SVG | SignatureField | Snippet | SplineItem | TextBox | TextFrame | WMF

Properties

NameType AccessDescription
Buttons<Button> readonly A collection of buttons.
CheckBoxes<CheckBox> readonly A collection of checkboxes.
ComboBoxes<ComboBox> readonly A collection of comboboxes.
EPSs<EPS> readonly A collection of EPS files.
EPSTexts<EPSText> readonly EPSTexts
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
FormFields<FormField> readonly A collection of form fields.
GraphicLines<GraphicLine> readonly A collection of graphic lines.
Graphics<Graphic> readonly A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
Groups<Group> readonly A collection of groups.
Images<Image> readonly A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
ImportedPages<ImportedPage> readonly Imported InDesign pages.
Boolean readonly Returns true if the object specifier resolves to valid objects.
ListBoxes<ListBox> readonly A collection of listboxes.
Boolean readonly Whether the place gun is currently loaded with content for placing.
MultiStateObjects<MultiStateObject> readonly A collection of multi-state objects.
Ovals<Oval> readonly A collection of ellipses.
PageItems<PageItem> readonly 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.
Document readonly The parent of the PlaceGun (a Document).
PDFs<PDF> readonly A collection of PDF files.
PICTs<PICT> readonly A collection of PICT graphics.
Polygons<Polygon> readonly A collection of polygons.
Object read/write A property that allows setting of several properties at the same time.
RadioButtons<RadioButton> readonly A collection of radio buttons.
Rectangles<Rectangle> readonly A collection of rectangles.
SignatureFields<SignatureField> readonly A collection of signature fields.
Snippets<Snippet> readonly A collection of IDML snippets.
SplineItems<SplineItem> readonly The spline items collection.
SVGs<SVG> readonly A collection of SVG files.
TextBoxes<TextBox> readonly A collection of text boxes.
TextFrames<TextFrame> readonly A collection of text frames.
WMFs<WMF> readonly A collection of WMF graphics.

Methods

→ void

Delete the contents of the place gun.

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ PlaceGun[]

Resolves the object specifier, creating an array of object references.

→ void

Load the place gun with one or more files.

fileName File[] | Files[] One or more files to place. Can accept: File or Array of Files.
showingOptions? Boolean Whether to display the import options dialog
withProperties? Object Initial values for properties of the placed object(s)
→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

Rotate the contents of the place gun.

direction? RotationDirection Which direction to rotate the contents
→ String

Generates a string which, if executed, will return the PlaceGun.

→ String

Retrieves the object specifier.

Object of 31

Properties elsewhere that hold a PlaceGun.

Button.parentCheckBox.parentComboBox.parentDocument.placeGunsEPS.parentEPSText.parentEvent.parentEventListener.parentFormField.parentGraphic.parentGraphicLine.parentGroup.parentImage.parentImportedPage.parentListBox.parentMultiStateObject.parentMutationEvent.parentOval.parentPDF.parentPICT.parentPageItem.parentPolygon.parentRadioButton.parentRectangle.parentSVG.parentSignatureField.parentSnippet.parentSplineItem.parentTextBox.parentTextFrame.parentWMF.parent

Return 1

Methods that return a PlaceGun.

PlaceGun.getElements()