TextFrame
A text frame.
Go to Property Listing | Method Listing
Methods:
addEventListener, addPath, applyObjectStyle, asynchronousExportFile, autoTag, bringForward, bringToFront, changeGlyph, changeGrep, changeObject, changeText, changeTransliterate, clearObjectStyleOverrides, clearTransformations, contentPlace, convertShape, convertToRawText, createEmailQRCode, createHyperlinkQRCode, createOutlines, createPlainTextQRCode, createTextMsgQRCode, createVCardQRCode, detach, duplicate, excludeOverlapPath, exportFile, extractLabel, findGlyph, findGrep, findObject, findText, findTransliterate, fit, flipItem, getElements, insertLabel, intersectPath, makeCompoundPath, markup, minusBack, move, override, place, placeAndLink, placeXML, recompose, redefineScaling, reframe, releaseCompoundPath, remove, removeEventListener, removeOverride, resize, resolve, select, sendBackward, sendToBack, store, subtractPath, toSource, toSpecifier, transform, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually, transformValuesOf
Objects:
AnchoredObjectSetting, AnimationSetting, ArrowHead, ArrowHeadAlignmentEnum, Article, BaselineFrameGridOption, Boolean, Buttons, Characters, CheckBoxes, ComboBoxes, ContentTransparencySetting, ContentType, CornerOptions, DimensionsConstraints, DisplaySettingOptions, EPSTexts, EndCap, EndJoin, EndnoteTextFrames, EventListeners, Events, FillTransparencySetting, Flip, Footnotes, FormFields, Graphic, GraphicLines, Graphics, GridDataInformation, Groups, Guide, HiddenTexts, InsertionPoints, Layer, Lines, LinkedPageItemOption, ListBoxes, Movie, MultiStateObjects, Notes, Number, Object, ObjectExportOption, ObjectStyle, Ovals, Page, PageItem, PageItems, Paragraphs, Paths, Polygons, Preferences, RadioButtons, Rectangles, SVGs, SignatureFields, Sound, SpecialCharacters, SplineItems, Story, String, StrokeAlignment, StrokeCornerAdjustment, StrokeStyle, StrokeTransparencySetting, Swatch, Tables, TextBoxes, TextColumns, TextFrame, TextFrameContents, TextFramePreference, TextFrames, TextPath, TextPaths, TextStyleRanges, TextVariableInstances, TextWrapPreference, Texts, TimingSetting, TransparencySetting, Words, XMLItem
Preferences:
BaselineFrameGridOption, LinkedPageItemOption, ObjectExportOption, Preferences, TextFramePreference, TextWrapPreference
Hierarchy:
Superclass: PageItem
Class: TextFrame
Subclasses: EndnoteTextFrame
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
read/write |
Indicates whether the TextFrame has been flipped independently of its parent object and, if yes, the direction in which the TextFrame was flipped. |
||
|
read/write |
The horizontal scale of the TextFrame relative to its containing object. |
||
|
read/write |
The rotation angle of the TextFrame relative to its containing object. (Range: -360 to 360) |
||
|
read/write |
The skewing angle of the TextFrame relative to its containing object. (Range: -360 to 360) |
||
|
read/write |
The vertical scale of the TextFrame relative to its containing object. |
||
|
readonly |
The list of all articles this page item is part of |
||
|
readonly |
Lists all graphics contained by the TextFrame. |
||
|
readonly |
Lists all page items contained by the TextFrame. |
||
|
read/write |
If true, the master page item can be overridden. |
||
|
readonly |
Anchored object settings. |
||
|
readonly |
The page item animation settings. |
||
|
read/write |
The object style applied to the TextFrame. |
||
|
read/write |
The arrowhead alignment applied to the TextFrame. |
||
|
readonly |
The XML element associated with the TextFrame. |
||
|
readonly |
Baseline frame grid option settings. |
||
|
read/write |
The shape to apply to the bottom left corner of rectangular shapes. |
||
|
read/write |
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes |
||
|
read/write |
The shape to apply to the bottom right corner of rectangular shapes. |
||
|
read/write |
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes |
||
|
readonly |
A collection of buttons. |
||
|
readonly |
A collection of characters. |
||
|
readonly |
A collection of checkboxes. |
||
|
readonly |
A collection of comboboxes. |
||
|
readonly |
Transparency settings for the content of the TextFrame. |
||
|
read/write |
The type of content that a frame can contain. |
||
|
read/write |
The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator. |
||
|
read/write |
The end shape of an open path. |
||
|
read/write |
The corner join applied to the TextFrame. |
||
|
readonly |
The last text frame in the thread. Can return: TextFrame or TextPath. |
||
|
readonly |
A collection of endnote text frames. |
||
|
readonly |
EPSTexts |
||
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the TextFrame. . Can also accept: String. |
||
|
Number (range 0 - 100) |
read/write |
The percent of tint to use in the TextFrame'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.) |
|
|
readonly |
Transparency settings for the fill applied to the TextFrame. |
||
|
read/write |
The direction in which to flip the printed image. |
||
|
readonly |
A collection of footnotes. |
||
|
readonly |
A collection of form fields. |
||
|
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 (range 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.) |
|
|
read/write |
The bounds of the TextFrame 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. |
||
|
read/write |
The angle of a linear gradient applied to the fill of the TextFrame. (Range: -180 to 180) |
||
|
read/write |
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the TextFrame. |
||
|
read/write |
The starting point (in page coordinates) of a gradient applied to the fill of the TextFrame, in the format [x, y]. |
||
|
read/write |
The angle of a linear gradient applied to the stroke of the TextFrame. (Range: -180 to 180) |
||
|
read/write |
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the TextFrame. |
||
|
read/write |
The starting point (in page coordinates) of a gradient applied to the stroke of the TextFrame, in the format [x, y]. |
||
|
readonly |
A collection of graphic lines. |
||
|
readonly |
A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). |
||
|
readonly |
Default grid properties. Note: Applies to named, layout, and frame (story) grids. |
||
|
readonly |
A collection of groups. |
||
|
readonly |
A collection of hidden text objects. |
||
|
read/write |
The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule. |
||
|
read/write |
The horizontal scaling applied to the TextFrame. |
||
|
readonly |
The unique ID of the TextFrame. |
||
|
readonly |
The index of the TextFrame within its containing object. |
||
|
readonly |
A collection of insertion points. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
The layer that the TextFrame is on. |
||
|
read/write |
A property that can be set to any string. |
||
|
Number (range 1 - 1000) |
read/write |
The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000) |
|
|
read/write |
The arrowhead applied to the start of the path. |
||
|
readonly |
A collection of lines. |
||
|
readonly |
Linked Page Item options |
||
|
readonly |
A collection of listboxes. |
||
|
read/write |
Display performance options for the TextFrame. |
||
|
read/write |
If true, the TextFrame is locked. |
||
|
Number (range 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. |
|
|
readonly |
A collection of multi-state objects. |
||
|
read/write |
The name of the TextFrame. |
||
|
TextPathCanalsoaccept:NothingEnum |
read/write |
The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator. |
|
|
read/write |
If true, the TextFrame does not print. |
||
|
readonly |
A collection of notes. |
||
|
readonly |
Export options for the object |
||
|
readonly |
A collection of ellipses. |
||
|
readonly |
If true, the story has overset text. |
||
|
read/write |
If true, the TextFrame's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. |
||
|
read/write |
If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. |
||
|
read/write |
If true, the TextFrame's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. |
||
|
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. |
||
|
readonly |
An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound. |
||
|
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. |
||
|
readonly |
A collection of paragraphs. |
||
|
readonly |
The parent of the TextFrame (a Snippet, ComboBox, ListBox, TextBox, SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Cell, Character or PlaceGun). |
||
|
readonly |
The page on which this page item appears. |
||
|
readonly |
The story that contains the text. |
||
|
readonly |
A collection of paths. |
||
|
readonly |
A collection of polygons. |
||
|
readonly |
A collection of preferences objects. |
||
|
TextPathCanalsoaccept:NothingEnum |
read/write |
The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator. |
|
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
A collection of radio buttons. |
||
|
readonly |
A collection of rectangles. |
||
|
Number (range 1 - 1000) |
read/write |
The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000) |
|
|
read/write |
The arrowhead applied to the end of the path. |
||
|
read/write |
The rotatation angle of the TextFrame. (Range: -360 to 360) |
||
|
read/write |
The skewing angle applied to the TextFrame. (Range: -360 to 360) |
||
|
readonly |
A collection of signature fields. |
||
|
readonly |
The spline items collection. |
||
|
readonly |
The first text frame in the thread. Can return: TextFrame or TextPath. |
||
|
read/write |
The stroke alignment applied to the TextFrame. |
||
|
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the TextFrame. Can also accept: String. |
||
|
read/write |
The corner adjustment applied to the TextFrame. |
||
|
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 (range 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.) |
|
|
readonly |
Transparency settings for the stroke. |
||
|
read/write |
The name of the stroke style to apply. Can also accept: String. |
||
|
read/write |
The weight (in points) to apply to the TextFrame's stroke. |
||
|
readonly |
A collection of SVG files. |
||
|
readonly |
A collection of tables. |
||
|
readonly |
A collection of text boxes. |
||
|
readonly |
A collection of text columns. |
||
|
readonly |
The index of the text frame within the story. |
||
|
readonly |
Text frame preference settings. |
||
|
readonly |
A collection of text frames. |
||
|
readonly |
A collection of text paths. |
||
|
readonly |
A collection of text style ranges. |
||
|
readonly |
A collection of text variable instances. |
||
|
readonly |
The text wrap preference properties that define the default formatting for wrapping text around objects. |
||
|
readonly |
A collection of text objects. |
||
|
readonly |
The object timing settings. |
||
|
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. |
||
|
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 |
||
|
read/write |
The shape to apply to the top right corner of rectangular shapes |
||
|
read/write |
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes |
||
|
readonly |
Transparency settings. |
||
|
read/write |
The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule. |
||
|
read/write |
The vertical scaling applied to the TextFrame. |
||
|
read/write |
If true, the TextFrame is visible. |
||
|
read/write |
The bounds of the TextFrame 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. |
||
|
readonly |
A collection of words. |
Constants/Events
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
PageItem addPath (with:Array of PageItem)
Creates a new page item by combining the TextFrame with other objects. Deletes the objects if they do not intersect.
undefined applyObjectStyle (using:ObjectStyle, [clearingOverrides:Boolean=Boolean], [clearingOverridesThroughRootObjectStyle:Boolean=Boolean])
Applies the specified object style.
|
Parameter |
Type |
Description |
|---|---|---|
|
using |
The object style to apply. |
|
|
clearingOverrides |
If true, clears the TextFrame's existing attributes before applying the style. (Optional) (default: true) |
|
|
clearingOverridesThroughRootObjectStyle |
If true, clears attributes and formatting applied to the TextFrame that are not defined in the object style. (Optional) (default: false) |
BackgroundTask asynchronousExportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])
asynchronously exports the object(s) to a file.
|
Parameter |
Type |
Description |
|---|---|---|
|
format |
The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. |
|
|
to |
The path to the export file. |
|
|
showingOptions |
If true, displays the export options dialog. (Optional) (default: false) |
|
|
using |
The export style. (Optional) |
|
|
versionComments |
The comment for this version. (Optional) |
|
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
undefined autoTag ()
Tag the object or the parent story using default tags defined in XML preference.
undefined bringForward ()
Brings the TextFrame forward one level in its layer.
undefined bringToFront (reference:PageItem)
Brings the TextFrame to the front of its layer or in front of a particular item.
|
Parameter |
Type |
Description |
|---|---|---|
|
reference |
The reference object to bring the object in front of (must have same parent) (Optional) |
Text changeGlyph (reverseOrder:Boolean)
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text changeGrep (reverseOrder:Boolean)
Finds text that matches the find what value and replaces the text with the change to value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
PageItem changeObject (reverseOrder:Boolean)
Finds objects that match the find what value and replace the objects with the change to value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text changeText (reverseOrder:Boolean)
Finds text that matches the find what value and replaces the text with the change to value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text changeTransliterate (reverseOrder:Boolean)
Finds text that matches the find character type value and replaces the text with the change character type value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
undefined clearObjectStyleOverrides ()
Clear overrides for object style
undefined clearTransformations ()
Clears transformations from the TextFrame. Transformations include rotation, scaling, flipping, fitting, and shearing.
Varies contentPlace (pageItems:Array of PageItem, [linkPageItems:Boolean=Boolean], [linkStories:Boolean=Boolean], [mapStyles:Boolean=Boolean], [showingOptions:Boolean=Boolean])
Duplicate an object and place it into the target page item.
|
Parameter |
Type |
Description |
|---|---|---|
|
pageItems |
One or more page items to place or load |
|
|
linkPageItems |
Whether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false) |
|
|
linkStories |
Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) (default: false) |
|
|
mapStyles |
Whether to map styles in content placer (Optional) (default: false) |
|
|
showingOptions |
Whether to display the link options dialog (Optional) (default: false) |
undefined convertShape (given:ConvertShapeOptions, numberOfSides:Number, insetPercentage:Number, cornerRadius:Number String)
Converts the TextFrame to a different shape.
|
Parameter |
Type |
Description |
|---|---|---|
|
given |
The TextFrame's new shape. |
|
|
numberOfSides |
Number (range 3 - 100) |
The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) |
|
insetPercentage |
Number (range 0 - 100) |
The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) |
|
cornerRadius |
The corner radius of the resulting rectangle. (Optional) |
undefined convertToRawText ()
Convert the text frame contents to raw text
undefined createEmailQRCode (emailAddress:String, subject:String, body:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Email QR Code on the page item or document
|
Parameter |
Type |
Description |
|---|---|---|
|
emailAddress |
QR code Email Address (Optional) |
|
|
subject |
QR code Email Subject (Optional) |
|
|
body |
QR code Email Body Message (Optional) |
|
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
|
withProperties |
Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) |
undefined createHyperlinkQRCode (urlLink:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Hyperlink QR Code on the page item or document
|
Parameter |
Type |
Description |
|---|---|---|
|
urlLink |
QR code Hyperlink URL (Optional) |
|
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
|
withProperties |
Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) |
PageItem createOutlines ([deleteOriginal:Boolean=Boolean])
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.
|
Parameter |
Type |
Description |
|---|---|---|
|
deleteOriginal |
If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true) |
undefined createPlainTextQRCode (plainText:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Plain Text QR Code on the page item
|
Parameter |
Type |
Description |
|---|---|---|
|
plainText |
QR code Plain Text (Optional) |
|
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
|
withProperties |
Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) |
undefined createTextMsgQRCode (cellNumber:String, textMessage:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Text Msg QR Code on the page item or document
|
Parameter |
Type |
Description |
|---|---|---|
|
cellNumber |
QR code Text Phone Number (Optional) |
|
|
textMessage |
QR code Text Message (Optional) |
|
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
|
withProperties |
Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) |
undefined createVCardQRCode (firstName:String, lastName:String, jobTitle:String, cellPhone:String, phone:String, email:String, organisation:String, streetAddress:String, city:String, adrState:String, country:String, postalCode:String, website:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Business Card QR Code on the page item or load on document's placegun
|
Parameter |
Type |
Description |
|---|---|---|
|
firstName |
QR code Business Card First Name (Optional) |
|
|
lastName |
QR code Business Card Last Name (Optional) |
|
|
jobTitle |
QR code Business Card Title (Optional) |
|
|
cellPhone |
QR code Business Card Cell Phone Number (Optional) |
|
|
phone |
QR code Business Card Phone Number (Optional) |
|
|
|
QR code Business Card Email Address (Optional) |
|
|
organisation |
QR code Business Card Organisation (Optional) |
|
|
streetAddress |
QR code Business Card Street Address (Optional) |
|
|
city |
QR code Business Card City (Optional) |
|
|
adrState |
QR code Business Card State (Optional) |
|
|
country |
QR code Business Card Country (Optional) |
|
|
postalCode |
QR code Business Card Postal Code (Optional) |
|
|
website |
QR code Business Card URL (Optional) |
|
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
|
withProperties |
Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) |
undefined detach ()
Detaches an overridden master page item from the master page.
PageItem duplicate (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String)
Duplicates the TextFrame at the specified location or offset.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
Array of 2 Units |
The location of the new TextFrame, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) |
|
by |
Amount by which to offset the new TextFrame from the original TextFrame's position. (Optional) |
PageItem excludeOverlapPath (with:Array of PageItem)
Creates a new page item by excluding the overlapping areas of the TextFrame and other objects.
undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])
Exports the object(s) to a file.
|
Parameter |
Type |
Description |
|---|---|---|
|
format |
The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. |
|
|
to |
The path to the export file. |
|
|
showingOptions |
If true, displays the export options dialog. (Optional) (default: false) |
|
|
using |
The export style. (Optional) |
|
|
versionComments |
The comment for this version. (Optional) |
|
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
Text findGlyph (reverseOrder:Boolean)
Finds glyphs that match the find what value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text findGrep (reverseOrder:Boolean)
Finds text that matches the find what value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
PageItem findObject (reverseOrder:Boolean)
Finds objects that match the find what value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text findText (reverseOrder:Boolean)
Finds text that matches the find what value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text findTransliterate (reverseOrder:Boolean)
Finds text that matches the find character type value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
undefined fit (given:FitOptions)
Applies the specified fit option to content in a frame.
|
Parameter |
Type |
Description |
|---|---|---|
|
given |
The fit option to use. |
undefined flipItem (given:Flip, around:Array of Varies 2 Units AnchorPoint)
Flips the TextFrame.
|
Parameter |
Type |
Description |
|---|---|---|
|
given |
The axis around which to flip the TextFrame. |
|
|
around |
Array of 2 Units |
The point around which to flip the TextFrame. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
TextFrame getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
PageItem intersectPath (with:Array of PageItem)
Creates a new page item by intersecting the TextFrame with other objects. Returns an error if the objects do not intersect.
PageItem makeCompoundPath (with:Array of PageItem)
Creates a compound path by combining the path(s) of the TextFrame with the paths of other objects.
|
Parameter |
Type |
Description |
|---|---|---|
|
with |
The other objects whose paths to include in the new compound path. |
undefined markup (using:XMLElement)
Associates the page item with the specified XML element while preserving existing content.
|
Parameter |
Type |
Description |
|---|---|---|
|
using |
The XML element. |
PageItem minusBack (with:Array of PageItem)
Creates a new page item by reverse subtracting the overlapping areas of the TextFrame and other objects.
undefined move (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String)
Moves the TextFrame to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
Array of 2 Units |
The new location of the TextFrame,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) |
|
by |
The amount (in measurement units) to move the TextFrame relative to its current position, in the format (x, y). (Optional) |
Varies override (destinationPage:Page)
Overrides a master page item and places the item on the document page as a new object.
|
Parameter |
Type |
Description |
|---|---|---|
|
destinationPage |
The document page that contains the master page item to override. |
Varies place (fileName:File, [showingOptions:Boolean=Boolean], withProperties:Object)
Places the file.
|
Parameter |
Type |
Description |
|---|---|---|
|
fileName |
The file to place |
|
|
showingOptions |
Whether to display the import options dialog (Optional) (default: false) |
|
|
withProperties |
Initial values for properties of the placed object(s) (Optional) |
Story placeAndLink (parentStory:Story, [showingOptions:Boolean=Boolean])
Deprecated: Use contentPlace method. Original Description: Create a linked story and place it into the target page item.
|
Parameter |
Type |
Description |
|---|---|---|
|
parentStory |
The story to place and link from. |
|
|
showingOptions |
Whether to display the link options dialog (Optional) (default: false) |
undefined placeXML (using:XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.
|
Parameter |
Type |
Description |
|---|---|---|
|
using |
The XML element whose content you want to place. |
undefined recompose ()
Recomposes the text in the TextFrame.
undefined redefineScaling (to:Array of Number)
Apply an item's scaling to its content if possible.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) |
undefined reframe (in:Varies CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, opposingCorners:Array of Varies)
Move the bounding box of the page item
|
Parameter |
Type |
Description |
|---|---|---|
|
in |
BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces |
The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. |
|
opposingCorners |
Array of Varies |
Opposing corners of new bounding box in the given coordinate space |
PageItem releaseCompoundPath ()
Releases a compound path.
undefined remove ()
Deletes the TextFrame.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined removeOverride ()
Removes the override from a previously overridden master page item.
undefined resize (in:Varies BoundingBoxLimits CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, by:ResizeMethods, values:Array of Varies Reals ResizeConstraintss CoordinateSpacess, [resizeIndividually:Boolean=Boolean], [consideringRulerUnits:Boolean=Boolean])
Resize the page item.
|
Parameter |
Type |
Description |
|---|---|---|
|
in |
BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces |
The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. |
|
from |
AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of Arrays of 2 Reals LongIntegers |
The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
|
by |
How the current dimensions are affected by the given values |
|
|
values |
Array of Reals Array of ResizeConstraintss ResizeConstraints Array of CoordinateSpacess CoordinateSpaces |
The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. |
|
resizeIndividually |
If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) (default: true) |
|
|
consideringRulerUnits |
If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
Varies resolve (location:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, in:CoordinateSpaces, [consideringRulerUnits:Boolean=Boolean])
Get the coordinates of the given location in the specified coordinate system.
|
Parameter |
Type |
Description |
|---|---|---|
|
location |
AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of Arrays of 2 Reals LongIntegers |
The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
|
in |
The coordinate space to use. |
|
|
consideringRulerUnits |
If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
undefined select ([existingSelection:SelectionOptions=SelectionOptions])
Selects the object.
|
Parameter |
Type |
Description |
|---|---|---|
|
existingSelection |
The selection status of the TextFrame in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH) |
undefined sendBackward ()
Sends the TextFrame back one level in its layer.
undefined sendToBack (reference:PageItem)
Sends the TextFrame to the back of its layer or behind a particular item (must have same parent).
|
Parameter |
Type |
Description |
|---|---|---|
|
reference |
The reference object to send the object behind (Optional) |
Asset store (using:Library, withProperties:Object)
Stores the object in the specified library.
|
Parameter |
Type |
Description |
|---|---|---|
|
using |
The library in which to store the object. |
|
|
withProperties |
Initial values for properties of the new TextFrame (Optional) |
PageItem subtractPath (with:Array of PageItem)
Creates a new page item by subtracting the overlapping areas of the TextFrame and other objects.
String toSource ()
Generates a string which, if executed, will return the TextFrame.
String toSpecifier ()
Retrieves the object specifier.
undefined transform (in:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, withMatrix:Array of Varies 6 Reals TransformationMatrix, replacingCurrent:Array of Varies MatrixContent enumerators MatrixContent LongInteger, [consideringRulerUnits:Boolean=Boolean])
Transform the page item.
|
Parameter |
Type |
Description |
|---|---|---|
|
in |
The coordinate space to use |
|
|
from |
AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of Arrays of 2 Reals LongIntegers |
The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
|
withMatrix |
Array of 6 Reals |
Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. |
|
replacingCurrent |
Array of MatrixContent enumerators LongInteger |
Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) |
|
consideringRulerUnits |
If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
String transformAgain ()
Transforms the TextFrame using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.
String transformAgainIndividually ()
Transforms the TextFrame using the last transformation performed on any TextFrame. Transformations include moving, rotating, shearing, scaling, and flipping.
String transformSequenceAgain ()
Transforms the TextFrame using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.
String transformSequenceAgainIndividually ()
Transforms the TextFrame using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.
TransformationMatrix transformValuesOf (in:CoordinateSpaces)
Get the transformation values of the page item.
|
Parameter |
Type |
Description |
|---|---|---|
|
in |
The coordinate space to use |
Object of
TextFrame.startTextFrame
EndnoteTextFrame.startTextFrame
TextPath.startTextFrame
TextFrame.endTextFrame
EndnoteTextFrame.endTextFrame
TextPath.endTextFrame
TextFrame.nextTextFrame
EndnoteTextFrame.nextTextFrame
TextPath.nextTextFrame
AnchoredObjectSetting.parent
AnimationSetting.parent
BaselineFrameGridOption.parent
Character.parent
ContentTransparencySetting.parent
Event.parent
EventListener.parent
FillTransparencySetting.parent
Footnote.parent
Graphic.parent
GridDataInformation.parent
HiddenText.parent
InsertionPoint.parent
Line.parent
LinkedPageItemOption.parent
MutationEvent.parent
Note.parent
ObjectExportOption.parent
PageItem.parent
Paragraph.parent
Path.parent
Preference.parent
SVG.parent
StrokeTransparencySetting.parent
Table.parent
Text.parent
TextColumn.parent
TextFramePreference.parent
TextPath.parent
TextStyleRange.parent
TextVariableInstance.parent
TextWrapPreference.parent
TimingSetting.parent
TransparencySetting.parent
Word.parent
TextFrame.previousTextFrame
EndnoteTextFrame.previousTextFrame
TextPath.previousTextFrame
Return
TextFrames.[]()