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

Snippet

An IDML snippet.

Hierarchy

PlaceGun

Snippet

Button | CheckBox | ComboBox | EPS | EPSText | FormField | Graphic | GraphicLine | Group | Image | ListBox | MultiStateObject | Oval | PDF | PICT | PageItem | Polygon | RadioButton | Rectangle | SVG | SignatureField | 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.
Number readonly The unique ID of the Snippet.
Images<Image> readonly A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
Number readonly The index of the Snippet within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
ListBoxes<ListBox> readonly A collection of listboxes.
MultiStateObjects<MultiStateObject> readonly A collection of multi-state objects.
String read/write The name of the Snippet; this is an alias to the Snippet's label property.
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.
PlaceGun readonly The parent of the Snippet (a PlaceGun).
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.
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.

Events

NameDescription
Dispatched before a Snippet is placed. This event bubbles. This event is cancelable.

Methods

→ 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.
→ String

Gets the label value associated with the specified key.

key String The key.
→ Snippet[]

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

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ void

Deletes the Snippet.

→ 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.
→ String

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

→ String

Retrieves the object specifier.

Object of 28

Properties elsewhere that hold a Snippet.

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

Parameter of 3

Method parameters that accept a Snippet.

Snippets.itemByRange(from)Snippets.nextItem(obj)Snippets.previousItem(obj)

Return 13

Methods that return a Snippet.

Snippet.getElements()Snippets.[]()Snippets.anyItem()Snippets.everyItem()Snippets.firstItem()Snippets.item()Snippets.itemByID()Snippets.itemByName()Snippets.itemByRange()Snippets.lastItem()Snippets.middleItem()Snippets.nextItem()Snippets.previousItem()