TextFrame

A text frame.

Go to Property Listing | Method Listing

Methods:

createOutlines, recompose, findText, changeText, findGrep, changeGrep, findGlyph, changeGlyph, findObject, changeObject, findTransliterate, changeTransliterate, placeAndLink, bringToFront, sendToBack, bringForward, sendBackward, makeCompoundPath, releaseCompoundPath, intersectPath, addPath, subtractPath, minusBack, excludeOverlapPath, convertShape, contentPlace, store, insertLabel, placeXML, autoTag, markup, place, override, removeOverride, detach, remove, fit, flipItem, duplicate, move, applyObjectStyle, clearObjectStyleOverrides, clearTransformations, transform, transformValuesOf, resolve, redefineScaling, resize, reframe, transformAgain, transformSequenceAgain, transformAgainIndividually, transformSequenceAgainIndividually, exportFile, asynchronousExportFile, select, extractLabel, toSource, getElements, toSpecifier, addEventListener, removeEventListener

Objects:

AnchoredObjectSetting, AnimationSetting, ArrowHead, Article, BaselineFrameGridOption, Boolean, Buttons, Character, Characters, CheckBoxes, ComboBox, ComboBoxes, ContentTransparencySetting, ContentType, CornerOptions, DimensionsConstraints, DisplaySettingOptions, EPSTexts, EndCap, EndJoin, EventListeners, Events, FillTransparencySetting, Flip, Footnotes, FormFields, Graphic, GraphicLine, GraphicLines, GridDataInformation, Group, Groups, Guide, HiddenTexts, InsertionPoints, Layer, Lines, LinkedPageItemOption, ListBox, ListBoxes, MasterSpread, Movie, MultiStateObjects, Notes, NothingEnum, Number, Object, ObjectExportOption, ObjectStyle, Oval, Ovals, Page, PageItem, PageItems, Paragraphs, Paths, PlaceGun, Polygon, Polygons, Preferences, RadioButtons, Rectangle, Rectangles, SignatureField, SignatureFields, Snippet, Sound, SpecialCharacters, SplineItem, SplineItems, Spread, State, Story, String, StrokeAlignment, StrokeCornerAdjustment, StrokeStyle, StrokeTransparencySetting, Swatch, Tables, TextBox, TextBoxes, TextColumns, TextFrame, TextFrameContents, TextFramePreference, TextFrames, TextPath, TextPaths, TextStyleRanges, TextVariableInstances, TextWrapPreference, Texts, TimingSetting, TransparencySetting, Words, XMLItem,

Superclass:

PageItem

Property Listing

Property	Type	Access	Description
absoluteFlip	Flip Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	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.
absoluteHorizontalScale	Number	read/write	The horizontal scale of the TextFrame relative to its containing object.
absoluteRotationAngle	Number	read/write	The rotation angle of the TextFrame relative to its containing object. (Range: -360 to 360)
absoluteShearAngle	Number	read/write	The skewing angle of the TextFrame relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale	Number	read/write	The vertical scale of the TextFrame relative to its containing object.
allArticles	Array of Article	readonly	The list of all articles this page item is part of
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the TextFrame.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the TextFrame.
allowOverrides	Boolean	read/write	If true, the master page item can be overridden.
anchoredObjectSettings	AnchoredObjectSetting	readonly	Anchored object settings.
animationSettings	AnimationSetting	readonly	The page item animation settings.
appliedObjectStyle	ObjectStyle	read/write	The object style applied to the TextFrame.
associatedXMLElement	XMLItem	readonly	The XML element associated with the TextFrame.
baselineFrameGridOptions	BaselineFrameGridOption	readonly	Baseline frame grid option settings.
bottomLeftCornerOption	CornerOptions CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	read/write	The shape to apply to the bottom left corner of rectangular shapes.
bottomLeftCornerRadius	Number String	read/write	The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
bottomRightCornerOption	CornerOptions CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	read/write	The shape to apply to the bottom right corner of rectangular shapes.
bottomRightCornerRadius	Number String	read/write	The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
buttons	Buttons Button	readonly	A collection of buttons.
characters	Characters Character	readonly	A collection of characters.
checkBoxes	CheckBoxes	readonly	A collection of checkboxes.
comboBoxes	ComboBoxes	readonly	A collection of comboboxes.
contentTransparencySettings	ContentTransparencySetting	readonly	Transparency settings for the content of the TextFrame.
contentType	ContentType ContentType.UNASSIGNED ContentType.GRAPHIC_TYPE ContentType.TEXT_TYPE	read/write	The type of content that a frame can contain.
contents	String TextFrameContents TextFrameContents.PLACEHOLDER_TEXT TextFrameContents.PLACEHOLDER_TEXT_ARABIC TextFrameContents.PLACEHOLDER_TEXT_HEBREW TextFrameContents.PLACEHOLDER_TEXT_CYRILLIC TextFrameContents.PLACEHOLDER_TEXT_GREEK SpecialCharacters SpecialCharacters.AUTO_PAGE_NUMBER SpecialCharacters.NEXT_PAGE_NUMBER SpecialCharacters.PREVIOUS_PAGE_NUMBER SpecialCharacters.SECTION_MARKER SpecialCharacters.BULLET_CHARACTER SpecialCharacters.COPYRIGHT_SYMBOL SpecialCharacters.DEGREE_SYMBOL SpecialCharacters.ELLIPSIS_CHARACTER SpecialCharacters.FORCED_LINE_BREAK SpecialCharacters.PARAGRAPH_SYMBOL SpecialCharacters.REGISTERED_TRADEMARK SpecialCharacters.SECTION_SYMBOL SpecialCharacters.TRADEMARK_SYMBOL SpecialCharacters.RIGHT_INDENT_TAB SpecialCharacters.INDENT_HERE_TAB SpecialCharacters.EM_DASH SpecialCharacters.EN_DASH SpecialCharacters.DISCRETIONARY_HYPHEN SpecialCharacters.NONBREAKING_HYPHEN SpecialCharacters.END_NESTED_STYLE SpecialCharacters.DOUBLE_LEFT_QUOTE SpecialCharacters.DOUBLE_RIGHT_QUOTE SpecialCharacters.SINGLE_LEFT_QUOTE SpecialCharacters.SINGLE_RIGHT_QUOTE SpecialCharacters.EM_SPACE SpecialCharacters.EN_SPACE SpecialCharacters.FLUSH_SPACE SpecialCharacters.HAIR_SPACE SpecialCharacters.NONBREAKING_SPACE SpecialCharacters.THIN_SPACE SpecialCharacters.FIGURE_SPACE SpecialCharacters.PUNCTUATION_SPACE SpecialCharacters.COLUMN_BREAK SpecialCharacters.FRAME_BREAK SpecialCharacters.PAGE_BREAK SpecialCharacters.ODD_PAGE_BREAK SpecialCharacters.EVEN_PAGE_BREAK SpecialCharacters.FOOTNOTE_SYMBOL SpecialCharacters.LEFT_TO_RIGHT_EMBEDDING SpecialCharacters.RIGHT_TO_LEFT_EMBEDDING SpecialCharacters.POP_DIRECTIONAL_FORMATTING SpecialCharacters.LEFT_TO_RIGHT_OVERRIDE SpecialCharacters.RIGHT_TO_LEFT_OVERRIDE SpecialCharacters.DOTTED_CIRCLE SpecialCharacters.ZERO_WIDTH_JOINER SpecialCharacters.TEXT_VARIABLE SpecialCharacters.SINGLE_STRAIGHT_QUOTE SpecialCharacters.DOUBLE_STRAIGHT_QUOTE SpecialCharacters.DISCRETIONARY_LINE_BREAK SpecialCharacters.ZERO_WIDTH_NONJOINER SpecialCharacters.THIRD_SPACE SpecialCharacters.QUARTER_SPACE SpecialCharacters.SIXTH_SPACE SpecialCharacters.FIXED_WIDTH_NONBREAKING_SPACE SpecialCharacters.HEBREW_MAQAF SpecialCharacters.HEBREW_GERESH SpecialCharacters.HEBREW_GERSHAYIM SpecialCharacters.ARABIC_KASHIDA SpecialCharacters.ARABIC_COMMA SpecialCharacters.ARABIC_SEMICOLON SpecialCharacters.ARABIC_QUESTION_MARK SpecialCharacters.LEFT_TO_RIGHT_MARK SpecialCharacters.RIGHT_TO_LEFT_MARK SpecialCharacters.HEBREW_SOF_PASUK	read/write	The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator.
endCap	EndCap EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP	read/write	The end shape of an open path.
endJoin	EndJoin EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN	read/write	The corner join applied to the TextFrame.
endTextFrame	TextFrame TextPath	readonly	The last text frame in the thread. Can return: TextFrame or TextPath.
epstexts	EPSTexts EPSText	readonly	EPSTexts
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
fillColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the TextFrame. . Can also accept: String.
fillTint	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.)
fillTransparencySettings	FillTransparencySetting	readonly	Transparency settings for the fill applied to the TextFrame.
flip	Flip Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	read/write	The direction in which to flip the printed image.
footnotes	Footnotes Footnote	readonly	A collection of footnotes.
formFields	FormFields FormField	readonly	A collection of form fields.
gapColor	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.
gapTint	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.)
geometricBounds	Array of Number Array of String	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.
gradientFillAngle	Number	read/write	The angle of a linear gradient applied to the fill of the TextFrame. (Range: -180 to 180)
gradientFillLength	Number String	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the TextFrame.
gradientFillStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the fill of the TextFrame, in the format [x, y].
gradientStrokeAngle	Number	read/write	The angle of a linear gradient applied to the stroke of the TextFrame. (Range: -180 to 180)
gradientStrokeLength	Number String	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the TextFrame.
gradientStrokeStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the stroke of the TextFrame, in the format [x, y].
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
gridData	GridDataInformation	readonly	Default grid properties. Note: Applies to named, layout, and frame (story) grids.
groups	Groups Group	readonly	A collection of groups.
hiddenTexts	HiddenTexts HiddenText	readonly	A collection of hidden text objects.
horizontalLayoutConstraints	Array of DimensionsConstraints DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION	read/write	The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule.
horizontalScale	Number	read/write	The horizontal scaling applied to the TextFrame.
id	Number	readonly	The unique ID of the TextFrame.
index	Number	readonly	The index of the TextFrame within its containing object.
insertionPoints	InsertionPoints InsertionPoint	readonly	A collection of insertion points.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
itemLayer	Layer	read/write	The layer that the TextFrame is on.
label	String	read/write	A property that can be set to any string.
leftLineEnd	ArrowHead ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD	read/write	The arrowhead applied to the start of the path.
lines	Lines Line	readonly	A collection of lines.
linkedPageItemOptions	LinkedPageItemOption	readonly	Linked Page Item options
listBoxes	ListBoxes	readonly	A collection of listboxes.
localDisplaySetting	DisplaySettingOptions DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.TYPICAL DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.DEFAULT_VALUE	read/write	Display performance options for the TextFrame.
locked	Boolean	read/write	If true, the TextFrame is locked.
miterLimit	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.
multiStateObjects	MultiStateObjects MultiStateObject	readonly	A collection of multi-state objects.
name	String	read/write	The name of the TextFrame.
nextTextFrame	NothingEnum.NOTHING TextFrame TextPath	read/write	The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
nonprinting	Boolean	read/write	If true, the TextFrame does not print.
notes	Notes Note	readonly	A collection of notes.
objectExportOptions	ObjectExportOption	readonly	Export options for the object
ovals	Ovals Oval	readonly	A collection of ellipses.
overflows	Boolean	readonly	If true, the story has overset text.
overprintFill	Boolean	read/write	If true, the TextFrame's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGap	Boolean	read/write	If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStroke	Boolean	read/write	If true, the TextFrame's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overridden	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.
overriddenMasterPageItem	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	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.
paragraphs	Paragraphs Paragraph	readonly	A collection of paragraphs.
parent	Character ComboBox GraphicLine Group ListBox MasterSpread Oval Polygon Rectangle SignatureField SplineItem Spread State TextBox PlaceGun Snippet	readonly	The parent of the TextFrame (a Snippet, ComboBox, ListBox, TextBox, SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character or PlaceGun).
parentPage	Page	readonly	The page on which this page item appears.
parentStory	Story	readonly	The story that contains the text.
paths	Paths Path	readonly	A collection of paths.
polygons	Polygons Polygon	readonly	A collection of polygons.
preferences	Preferences Preference	readonly	A collection of preferences objects.
previousTextFrame	NothingEnum.NOTHING TextFrame TextPath	read/write	The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
properties	Object	read/write	A property that allows setting of several properties at the same time.
radioButtons	RadioButtons RadioButton	readonly	A collection of radio buttons.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
rightLineEnd	ArrowHead ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD	read/write	The arrowhead applied to the end of the path.
rotationAngle	Number	read/write	The rotatation angle of the TextFrame. (Range: -360 to 360)
shearAngle	Number	read/write	The skewing angle applied to the TextFrame. (Range: -360 to 360)
signatureFields	SignatureFields SignatureField	readonly	A collection of signature fields.
splineItems	SplineItems SplineItem	readonly	The spline items collection.
startTextFrame	TextFrame TextPath	readonly	The first text frame in the thread. Can return: TextFrame or TextPath.
strokeAlignment	StrokeAlignment StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT	read/write	The stroke alignment applied to the TextFrame.
strokeColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the TextFrame. Can also accept: String.
strokeCornerAdjustment	StrokeCornerAdjustment StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS	read/write	The corner adjustment applied to the TextFrame.
strokeDashAndGap	Array of Number Array of String	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].
strokeTint	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.)
strokeTransparencySettings	StrokeTransparencySetting	readonly	Transparency settings for the stroke.
strokeType	StrokeStyle String	read/write	The name of the stroke style to apply. Can also accept: String.
strokeWeight	Number String	read/write	The weight (in points) to apply to the TextFrame's stroke.
tables	Tables Table	readonly	A collection of tables.
textBoxes	TextBoxes	readonly	A collection of text boxes.
textColumns	TextColumns TextColumn	readonly	A collection of text columns.
textFrameIndex	Number	readonly	The index of the text frame within the story.
textFramePreferences	TextFramePreference	readonly	Text frame preference settings.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.
textPaths	TextPaths TextPath	readonly	A collection of text paths.
textStyleRanges	TextStyleRanges TextStyleRange	readonly	A collection of text style ranges.
textVariableInstances	TextVariableInstances TextVariableInstance	readonly	A collection of text variable instances.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
texts	Texts Text	readonly	A collection of text objects.
timingSettings	TimingSetting	readonly	The object timing settings.
topLeftCornerOption	CornerOptions CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	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.
topLeftCornerRadius	Number String	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
topRightCornerOption	CornerOptions CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	read/write	The shape to apply to the top right corner of rectangular shapes
topRightCornerRadius	Number String	read/write	The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
transparencySettings	TransparencySetting	readonly	Transparency settings.
verticalLayoutConstraints	Array of DimensionsConstraints DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION	read/write	The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule.
verticalScale	Number	read/write	The vertical scaling applied to the TextFrame.
visible	Boolean	read/write	If true, the TextFrame is visible.
visibleBounds	Array of Number Array of String	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.
words	Words Word	readonly	A collection of words.

Constants/Events

Name	Type	Access	Description
AFTER_PLACE	String	readonly	Dispatched after a TextFrame is placed. This event bubbles. This event is not cancelable.
BEFORE_PLACE	String	readonly	Dispatched before a TextFrame is placed. This event bubbles. This event is cancelable.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	Varies	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

Varies

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

Parameter	Type	Description
with	Array of PageItem	The object(s) to add.

undefined applyObjectStyle (using:ObjectStyle, [clearingOverrides:Boolean=Boolean], [clearingOverridesThroughRootObjectStyle:Boolean=Boolean])

Applies the specified object style.

Parameter	Type	Description
using	ObjectStyle	The object style to apply.
clearingOverrides	Boolean	If true, clears the TextFrame's existing attributes before applying the style. (Optional) (default: true)
clearingOverridesThroughRootObjectStyle	Boolean	If true, clears attributes and formatting applied to the TextFrame that are not defined in the object style. (Optional) (default: false)

Parameter

Type

Description

using

ObjectStyle

The object style to apply.

clearingOverrides

Boolean

If true, clears the TextFrame's existing attributes before applying the style. (Optional)

(default: true)

clearingOverridesThroughRootObjectStyle

Boolean

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, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])

asynchronously exports the object(s) to a file.

Parameter	Type	Description
format	Varies	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	File	The path to the export file.
showingOptions	Boolean	If true, displays the export options dialog. (Optional) (default: false)
using	PDFExportPreset	The export style. (Optional)
versionComments	String	The comment for this version. (Optional)
forceSave	Boolean	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	PageItem	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	Boolean	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	Boolean	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	Boolean	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	Boolean	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	Boolean	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	Array of PageItem	One or more page items to place or load
linkPageItems	Boolean	Whether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false)
linkStories	Boolean	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	Boolean	Whether to map styles in content placer (Optional) (default: false)
showingOptions	Boolean	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	ConvertShapeOptions ConvertShapeOptions.CONVERT_TO_RECTANGLE ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_OVAL ConvertShapeOptions.CONVERT_TO_TRIANGLE ConvertShapeOptions.CONVERT_TO_POLYGON ConvertShapeOptions.CONVERT_TO_LINE ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE ConvertShapeOptions.CONVERT_TO_OPEN_PATH ConvertShapeOptions.CONVERT_TO_CLOSED_PATH	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	Number String	The corner radius of the resulting rectangle. (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	Boolean	If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true)

Parameter

Type

Description

deleteOriginal

Boolean

If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)

(default: true)

undefined detach ()

Detaches an overridden master page item from the master page.

PageItem duplicate (to:Varies, by:Array of Number String)

Duplicates the TextFrame at the specified location or offset.

Parameter	Type	Description
to	Varies	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	Array of Number Array of String	Amount by which to offset the new TextFrame from the original TextFrame's position. (Optional)

Parameter

Type

Description

Varies

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)

Array of Number

Array of String

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.

Parameter	Type	Description
with	Array of PageItem	The object(s) to exclude.

undefined exportFile (format:Varies, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])

Exports the object(s) to a file.

Parameter	Type	Description
format	Varies	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	File	The path to the export file.
showingOptions	Boolean	If true, displays the export options dialog. (Optional) (default: false)
using	PDFExportPreset	The export style. (Optional)
versionComments	String	The comment for this version. (Optional)
forceSave	Boolean	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	String	The key.

Text findGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value.

Parameter	Type	Description
reverseOrder	Boolean	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	Boolean	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	Boolean	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	Boolean	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	Boolean	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	FitOptions FitOptions.CONTENT_TO_FRAME FitOptions.CENTER_CONTENT FitOptions.PROPORTIONALLY FitOptions.FRAME_TO_CONTENT FitOptions.FILL_PROPORTIONALLY FitOptions.APPLY_FRAME_FITTING_OPTIONS	The fit option to use.

