Adds an event listener.
Polygon
A polygon. Any shape that is not a rectangle, ellipse, or graphic line. When you add a polygon, InDesign creates a regular polygon based on the current polygon preferences settings.
Cell | Character | ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | Snippet | SplineItem | Spread | State | TextBox
Polygon
Button | CheckBox | ComboBox | EPS | EPSText | EndnoteTextFrame | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | PageItem | Path | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | TextPath | WMF
13 preference objects
AnchoredObjectSetting | AnimationSetting | ContentTransparencySetting | FillTransparencySetting | FrameFittingOption | InCopyExportOption | LinkedPageItemOption | ObjectExportOption | Preference | StrokeTransparencySetting | TextWrapPreference | TimingSetting | TransparencySetting
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| Flip | read/write | Indicates whether the Polygon has been flipped independently of its parent object and, if yes, the direction in which the Polygon was flipped. | |
| Number | read/write | The horizontal scale of the Polygon relative to its containing object. | |
| Number | read/write | The rotation angle of the Polygon relative to its containing object. (Range: -360 to 360) | |
| Number | read/write | The skewing angle of the Polygon relative to its containing object. (Range: -360 to 360) | |
| Number | read/write | The vertical scale of the Polygon relative to its containing object. | |
| Article[] | readonly | The list of all articles this page item is part of | |
| Graphic[] | readonly | Lists all graphics contained by the Polygon. | |
| PageItem[] | readonly | Lists all page items contained by the Polygon. | |
| Boolean | read/write | If true, the master page item can be overridden. | |
| AnchoredObjectSetting | readonly | Anchored object settings. | |
| AnimationSetting | readonly | The page item animation settings. | |
| ObjectStyle | read/write | The object style applied to the Polygon. | |
| ArrowHeadAlignmentEnum | read/write | The arrowhead alignment applied to the Polygon. | |
| XMLItem | readonly | The XML element associated with the Polygon. | |
| CornerOptions | read/write | The shape to apply to the bottom left corner of rectangular shapes. | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes | |
| CornerOptions | read/write | The shape to apply to the bottom right corner of rectangular shapes. | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes | |
| Buttons |
readonly | A collection of buttons. | |
| CheckBoxes |
readonly | A collection of checkboxes. | |
| ComboBoxes |
readonly | A collection of comboboxes. | |
| ContentTransparencySetting | readonly | Transparency settings for the content of the Polygon. | |
| ContentType | read/write | The type of content that a frame can contain. | |
| EndCap | read/write | The end shape of an open path. | |
| EndJoin | read/write | The corner join applied to the Polygon. | |
| EndnoteTextFrames |
readonly | A collection of endnote text frames. | |
| EPSs |
readonly | A collection of EPS files. | |
| EPSTexts |
readonly | EPSTexts | |
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Polygon. . Can also accept: String. | |
| Number 0–100 | read/write | The percent of tint to use in the Polygon's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) | |
| FillTransparencySetting | readonly | Transparency settings for the fill applied to the Polygon. | |
| Flip | read/write | The direction in which to flip the printed image. | |
| FormFields |
readonly | A collection of form fields. | |
| FrameFittingOption | readonly | The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application. | |
| Swatch | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. | |
| Number 0–100 | read/write | The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) | |
| Number[] | String[] unit | read/write | The bounds of the Polygon excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. | |
| Number | read/write | The angle of a linear gradient applied to the fill of the Polygon. (Range: -180 to 180) | |
| Number | String unit | read/write | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Polygon. | |
| Number[] | String[] unit | read/write | The starting point (in page coordinates) of a gradient applied to the fill of the Polygon, in the format [x, y]. | |
| Number | read/write | The angle of a linear gradient applied to the stroke of the Polygon. (Range: -180 to 180) | |
| Number | String unit | read/write | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Polygon. | |
| Number[] | String[] unit | read/write | The starting point (in page coordinates) of a gradient applied to the stroke of the Polygon, in the format [x, y]. | |
| GraphicLines |
readonly | A collection of graphic lines. | |
| Graphics |
readonly | A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). | |
| Groups |
readonly | A collection of groups. | |
| DimensionsConstraints[] | read/write | The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule. | |
| Number | read/write | The horizontal scaling applied to the Polygon. | |
| HtmlItems |
readonly | A collection of embedded HTML page items. | |
| Number | readonly | The unique ID of the Polygon. | |
| Images |
readonly | A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). | |
| ImportedPages |
readonly | Imported InDesign pages. | |
| InCopyExportOption | readonly | Export options for InCopy INCX document format. | |
| Number | readonly | The index of the Polygon within its containing object. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| Layer | read/write | The layer that the Polygon is on. | |
| String | read/write | A property that can be set to any string. | |
| Number 1–1000 | read/write | The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000) | |
| ArrowHead | read/write | The arrowhead applied to the start of the path. | |
| LinkedPageItemOption | readonly | Linked Page Item options | |
| ListBoxes |
readonly | A collection of listboxes. | |
| LockStateValues | readonly | The lock state. | |
| Boolean | read/write | If true, the Polygon is locked. | |
| MediaItems |
readonly | The media items collection. | |
| Number = 4 1–500 | read/write | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. | |
| Movies |
readonly | A collection of movies. | |
| MultiStateObjects |
readonly | A collection of multi-state objects. | |
| String | read/write | The name of the Polygon. | |
| Boolean | read/write | If true, the Polygon does not print. | |
| ObjectExportOption | readonly | Export options for the object | |
| Ovals |
readonly | A collection of ellipses. | |
| Boolean | read/write | If true, the Polygon's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. | |
| Boolean | read/write | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. | |
| Boolean | read/write | If true, the Polygon's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. | |
| Boolean | readonly | If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page. | |
| Graphic | Guide | Movie | PageItem | Sound | readonly | An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound. | |
| 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. | |
| Cell | Character | ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | Polygon | Rectangle | SignatureField | SplineItem | Spread | State | TextBox | PlaceGun | Snippet | readonly | The parent of the Polygon (a Snippet, ComboBox, ListBox, TextBox, SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Cell, Character or PlaceGun). | |
| Page | readonly | The page on which this page item appears. | |
| Paths |
readonly | A collection of paths. | |
| PDFs |
readonly | A collection of PDF files. | |
| PICTs |
readonly | A collection of PICT graphics. | |
| Polygons |
readonly | A collection of polygons. | |
| Preferences |
readonly | A collection of preferences objects. | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| RadioButtons |
readonly | A collection of radio buttons. | |
| Rectangles |
readonly | A collection of rectangles. | |
| Number 1–1000 | read/write | The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000) | |
| ArrowHead | read/write | The arrowhead applied to the end of the path. | |
| Number | read/write | The rotatation angle of the Polygon. (Range: -360 to 360) | |
| Number | read/write | The skewing angle applied to the Polygon. (Range: -360 to 360) | |
| SignatureFields |
readonly | A collection of signature fields. | |
| Sounds |
readonly | A collection of sound clips. | |
| SplineItems |
readonly | The spline items collection. | |
| String | read/write | Title for this InCopy story. | |
| StrokeAlignment | read/write | The stroke alignment applied to the Polygon. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Polygon. Can also accept: String. | |
| StrokeCornerAdjustment | read/write | The corner adjustment applied to the Polygon. | |
| Number[] | String[] unit | read/write | The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3]. | |
| Number 0–100 | read/write | The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) | |
| StrokeTransparencySetting | readonly | Transparency settings for the stroke. | |
| StrokeStyle | String | read/write | The name of the stroke style to apply. Can also accept: String. | |
| Number | String unit | read/write | The weight (in points) to apply to the Polygon's stroke. | |
| SVGs |
readonly | A collection of SVG files. | |
| TextBoxes |
readonly | A collection of text boxes. | |
| TextFrames |
readonly | A collection of text frames. | |
| TextPaths |
readonly | A collection of text paths. | |
| TextWrapPreference | readonly | The text wrap preference properties that define the default formatting for wrapping text around objects. | |
| TimingSetting | readonly | The object timing settings. | |
| CornerOptions | read/write | The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes | |
| CornerOptions | read/write | The shape to apply to the top right corner of rectangular shapes | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes | |
| TransparencySetting | readonly | Transparency settings. | |
| DimensionsConstraints[] | read/write | The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule. | |
| Number | read/write | The vertical scaling applied to the Polygon. | |
| Boolean | read/write | If true, the Polygon is visible. | |
| Number[] | String[] unit | read/write | The bounds of the Polygon including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. | |
| WMFs |
readonly | A collection of WMF graphics. |
Events
| Name | Description |
|---|---|
| Dispatched after a Polygon is placed. This event bubbles. This event is not cancelable. | |
| Dispatched before a Polygon is placed. This event bubbles. This event is cancelable. |
Methods
Creates a new page item by combining the Polygon with other objects. Deletes the objects if they do not intersect.
Applies the specified object style.
Tag the object or the parent story using default tags defined in XML preference.
Brings the Polygon forward one level in its layer.
Brings the Polygon to the front of its layer or in front of a particular item.
Finds objects that match the find what value and replace the objects with the change to value.
Checks in the story or stories.
Checks out the story.
Removes the frame fittings options and resets it to the initial state.
Clear overrides for object style
Clears transformations from the Polygon. Transformations include rotation, scaling, flipping, fitting, and shearing.
Duplicate an object and place it into the target page item.
Converts the Polygon to a different shape.
Create Email QR Code on the page item or document
Create Hyperlink QR Code on the page item or document
Create Plain Text QR Code on the page item
Create Text Msg QR Code on the page item or document
Create Business Card QR Code on the page item or load on document's placegun
Detaches an overridden master page item from the master page.
Duplicates the Polygon at the specified location or offset.
Creates a new page item by excluding the overlapping areas of the Polygon and other objects.
Exports the object(s) to a file.
Gets the label value associated with the specified key.
Finds objects that match the find what value.
Applies the specified fit option to content in a frame.
Flips the Polygon.
Resolves the object specifier, creating an array of object references.
Sets the label to the value associated with the specified key.
Creates a new page item by intersecting the Polygon with other objects. Returns an error if the objects do not intersect.
Creates a compound path by combining the path(s) of the Polygon with the paths of other objects.
Associates the page item with the specified XML element while preserving existing content.
Creates a new page item by reverse subtracting the overlapping areas of the Polygon and other objects.
Moves the Polygon to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.
Overrides a master page item and places the item on the document page as a new object.
Places a file
Places XML content into the specified object. Note: Replaces any existing content.
Apply an item's scaling to its content if possible.
Move the bounding box of the page item
Releases a compound path.
Deletes the Polygon.
Removes the event listener.
Removes the override from a previously overridden master page item.
Resize the page item.
Get the coordinates of the given location in the specified coordinate system.
Reverts the document to its state at the last save operation.
Sends the Polygon back one level in its layer.
Sends the Polygon to the back of its layer or behind a particular item (must have same parent).
Stores the object in the specified library.
Creates a new page item by subtracting the overlapping areas of the Polygon and other objects.
Generates a string which, if executed, will return the Polygon.
Retrieves the object specifier.
Transform the page item.
Get the transformation values of the page item.
Object of 50
Properties elsewhere that hold a Polygon.
Parameter of 3
Method parameters that accept a Polygon.
Return 14
Methods that return a Polygon.