PlaceGun
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| buttons | Buttons | readonly | A collection of buttons. |
| epss | EPSs | readonly | A collection of EPS files. |
| epstexts | EPSTexts | readonly | EPSTexts |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| formFields | FormFields | readonly | A collection of form fields. |
| graphicLines | GraphicLines | readonly | A collection of graphic lines. |
| graphics | Graphics | readonly | A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). |
| groups | Groups | readonly | A collection of groups. |
| images | Images | readonly | A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). |
| importedPages | ImportedPages | readonly | Imported InDesign pages. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| loaded | bool | readonly | Whether the place gun is currently loaded with content for placing. |
| multiStateObjects | MultiStateObjects | readonly | A collection of multi-state objects. |
| ovals | Ovals | readonly | A collection of ellipses. |
| pageItems | PageItems | 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 | readonly | A collection of PDF files. |
| picts | PICTs | readonly | A collection of PICT graphics. |
| polygons | Polygons | readonly | A collection of polygons. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rectangles | Rectangles | readonly | A collection of rectangles. |
| snippets | Snippets | readonly | A collection of IDML snippets. |
| splineItems | SplineItems | readonly | The spline items collection. |
| textFrames | TextFrames | readonly | A collection of text frames. |
| wmfs | WMFs | 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.
string toSpecifier ()
Retrieves the object specifier.
Element of
Document.placeGuns
GraphicLine.parent
Oval.parent
Polygon.parent
Rectangle.parent
Snippet.parent
SplineItem.parent
TextFrame.parent
Return
Array of PlaceGun PlaceGun.getElements ()
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |