Class
Represents the place gun. Base Class: Preference abortPlaceGun, addEventListener, getElements, loadPlaceGun, removeEventListener, rotate, toSource, toSpecifier
PlaceGun
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| buttons | Buttons Button | readonly | A collection of buttons. |
| checkBoxes | CheckBoxes | readonly | A collection of checkboxes. |
| comboBoxes | ComboBoxes | readonly | A collection of comboboxes. |
| epss | EPSs EPS | readonly | A collection of EPS files. |
| epstexts | EPSTexts EPSText | readonly | EPSTexts |
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| formFields | FormFields FormField | readonly | A collection of form fields. |
| graphicLines | GraphicLines GraphicLine | readonly | A collection of graphic lines. |
| graphics | Graphics Graphic | readonly | A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). |
| groups | Groups Group | readonly | A collection of groups. |
| images | Images Image | readonly | A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). |
| importedPages | ImportedPages ImportedPage | readonly | Imported InDesign pages. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| listBoxes | ListBoxes | readonly | A collection of listboxes. |
| loaded | bool | readonly | Whether the place gun is currently loaded with content for placing. |
| multiStateObjects | MultiStateObjects MultiStateObject | readonly | A collection of multi-state objects. |
| ovals | Ovals Oval | readonly | A collection of ellipses. |
| pageItems | 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. |
| parent | Document | readonly | The parent of the PlaceGun (a Document). |
| pdfs | PDFs PDF | readonly | A collection of PDF files. |
| picts | PICTs PICT | readonly | A collection of PICT graphics. |
| polygons | Polygons Polygon | readonly | A collection of polygons. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| radioButtons | RadioButtons RadioButton | readonly | A collection of radio buttons. |
| rectangles | Rectangles Rectangle | readonly | A collection of rectangles. |
| signatureFields | SignatureFields SignatureField | readonly | A collection of signature fields. |
| splineItems | SplineItems SplineItem | readonly | The spline items collection. |
| textBoxes | TextBoxes | readonly | A collection of text boxes. |
| textFrames | TextFrames TextFrame | readonly | A collection of text frames. |
| wmfs | WMFs WMF | readonly | A collection of WMF graphics. |
Methods
Instances
void abortPlaceGun ()
Delete the contents of the place gun.
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of PlaceGun getElements ()
Resolves the object specifier, creating an array of object references.
void loadPlaceGun (fileName:
varies[, showingOptions:
bool=false][, withProperties:
Object])
Load the place gun with one or more files.
| Parameter | Type | Description |
|---|---|---|
| fileName |
Array
of Files File | One or more files to place. Can accept: File or Array of Files. |
| showingOptions | bool | Whether to display the import options dialog (Optional) (default: false) |
| withProperties | Object | Initial values for properties of the placed object(s) (Optional) |
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void rotate ([direction:
RotationDirection=RotationDirection.FORWARD])
Rotate the contents of the place gun.
| Parameter | Type | Description |
|---|---|---|
| direction | RotationDirection: RotationDirection.FORWARD RotationDirection.BACKWARD | Which direction to rotate the contents (Optional) (default: RotationDirection.FORWARD) |
string toSource ()
Generates a string which, if executed, will return the PlaceGun.
Element of
Document.placeGuns
GraphicLine.parent
Oval.parent
PageItem.parent
Polygon.parent
Rectangle.parent
SplineItem.parent
TextFrame.parent
Return
Array of PlaceGun PlaceGun.getElements ()
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |