Adds an event listener.
Cell | GraphicLine | Group | MasterSpread | Oval | Polygon | Rectangle | SplineItem | Spread | State
EndnoteTextFrame
Character | Footnote | Graphic | HiddenText | InsertionPoint | Line | Note | PageItem | Paragraph | Path | SVG | Table | Text | TextColumn | TextPath | TextStyleRange | TextVariableInstance | Word
14 preference objects
AnchoredObjectSetting | AnimationSetting | BaselineFrameGridOption | ContentTransparencySetting | FillTransparencySetting | GridDataInformation | LinkedPageItemOption | ObjectExportOption | Preference | StrokeTransparencySetting | TextFramePreference | TextWrapPreference | TimingSetting | TransparencySetting
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| Flip | read/write | Indicates whether the EndnoteTextFrame has been flipped independently of its parent object and, if yes, the direction in which the EndnoteTextFrame was flipped. | |
| Number | read/write | The horizontal scale of the EndnoteTextFrame relative to its containing object. | |
| Number | read/write | The rotation angle of the EndnoteTextFrame relative to its containing object. (Range: -360 to 360) | |
| Number | read/write | The skewing angle of the EndnoteTextFrame relative to its containing object. (Range: -360 to 360) | |
| Number | read/write | The vertical scale of the EndnoteTextFrame 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 EndnoteTextFrame. | |
| PageItem[] | readonly | Lists all page items contained by the EndnoteTextFrame. | |
| 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 EndnoteTextFrame. | |
| ArrowHeadAlignmentEnum | read/write | The arrowhead alignment applied to the EndnoteTextFrame. | |
| XMLItem | readonly | The XML element associated with the EndnoteTextFrame. | |
| BaselineFrameGridOption | readonly | Baseline frame grid option settings. | |
| 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. | |
| Characters |
readonly | A collection of characters. | |
| CheckBoxes |
readonly | A collection of checkboxes. | |
| ComboBoxes |
readonly | A collection of comboboxes. | |
| ContentTransparencySetting | readonly | Transparency settings for the content of the EndnoteTextFrame. | |
| ContentType | read/write | The type of content that a frame can contain. | |
| String | TextFrameContents | SpecialCharacters | read/write | The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator. | |
| EndCap | read/write | The end shape of an open path. | |
| EndJoin | read/write | The corner join applied to the EndnoteTextFrame. | |
| TextFrame | TextPath | readonly | The last text frame in the thread. Can return: TextFrame or TextPath. | |
| EndnoteTextFrames |
readonly | A collection of endnote text frames. | |
| 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 EndnoteTextFrame. . Can also accept: String. | |
| Number 0–100 | read/write | The percent of tint to use in the EndnoteTextFrame'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 EndnoteTextFrame. | |
| Flip | read/write | The direction in which to flip the printed image. | |
| Footnotes |
readonly | A collection of footnotes. | |
| FormFields |
readonly | A collection of form fields. | |
| 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 EndnoteTextFrame 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 EndnoteTextFrame. (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 EndnoteTextFrame. | |
| Number[] | String[] unit | read/write | The starting point (in page coordinates) of a gradient applied to the fill of the EndnoteTextFrame, in the format [x, y]. | |
| Number | read/write | The angle of a linear gradient applied to the stroke of the EndnoteTextFrame. (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 EndnoteTextFrame. | |
| Number[] | String[] unit | read/write | The starting point (in page coordinates) of a gradient applied to the stroke of the EndnoteTextFrame, 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). | |
| GridDataInformation | readonly | Default grid properties. Note: Applies to named, layout, and frame (story) grids. | |
| 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 EndnoteTextFrame. | |
| Number | readonly | The unique ID of the EndnoteTextFrame. | |
| Number | readonly | The index of the EndnoteTextFrame within its containing object. | |
| InsertionPoints |
readonly | A collection of insertion points. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| Layer | read/write | The layer that the EndnoteTextFrame 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. | |
| Lines |
readonly | A collection of lines. | |
| LinkedPageItemOption | readonly | Linked Page Item options | |
| ListBoxes |
readonly | A collection of listboxes. | |
| Boolean | read/write | If true, the EndnoteTextFrame is locked. | |
| 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. | |
| MultiStateObjects |
readonly | A collection of multi-state objects. | |
| String | read/write | The name of the EndnoteTextFrame. | |
| NothingEnum | TextFrame | TextPath | read/write | The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator. | |
| Boolean | read/write | If true, the EndnoteTextFrame does not print. | |
| Notes |
readonly | A collection of notes. | |
| ObjectExportOption | readonly | Export options for the object | |
| Ovals |
readonly | A collection of ellipses. | |
| Boolean | readonly | If true, the story has overset text. | |
| Boolean | read/write | If true, the EndnoteTextFrame'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 EndnoteTextFrame'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. | |
| Paragraphs |
readonly | A collection of paragraphs. | |
| GraphicLine | Group | MasterSpread | Oval | Polygon | Rectangle | SplineItem | State | Cell | Spread | readonly | The parent of the EndnoteTextFrame (a Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State or Cell). | |
| Page | readonly | The page on which this page item appears. | |
| Story | readonly | The story that contains the text. | |
| Paths |
readonly | A collection of paths. | |
| Polygons |
readonly | A collection of polygons. | |
| Preferences |
readonly | A collection of preferences objects. | |
| NothingEnum | TextFrame | TextPath | read/write | The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator. | |
| 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 EndnoteTextFrame. (Range: -360 to 360) | |
| Number | read/write | The skewing angle applied to the EndnoteTextFrame. (Range: -360 to 360) | |
| SignatureFields |
readonly | A collection of signature fields. | |
| SplineItems |
readonly | The spline items collection. | |
| TextFrame | TextPath | readonly | The first text frame in the thread. Can return: TextFrame or TextPath. | |
| StrokeAlignment | read/write | The stroke alignment applied to the EndnoteTextFrame. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the EndnoteTextFrame. Can also accept: String. | |
| StrokeCornerAdjustment | read/write | The corner adjustment applied to the EndnoteTextFrame. | |
| 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 EndnoteTextFrame's stroke. | |
| SVGs |
readonly | A collection of SVG files. | |
| Tables |
readonly | A collection of tables. | |
| TextBoxes |
readonly | A collection of text boxes. | |
| TextColumns |
readonly | A collection of text columns. | |
| Number | readonly | The index of the text frame within the story. | |
| TextFramePreference | readonly | Text frame preference settings. | |
| TextFrames |
readonly | A collection of text frames. | |
| TextPaths |
readonly | A collection of text paths. | |
| TextStyleRanges |
readonly | A collection of text style ranges. | |
| TextVariableInstances |
readonly | A collection of text variable instances. | |
| TextWrapPreference | readonly | The text wrap preference properties that define the default formatting for wrapping text around objects. | |
| Texts |
readonly | A collection of text 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 EndnoteTextFrame. | |
| Boolean | read/write | If true, the EndnoteTextFrame is visible. | |
| Number[] | String[] unit | read/write | The bounds of the EndnoteTextFrame 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. | |
| Words |
readonly | A collection of words. |
Events
| Name | Description |
|---|---|
| Dispatched after a EndnoteTextFrame is placed. This event bubbles. This event is not cancelable. | |
| Dispatched before a EndnoteTextFrame is placed. This event bubbles. This event is cancelable. |
Methods
Creates a new page item by combining the EndnoteTextFrame 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 EndnoteTextFrame forward one level in its layer.
Brings the EndnoteTextFrame to the front of its layer or in front of a particular item.
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
Finds text that matches the find what value and replaces the text with the change to value.
Finds objects that match the find what value and replace the objects with the change to value.
Finds text that matches the find what value and replaces the text with the change to value.
Finds text that matches the find character type value and replaces the text with the change character type value.
Clear overrides for object style
Clears transformations from the EndnoteTextFrame. Transformations include rotation, scaling, flipping, fitting, and shearing.
Duplicate an object and place it into the target page item.
Converts the EndnoteTextFrame to a different shape.
Convert the text frame contents to raw text
Create Email QR Code on the page item or document
Create Hyperlink QR Code on the page item or document
Converts text to outlines. Each line of text becomes a polygon object. When the converted text is a single letter that has no internal spaces or detached parts, the polygon contains only a single path. Note: To determine whether a font allows the creation of outlines, see allow outlines.
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 EndnoteTextFrame at the specified location or offset.
Creates a new page item by excluding the overlapping areas of the EndnoteTextFrame and other objects.
Exports the object(s) to a file.
Gets the label value associated with the specified key.
Finds glyphs that match the find what value.
Finds text that matches the find what value.
Finds objects that match the find what value.
Finds text that matches the find what value.
Finds text that matches the find character type value.
Applies the specified fit option to content in a frame.
Flips the EndnoteTextFrame.
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 EndnoteTextFrame with other objects. Returns an error if the objects do not intersect.
Creates a compound path by combining the path(s) of the EndnoteTextFrame 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 EndnoteTextFrame and other objects.
Moves the EndnoteTextFrame to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.
imports cached equations after placing prepared DOCX
Overrides a master page item and places the item on the document page as a new object.
Places a file
Deprecated: Use contentPlace method. Original Description: Create a linked story and place it into the target page item.
Places XML content into the specified object. Note: Replaces any existing content.
Recomposes the text in the EndnoteTextFrame.
Apply an item's scaling to its content if possible.
Move the bounding box of the page item
Releases a compound path.
Deletes the EndnoteTextFrame.
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.
Sends the EndnoteTextFrame back one level in its layer.
Sends the EndnoteTextFrame 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 EndnoteTextFrame and other objects.
Generates a string which, if executed, will return the EndnoteTextFrame.
Retrieves the object specifier.
Transform the page item.
Get the transformation values of the page item.
Object of 35
Properties elsewhere that hold a EndnoteTextFrame.
Parameter of 5
Method parameters that accept a EndnoteTextFrame.
Return 14
Methods that return a EndnoteTextFrame.