Parameter

Type

Description

given

FitOptions

FitOptions.CONTENT_TO_FRAME

FitOptions.CENTER_CONTENT

FitOptions.PROPORTIONALLY

FitOptions.FRAME_TO_CONTENT

FitOptions.FILL_PROPORTIONALLY

FitOptions.APPLY_FRAME_FITTING_OPTIONS

The fit option to use.

undefined flipItem (given:Flip, around:Varies)

Flips the TextFrame.

Parameter	Type	Description
given	Flip Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	The axis around which to flip the TextFrame.
around	Varies	The point around which to flip the TextFrame. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Parameter

Type

Description

given

Flip

Flip.NONE

Flip.HORIZONTAL

Flip.VERTICAL

Flip.HORIZONTAL_AND_VERTICAL

Flip.BOTH

The axis around which to flip the TextFrame.

around

Varies

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.

Parameter	Type	Description
key	String	The key.
value	String	The value.

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.

Parameter	Type	Description
with	Array of PageItem	The object(s) with which to 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	Array of PageItem	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	XMLElement	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.

Parameter	Type	Description
with	Array of PageItem	The object(s) to reverse subtract.

undefined move (to:Varies, 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	Varies	The new location of the TextFrame,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of Number Array of String	The amount (in measurement units) to move the TextFrame relative to its current position, in the format (x, y). (Optional)

Parameter

Type

Description

Varies

The new location of the TextFrame,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

Array of Number

Array of String

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	Page	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	File	The file to place
showingOptions	Boolean	Whether to display the import options dialog (Optional) (default: false)
withProperties	Object	Initial values for properties of the placed object(s) (Optional)

Parameter

Type

Description

fileName

File

The file to place

showingOptions

Boolean

Whether to display the import options dialog (Optional)

(default: false)

withProperties

Object

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	Story	The story to place and link from.
showingOptions	Boolean	Whether to display the link options dialog (Optional) (default: false)

Parameter

Type

Description

parentStory

Story

The story to place and link from.

showingOptions

Boolean

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	XMLElement	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	Array of Number	The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

undefined reframe (in:Varies, opposingCorners:Array of Varies)

Move the bounding box of the page item

Parameter	Type	Description
in	Varies	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, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	Varies	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

Varies

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined resize (in:Varies, from:Varies, by:ResizeMethods, values:Array of Varies, [resizeIndividually:Boolean=Boolean], [consideringRulerUnits:Boolean=Boolean])

Resize the page item.

Parameter	Type	Description
in	Varies	The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
from	Varies	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	ResizeMethods ResizeMethods.ADDING_CURRENT_DIMENSIONS_TO ResizeMethods.MULTIPLYING_CURRENT_DIMENSIONS_BY ResizeMethods.REPLACING_CURRENT_DIMENSIONS_WITH ResizeMethods.RESHAPING_AREA_TO_RATIO ResizeMethods.RESHAPING_BORDER_TO_RATIO	How the current dimensions are affected by the given values
values	Array of Varies	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	Boolean	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	Boolean	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:Varies, in:CoordinateSpaces, [consideringRulerUnits:Boolean=Boolean])

Get the coordinates of the given location in the specified coordinate system.

Parameter	Type	Description
location	Varies	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	CoordinateSpaces CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use.
consideringRulerUnits	Boolean	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)

Parameter

Type

Description

location

Varies

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.

CoordinateSpaces

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use.

consideringRulerUnits

Boolean

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	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH SelectionOptions.SET_KEY	The selection status of the TextFrame in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

SelectionOptions.SET_KEY

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	PageItem	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	Library	The library in which to store the object.
withProperties	Object	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.

Parameter	Type	Description
with	Array of PageItem	The object(s) to subtract.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

undefined transform (in:CoordinateSpaces, from:Varies, withMatrix:Varies, replacingCurrent:Varies, [consideringRulerUnits:Boolean=Boolean])

Transform the page item.

Parameter	Type	Description
in	CoordinateSpaces CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use
from	Varies	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	Varies	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent	Varies	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	Boolean	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

CoordinateSpaces

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use