Snippet
QuickLinks
Hierarchy
Properties
Property | Type | Access | Description |
---|---|---|---|
buttons | Buttons Button | readonly | A collection of buttons. |
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. |
id | number | readonly | The unique ID of the Snippet. |
images | Images Image | readonly | A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). |
index | number | readonly | The index of the Snippet within its containing object. |
isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
label | string | r/w | A property that can be set to any string. |
multiStateObjects | MultiStateObjects MultiStateObject | readonly | A collection of multi-state objects. |
name | string | r/w | The name of the Snippet; this is an alias to the Snippet's label property. |
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 | PlaceGun | readonly | The parent of the Snippet (a PlaceGun). |
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. |
rectangles | Rectangles Rectangle | readonly | A collection of rectangles. |
splineItems | SplineItems SplineItem | readonly | The spline items collection. |
textFrames | TextFrames TextFrame | readonly | A collection of text frames. |
wmfs | WMFs WMF | readonly | A collection of WMF graphics. |
Class
Property | Type | Access | Description |
---|---|---|---|
BEFORE_PLACE | string | readonly | Dispatched before a Snippet is placed. This event bubbles. This event is cancelable. (default: beforePlace) |
Methods
Instances
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) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
Parameter | Type | Description |
---|---|---|
key | string | The key. |
Array of Snippet getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
Parameter | Type | Description |
---|---|---|
key | string | The key. |
value | string | The value. |
void remove ()
Deletes the Snippet.
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) |
string toSource ()
Generates a string which, if executed, will return the Snippet.
Element of
Button.parent
EPS.parent
EPSText.parent
FormField.parent
Graphic.parent
GraphicLine.parent
Group.parent
Image.parent
MultiStateObject.parent
Oval.parent
PDF.parent
PICT.parent
PageItem.parent
Polygon.parent
Rectangle.parent
SplineItem.parent
TextFrame.parent
WMF.parent
Used in:
Snippet Snippets.nextItem (obj: Snippet)
Snippet Snippets.previousItem (obj: Snippet)
Return
Array of Snippet Snippet.getElements ()
Snippet Snippets.[] (index: number)
Snippet Snippets.anyItem ()
Array of Snippet Snippets.everyItem ()
Snippet Snippets.firstItem ()
Snippet Snippets.item (index: varies)
Snippet Snippets.itemByID (id: number)
Snippet Snippets.itemByName (name: string)
Array of Snippet Snippets.itemByRange (from: varies, to: varies)
Snippet Snippets.lastItem ()
Snippet Snippets.middleItem ()
Snippet Snippets.nextItem (obj: Snippet)
Snippet Snippets.previousItem (obj: Snippet)
Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |