Adobe InDesign CS5.5 Server (7.5) Object Model JS: TextFrame

InDesign Server CS5.5

previous page next page

Class

TextFrame

A text frame. Base Class: PageItem

QuickLinks

addEventListener, addPath, applyObjectStyle, autoTag, bringForward, bringToFront, changeGlyph, changeGrep, changeObject, changeText, changeTransliterate, clearObjectStyleOverrides, clearTransformations, convertShape, createOutlines, 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, sendBackward, sendToBack, store, subtractPath, toSource, toSpecifier, transform, transformValuesOf

Hierarchy

PageItem

TextFrame

Properties

Property	Type	Access	Description
absoluteFlip	Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	r/w	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	r/w	The horizontal scale of the TextFrame relative to its containing object.
absoluteRotationAngle	number	r/w	The rotation angle of the TextFrame relative to its containing object. (Range: -360 to 360)
absoluteShearAngle	number	r/w	The skewing angle of the TextFrame relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale	number	r/w	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	bool	r/w	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	r/w	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	r/w	The shape to apply to the bottom left corner of rectangular shapes.
bottomLeftCornerRadius	Measurement Unit (Number or String)	r/w	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	r/w	The shape to apply to the bottom right corner of rectangular shapes.
bottomRightCornerRadius	Measurement Unit (Number or String)	r/w	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.
contentTransparencySettings	ContentTransparencySetting	readonly	Transparency settings for the content of the TextFrame.
contentType	ContentType: ContentType.UNASSIGNED ContentType.GRAPHIC_TYPE ContentType.TEXT_TYPE	r/w	The type of content that a frame can contain.
contents	SpecialCharacters String TextFrameContents	r/w	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	r/w	The end shape of an open path.
endJoin	EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN	r/w	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	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the TextFrame. . Can also accept: String.
fillTint	number	r/w	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	r/w	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	r/w	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	r/w	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 Measurement Unit (Number or String)	r/w	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	r/w	The angle of a linear gradient applied to the fill of the TextFrame. (Range: -180 to 180)
gradientFillLength	Measurement Unit (Number or String)	r/w	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the TextFrame.
gradientFillStart	Array of Measurement Unit (Number or String)	r/w	The starting point (in page coordinates) of a gradient applied to the fill of the TextFrame, in the format [x, y].
gradientStrokeAngle	number	r/w	The angle of a linear gradient applied to the stroke of the TextFrame. (Range: -180 to 180)
gradientStrokeLength	Measurement Unit (Number or String)	r/w	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the TextFrame.
gradientStrokeStart	Array of Measurement Unit (Number or String)	r/w	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.
horizontalScale	number	r/w	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	bool	readonly	Returns true if the object specifier resolves to valid objects.
itemLayer	Layer	r/w	The layer that the TextFrame is on.
label	string	r/w	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	r/w	The arrowhead applied to the start of the path.
lines	Lines Line	readonly	A collection of lines.
locked	bool	r/w	If true, the TextFrame is locked.
miterLimit	number (range: 1 - 500)	r/w	The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4)
multiStateObjects	MultiStateObjects MultiStateObject	readonly	A collection of multi-state objects.
name	string	r/w	The name of the TextFrame.
nextTextFrame	NothingEnum TextFrame TextPath	r/w	The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
nonprinting	bool	r/w	If true, the TextFrame does not print.
notes	Notes Note	readonly	A collection of notes.
ovals	Ovals Oval	readonly	A collection of ellipses.
overflows	bool	readonly	If true, the story has overset text.
overprintFill	bool	r/w	If true, the TextFrame's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGap	bool	r/w	If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStroke	bool	r/w	If true, the TextFrame's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overridden	bool	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 GraphicLine Group MasterSpread Oval PlaceGun Polygon Rectangle Snippet SplineItem Spread State	readonly	The parent of the TextFrame (a Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character, PlaceGun or Snippet).
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 TextFrame TextPath	r/w	The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
properties	Object	r/w	A property that allows setting of several properties at the same time.
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	r/w	The arrowhead applied to the end of the path.
rotationAngle	number	r/w	The rotatation angle of the TextFrame. (Range: -360 to 360)
shearAngle	number	r/w	The skewing angle applied to the TextFrame. (Range: -360 to 360)
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	r/w	The stroke alignment applied to the TextFrame.
strokeColor	String Swatch	r/w	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	r/w	The corner adjustment applied to the TextFrame.
strokeDashAndGap	Array of Measurement Unit (Number or String)	r/w	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	r/w	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	String StrokeStyle	r/w	The name of the stroke style to apply. Can also accept: String.
strokeWeight	Measurement Unit (Number or String)	r/w	The weight (in points) to apply to the TextFrame's stroke.
tables	Tables Table	readonly	A collection of tables.
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	r/w	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	Measurement Unit (Number or String)	r/w	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	r/w	The shape to apply to the top right corner of rectangular shapes
topRightCornerRadius	Measurement Unit (Number or String)	r/w	The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
transparencySettings	TransparencySetting	readonly	Transparency settings.
verticalScale	number	r/w	The vertical scaling applied to the TextFrame.
visible	bool	r/w	If true, the TextFrame is visible.
visibleBounds	Array of Measurement Unit (Number or String)	r/w	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.

Class

Property	Type	Access	Description
AFTER_PLACE	string	readonly	Dispatched after a TextFrame is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
BEFORE_PLACE	string	readonly	Dispatched before a TextFrame is placed. This event bubbles. This event is cancelable. (default: beforePlace)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	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.

void applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
Applies the specified object style.

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

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

void bringForward ()
Brings the TextFrame forward one level in its layer.

void 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)

Array of Text changeGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeGrep ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of PageItem changeObject ([reverseOrder: bool])
Finds objects that match the find what value and replace the objects with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeText ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value and replaces the text with the change character type value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void clearObjectStyleOverrides ()
Clear overrides for object style

void clearTransformations ()
Clears transformations from the TextFrame. Transformations include rotation, scaling, flipping, fitting, and shearing.

void convertShape (given: ConvertShapeOptions[, numberOfSides: number][, insetPercentage: number][, cornerRadius: Measurement Unit (Number or 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	Measurement Unit (Number or String) (range: 0 - 800)	The corner radius of the resulting rectangle. (Optional)

Array of PageItem createOutlines ([deleteOriginal: bool=true])
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	bool	If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true)

void detach ()
Detaches an overridden master page item from the master page.

PageItem duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])
Duplicates the TextFrame at the specified location or offset.

Parameter	Type	Description
to	Array of 2 Units Layer Page Spread	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 Measurement Unit (Number or 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.

void exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])
Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat String	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.
using	PDFExportPreset	The export style. (Optional)
versionComments	string	The comment for this version. (Optional)
forceSave	bool	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.

Array of Text findGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findGrep ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of PageItem findObject ([reverseOrder: bool])
Finds objects that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findText ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void 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.

void 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	AnchorPoint Array of 2 Units	The point around which to flip the TextFrame. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Array of TextFrame getElements ()
Resolves the object specifier, creating an array of object references.

void 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.

void 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.

void move ([to: varies][, by: Array of Measurement Unit (Number or 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 Layer Page Spread	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 Measurement Unit (Number or String)	The amount (in measurement units) to move the TextFrame relative to its current position, in the format (x, y). (Optional)

any 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.

Array of any place (fileName: File[, withProperties: Object])
Places a file

Parameter	Type	Description
fileName	File	The file to place
withProperties	Object	Initial values for properties of the placed object(s) (Optional)

Story placeAndLink (parentStory: Story[, showingOptions: bool=false])
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	bool	Whether to display the link options dialog (Optional) (default: false)

void 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.

void recompose ()
Recomposes the text in the TextFrame.

void 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)

void reframe (in: varies, opposingCorners: Array of varies)
Move the bounding box of the page item

Parameter	Type	Description
in	boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces	The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
opposingCorners	Array of any	Opposing corners of new bounding box in the given coordinate space

Array of PageItem releaseCompoundPath ()
Releases a compound path.

void remove ()
Deletes the TextFrame.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

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

void removeOverride ()
Removes the override from a previously overridden master page item.

void resize (in: varies, from: varies, by: ResizeMethods, values: Array of varies[, resizeIndividually: bool=true][, consideringRulerUnits: bool=false])
Resize the page item.

Parameter	Type	Description
in	BoundingBoxLimits boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces	The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
from	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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 : Array of Reals CoordinateSpaces ResizeConstraints	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	bool	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	bool	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)

any resolve (location: varies, in: CoordinateSpaces[, consideringRulerUnits: bool=false])
Get the coordinates of the given location in the specified coordinate system.

Parameter	Type	Description
location	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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.SPREAD_COORDINATES	The coordinate space to use.
consideringRulerUnits	bool	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)

void sendBackward ()
Sends the TextFrame back one level in its layer.

void 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.

void transform (in: CoordinateSpaces, from: varies, withMatrix: varies[, replacingCurrent: varies][, consideringRulerUnits: bool=false])
Transform the page item.

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use
from	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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 TransformationMatrix	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent	Array of MatrixContent Long Integer MatrixContent	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	bool	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)

Array of TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use