Class: TextFrame | K4 InDesign Javascript API Documentation

A text frame.

Extends

PageItem

Static Properties

Name	Description
AFTER_PLACE = "afterPlace"	string Dispatched after a TextFrame is placed. This event bubbles. This event is not cancelable.
BEFORE_PLACE = "beforePlace"	string Dispatched before a TextFrame is placed. This event bubbles. This event is cancelable.

Instance Properties

Name	Description	Access
absoluteFlip	Flip 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
absoluteHorizontalScale	number The horizontal scale of the TextFrame relative to its containing object.	read-write
absoluteRotationAngle	number The rotation angle of the TextFrame relative to its containing object. (Range: -360 to 360)	read-write
absoluteShearAngle	number The skewing angle of the TextFrame relative to its containing object. (Range: -360 to 360)	read-write
absoluteVerticalScale	number The vertical scale of the TextFrame relative to its containing object.	read-write
allArticles	Article The list of all articles this page item is part of	read-only
allGraphics	Graphic Lists all graphics contained by the TextFrame.	read-only
allPageItems	PageItem Lists all page items contained by the TextFrame.	read-only
allowOverrides	bool If true, the master page item can be overridden.	read-write
anchoredObjectSettings	AnchoredObjectSetting Anchored object settings.	read-only
animationSettings	AnimationSetting The page item animation settings.	read-only
appliedObjectStyle	ObjectStyle The object style applied to the TextFrame.	read-write
arrowHeadAlignment	ArrowHeadAlignmentEnum The arrowhead alignment applied to the TextFrame.	read-write
associatedXMLElement	XMLItem The XML element associated with the TextFrame.	read-only
baselineFrameGridOptions	BaselineFrameGridOption Baseline frame grid option settings.	read-only
bottomLeftCornerOption	CornerOptions The shape to apply to the bottom left corner of rectangular shapes.	read-write
bottomLeftCornerRadius	Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes	read-write
bottomRightCornerOption	CornerOptions The shape to apply to the bottom right corner of rectangular shapes.	read-write
bottomRightCornerRadius	Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes	read-write
buttons	Buttons A collection of buttons.	read-only
characters	Characters A collection of characters.	read-only
checkBoxes	CheckBoxes A collection of checkboxes.	read-only
comboBoxes	ComboBoxes A collection of comboboxes.	read-only
contentTransparencySettings	ContentTransparencySetting Transparency settings for the content of the TextFrame.	read-only
contentType	ContentType The type of content that a frame can contain.	read-write
contents	The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator.	read-write
endCap	EndCap The end shape of an open path.	read-write
endJoin	EndJoin The corner join applied to the TextFrame.	read-write
endTextFrame	The last text frame in the thread. Can return: TextFrame or TextPath.	read-only
endnoteTextFrames	EndnoteTextFrames A collection of endnote text frames.	read-only
epstexts	EPSTexts EPSTexts	read-only
eventListeners	EventListeners A collection of event listeners.	read-only
events	Events A collection of events.	read-only
fillColor	Swatch The swatch (color, gradient, tint, or mixed ink) applied to the fill of the TextFrame. . Can also accept: String.	read-write
fillTint	number 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.)	read-write
fillTransparencySettings	FillTransparencySetting Transparency settings for the fill applied to the TextFrame.	read-only
flip	Flip The direction in which to flip the printed image.	read-write
footnotes	Footnotes A collection of footnotes.	read-only
formFields	FormFields A collection of form fields.	read-only
gapColor	Swatch The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.	read-write
gapTint	number 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
geometricBounds	Measurement Unit (Number or String)=any 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
gradientFillAngle	number The angle of a linear gradient applied to the fill of the TextFrame. (Range: -180 to 180)	read-write
gradientFillLength	Measurement Unit (Number or String)=any The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the TextFrame.	read-write
gradientFillStart	Measurement Unit (Number or String)=any The starting point (in page coordinates) of a gradient applied to the fill of the TextFrame, in the format [x, y].	read-write
gradientStrokeAngle	number The angle of a linear gradient applied to the stroke of the TextFrame. (Range: -180 to 180)	read-write
gradientStrokeLength	Measurement Unit (Number or String)=any The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the TextFrame.	read-write
gradientStrokeStart	Measurement Unit (Number or String)=any The starting point (in page coordinates) of a gradient applied to the stroke of the TextFrame, in the format [x, y].	read-write
graphicLines	GraphicLines A collection of graphic lines.	read-only
gridData	GridDataInformation Default grid properties. Note: Applies to named, layout, and frame (story) grids.	read-only
groups	Groups A collection of groups.	read-only
hiddenTexts	HiddenTexts A collection of hidden text objects.	read-only
horizontalLayoutConstraints	DimensionsConstraints The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule.	read-write
horizontalScale	number The horizontal scaling applied to the TextFrame.	read-write
id	number The unique ID of the TextFrame.	read-only
index	number The index of the TextFrame within its containing object.	read-only
insertionPoints	InsertionPoints A collection of insertion points.	read-only
isValid	bool Returns true if the object specifier resolves to valid objects.	read-only
itemLayer	Layer The layer that the TextFrame is on.	read-write
k4FileVersionIndex	number K4 File Version Index	read-only
k4Id	string K4 Server ID	read-only
k4Name	string K4 Name	read-only
k4ObjectLabel	string K4 Object Label	read-only
k4ObjectState	K4ObjectState K4 Object State	read-only
k4ObjectType	K4ObjectType K4 Object Type	read-only
k4OutputChannelName	string K4 Output Channel Name	read-only
k4Position	number K4 position	read-only
k4PublicationId	string K4 Publication ID	read-only
k4VariantId	string K4 Variant ID	read-only
k4WfChannelId	string K4 Workflow Channel ID	read-only
k4WfDefinitionId	string K4 Workflow Definition ID	read-only
k4WfName	string K4 Workflow Name	read-only
k4WfObjectType	K4WfObjectType K4 Workflow Object Type	read-only
k4WfObjectVariantId	string K4 Workflow Object Variant ID	read-only
label	string A property that can be set to any string.	read-write
leftArrowHeadScale	number The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000)	read-write
leftLineEnd	ArrowHead The arrowhead applied to the start of the path.	read-write
lines	Lines A collection of lines.	read-only
linkedPageItemOptions	LinkedPageItemOption Linked Page Item options	read-only
listBoxes	ListBoxes A collection of listboxes.	read-only
localDisplaySetting	DisplaySettingOptions Display performance options for the TextFrame.	read-write
locked	bool If true, the TextFrame is locked.	read-write
miterLimit = 4	number The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.	read-write
multiStateObjects	MultiStateObjects A collection of multi-state objects.	read-only
name	string The name of the TextFrame.	read-write
nextTextFrame	The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.	read-write
nonprinting	bool If true, the TextFrame does not print.	read-write
notes	Notes A collection of notes.	read-only
objectExportOptions	ObjectExportOption Export options for the object	read-only
ovals	Ovals A collection of ellipses.	read-only
overflows	bool If true, the story has overset text.	read-only
overprintFill	bool If true, the TextFrame's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.	read-write
overprintGap	bool If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.	read-write
overprintStroke	bool If true, the TextFrame's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.	read-write
overridden	bool 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.	read-only
overriddenMasterPageItem	An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.	read-only
pageItems	PageItems 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.	read-only
paragraphs	Paragraphs A collection of paragraphs.	read-only
parent	The parent of the TextFrame (a ComboBox, ListBox, TextBox, SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Cell, Character, PlaceGun or Snippet).	read-only
parentPage	Page The page on which this page item appears.	read-only
parentStory	Story The story that contains the text.	read-only
paths	Paths A collection of paths.	read-only
polygons	Polygons A collection of polygons.	read-only
preferences	Preferences A collection of preferences objects.	read-only
previousTextFrame	The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.	read-write
properties	Object A property that allows setting of several properties at the same time.	read-write
radioButtons	RadioButtons A collection of radio buttons.	read-only
rectangles	Rectangles A collection of rectangles.	read-only
rightArrowHeadScale	number The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000)	read-write
rightLineEnd	ArrowHead The arrowhead applied to the end of the path.	read-write
rotationAngle	number The rotatation angle of the TextFrame. (Range: -360 to 360)	read-write
shearAngle	number The skewing angle applied to the TextFrame. (Range: -360 to 360)	read-write
signatureFields	SignatureFields A collection of signature fields.	read-only
splineItems	SplineItems The spline items collection.	read-only
startTextFrame	The first text frame in the thread. Can return: TextFrame or TextPath.	read-only
strokeAlignment	StrokeAlignment The stroke alignment applied to the TextFrame.	read-write
strokeColor	Swatch The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the TextFrame. Can also accept: String.	read-write
strokeCornerAdjustment	StrokeCornerAdjustment The corner adjustment applied to the TextFrame.	read-write
strokeDashAndGap	Measurement Unit (Number or String)=any 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].	read-write
strokeTint	number 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.)	read-write
strokeTransparencySettings	StrokeTransparencySetting Transparency settings for the stroke.	read-only
strokeType	StrokeStyle The name of the stroke style to apply. Can also accept: String.	read-write
strokeWeight	Measurement Unit (Number or String)=any The weight (in points) to apply to the TextFrame's stroke.	read-write
tables	Tables A collection of tables.	read-only
textBoxes	TextBoxes A collection of text boxes.	read-only
textColumns	TextColumns A collection of text columns.	read-only
textFrameFootnoteOptions	TextFrameFootnoteOptionsObject Text frame footnote options settings.	read-only
textFrameIndex	number The index of the text frame within the story.	read-only
textFramePreferences	TextFramePreference Text frame preference settings.	read-only
textFrames	TextFrames A collection of text frames.	read-only
textPaths	TextPaths A collection of text paths.	read-only
textStyleRanges	TextStyleRanges A collection of text style ranges.	read-only
textVariableInstances	TextVariableInstances A collection of text variable instances.	read-only
textWrapPreferences	TextWrapPreference The text wrap preference properties that define the default formatting for wrapping text around objects.	read-only
texts	Texts A collection of text objects.	read-only
timingSettings	TimingSetting The object timing settings.	read-only
topLeftCornerOption	CornerOptions 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
topLeftCornerRadius	Measurement Unit (Number or String)=any 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
topRightCornerOption	CornerOptions The shape to apply to the top right corner of rectangular shapes	read-write
topRightCornerRadius	Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes	read-write
transparencySettings	TransparencySetting Transparency settings.	read-only
verticalLayoutConstraints	DimensionsConstraints The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule.	read-write
verticalScale	number The vertical scaling applied to the TextFrame.	read-write
visible	bool If true, the TextFrame is visible.	read-write
visibleBounds	Measurement Unit (Number or String)=any 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.	read-write
words	Words A collection of words.	read-only

Methods

addEventListener(

eventType, handler [, captures])

→ EventListener

addPath(

with)

→ PageItem

applyObjectStyle(

using [, clearingOverrides] [, clearingOverridesThroughRootObjectStyle])

asynchronousExportFile(

format, to [, showingOptions] [, using] [, versionComments] [, forceSave])

→ BackgroundTask

)

)

[reference])

[reverseOrder])

→ Text

changeGrep(

[reverseOrder])

→ Text

changeObject(

[reverseOrder])

→ PageItem

changeText(

[reverseOrder])

→ Text

changeTransliterate(

[reverseOrder])

→ Text

clearObjectStyleOverrides(

)

clearTransformations(

)

contentPlace(

pageItems [, linkPageItems] [, linkStories] [, mapStyles] [, showingOptions])

convertShape(

given [, numberOfSides] [, insetPercentage] [, cornerRadius])

convertToRawText(

)

createEmailQRCode(

[emailAddress] [, subject] [, body], qrCodeSwatch [, withProperties])

createHyperlinkQRCode(

[urlLink], qrCodeSwatch [, withProperties])

createOutlines(

[deleteOriginal])

→ PageItem

createPlainTextQRCode(

[plainText], qrCodeSwatch [, withProperties])

createTextMsgQRCode(

[cellNumber] [, textMessage], qrCodeSwatch [, withProperties])

createVCardQRCode(

[firstName] [, lastName] [, jobTitle] [, cellPhone] [, phone] [, email] [, organisation] [, streetAddress] [, city] [, adrState] [, country] [, postalCode] [, website], qrCodeSwatch [, withProperties])

detach(

)

duplicate(

to [, by])

→ PageItem

excludeOverlapPath(

with)

→ PageItem

exportFile(

format, to [, showingOptions] [, using] [, versionComments] [, forceSave])

extractLabel(

key)

→ string

findGlyph(

[reverseOrder])

→ Text

findGrep(

[reverseOrder])

→ Text

findObject(

[reverseOrder])

→ PageItem

findText(

[reverseOrder])

→ Text

findTransliterate(

[reverseOrder])

→ Text

fit(

given)

flipItem(

given, around)

getElements(

)

→ TextFrame

insertLabel(

key, value)

intersectPath(

with)

→ PageItem

k4GetArticle(

)

→ K4Article

k4GetDocument(

)

→ Document

k4GetServerData(

)

→ K4ServerData

k4Place(

k4PublicationId, k4WFObjectVariantId)

k4SwitchVariant(

k4Id)

k4Update(

)

makeCompoundPath(

with)

→ PageItem

markup(

using)

minusBack(

with)

→ PageItem

move(

to [, by])

override(

destinationPage)

place(

fileName [, showingOptions] [, withProperties])

placeAndLink(

parentStory [, showingOptions])

→ Story

using)

)

[to])

in, opposingCorners)

)

→ PageItem

remove(

)

removeEventListener(

eventType, handler [, captures])

→ bool

removeOverride(

)

resize(

in, from, by, values [, resizeIndividually] [, consideringRulerUnits])

resolve(

location, in [, consideringRulerUnits])

[existingSelection])

)

[reference])

using [, withProperties])

→ Asset

subtractPath(

with)

→ PageItem

toSource(

)

→ string

toSpecifier(

)

→ string

transform(

in, from, withMatrix, replacingCurrent [, consideringRulerUnits])

transformAgain(

)

→ string

transformAgainIndividually(

)

→ string

transformSequenceAgain(

)

→ string

transformSequenceAgainIndividually(

)

→ string

transformValuesOf(

in)

→ TransformationMatrix

addEventListener( eventType, handler [, captures=false]) → EventListener

Adds an event listener.

`eventType`	string The event type.
`handler`	The event handler. Can accept: File or JavaScript Function.
`captures`	bool This parameter is obsolete. (Optional)

addPath( with) → PageItem

Creates a new page item by combining the TextFrame with other objects. Deletes the objects if they do not intersect.

with Array<PageItem> The object(s) to add.

applyObjectStyle( using [, clearingOverrides=true] [, clearingOverridesThroughRootObjectStyle=false])

Applies the specified object style.

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

asynchronousExportFile( format, to [, showingOptions=false] [, using] [, versionComments] [, forceSave=false]) → BackgroundTask

asynchronously exports the object(s) to a file.

`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`	File The path to the export file.
`showingOptions`	bool If true, displays the export options dialog. (Optional)
`using`	PDFExportPreset The export style. (Optional)
`versionComments`	string The comment for this version. (Optional)
`forceSave`	bool If true, forcibly saves a version. (Optional)

autoTag( )

Tag the object or the parent story using default tags defined in XML preference.

bringForward( )

Brings the TextFrame forward one level in its layer.

bringToFront( [reference])

Brings the TextFrame to the front of its layer or in front of a particular item.

reference PageItem The reference object to bring the object in front of (must have same parent) (Optional)

changeGlyph( [reverseOrder]) → Text

Finds glyphs that match the find what value and replaces the glyphs with the change to value.

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

changeGrep( [reverseOrder]) → Text

Finds text that matches the find what value and replaces the text with the change to value.

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

changeObject( [reverseOrder]) → PageItem

Finds objects that match the find what value and replace the objects with the change to value.

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

changeText( [reverseOrder]) → Text

Finds text that matches the find what value and replaces the text with the change to value.

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

changeTransliterate( [reverseOrder]) → Text

Finds text that matches the find character type value and replaces the text with the change character type value.

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

clearObjectStyleOverrides( )

Clear overrides for object style

clearTransformations( )

Clears transformations from the TextFrame. Transformations include rotation, scaling, flipping, fitting, and shearing.

contentPlace( pageItems [, linkPageItems=false] [, linkStories=false] [, mapStyles=false] [, showingOptions=false])

Duplicate an object and place it into the target page item.

`pageItems`	Array<PageItem> One or more page items to place or load
`linkPageItems`	bool Whether to link pageItems in content placer (if true it will override link stories value) (Optional)
`linkStories`	bool 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)
`mapStyles`	bool Whether to map styles in content placer (Optional)
`showingOptions`	bool Whether to display the link options dialog (Optional)

convertShape( given [, numberOfSides] [, insetPercentage] [, cornerRadius])

Converts the TextFrame to a different shape.

`given`	ConvertShapeOptions The TextFrame's new shape.
`numberOfSides`	number The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
`insetPercentage`	number The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
`cornerRadius`	Measurement Unit (Number or String)=any The corner radius of the resulting rectangle. (Optional)

convertToRawText( )

Convert the text frame contents to raw text

createEmailQRCode( [emailAddress] [, subject] [, body], qrCodeSwatch [, withProperties])

Create Email QR Code on the page item or document

`emailAddress`	string QR code Email Address (Optional)
`subject`	string QR code Email Subject (Optional)
`body`	string QR code Email Body Message (Optional)
`qrCodeSwatch`	Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
`withProperties`	Array<string> Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional)

createHyperlinkQRCode( [urlLink], qrCodeSwatch [, withProperties])

Create Hyperlink QR Code on the page item or document

`urlLink`	string QR code Hyperlink URL (Optional)
`qrCodeSwatch`	Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
`withProperties`	Array<string> Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional)

createOutlines( [deleteOriginal=true]) → PageItem

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.

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

createPlainTextQRCode( [plainText], qrCodeSwatch [, withProperties])

Create Plain Text QR Code on the page item

`plainText`	string QR code Plain Text (Optional)
`qrCodeSwatch`	Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
`withProperties`	Array<string> Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional)

createTextMsgQRCode( [cellNumber] [, textMessage], qrCodeSwatch [, withProperties])

Create Text Msg QR Code on the page item or document

`cellNumber`	string QR code Text Phone Number (Optional)
`textMessage`	string QR code Text Message (Optional)
`qrCodeSwatch`	Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
`withProperties`	Array<string> Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional)

createVCardQRCode( [firstName] [, lastName] [, jobTitle] [, cellPhone] [, phone] [, email] [, organisation] [, streetAddress] [, city] [, adrState] [, country] [, postalCode] [, website], qrCodeSwatch [, withProperties])

Create Business Card QR Code on the page item or load on document's placegun

`firstName`	string QR code Business Card First Name (Optional)
`lastName`	string QR code Business Card Last Name (Optional)
`jobTitle`	string QR code Business Card Title (Optional)
`cellPhone`	string QR code Business Card Cell Phone Number (Optional)
`phone`	string QR code Business Card Phone Number (Optional)
`email`	string QR code Business Card Email Address (Optional)
`organisation`	string QR code Business Card Organisation (Optional)
`streetAddress`	string QR code Business Card Street Address (Optional)
`city`	string QR code Business Card City (Optional)
`adrState`	string QR code Business Card State (Optional)
`country`	string QR code Business Card Country (Optional)
`postalCode`	string QR code Business Card Postal Code (Optional)
`website`	string QR code Business Card URL (Optional)
`qrCodeSwatch`	Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
`withProperties`	Array<string> Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional)

detach( )

Detaches an overridden master page item from the master page.

duplicate( to [, by]) → PageItem

Duplicates the TextFrame at the specified location or offset.

`to`	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<Measurement Unit (Number or String)=any> Amount by which to offset the new TextFrame from the original TextFrame's position. (Optional)

excludeOverlapPath( with) → PageItem

Creates a new page item by excluding the overlapping areas of the TextFrame and other objects.

with Array<PageItem> The object(s) to exclude.

exportFile( format, to [, showingOptions=false] [, using] [, versionComments] [, forceSave=false])

Exports the object(s) to a file.

`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`	File The path to the export file.
`showingOptions`	bool If true, displays the export options dialog. (Optional)
`using`	PDFExportPreset The export style. (Optional)
`versionComments`	string The comment for this version. (Optional)
`forceSave`	bool If true, forcibly saves a version. (Optional)

extractLabel( key) → string

Gets the label value associated with the specified key.

key string The key.

findGlyph( [reverseOrder]) → Text

Finds glyphs that match the find what value.

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

findGrep( [reverseOrder]) → Text

Finds text that matches the find what value.

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

findObject( [reverseOrder]) → PageItem

Finds objects that match the find what value.

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

findText( [reverseOrder]) → Text

Finds text that matches the find what value.

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

findTransliterate( [reverseOrder]) → Text

Finds text that matches the find character type value.

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

fit( given)

Applies the specified fit option to content in a frame.

given FitOptions The fit option to use.

flipItem( given, around)

Flips the TextFrame.

`given`	Flip The axis around which to flip the TextFrame.
`around`	The point around which to flip the TextFrame. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

getElements( ) → TextFrame

Resolves the object specifier, creating an array of object references.

insertLabel( key, value)

Sets the label to the value associated with the specified key.

`key`	string The key.
`value`	string The value.

intersectPath( with) → PageItem

Creates a new page item by intersecting the TextFrame with other objects. Returns an error if the objects do not intersect.

with Array<PageItem> The object(s) with which to intersect.

k4GetArticle( ) → K4Article

K4 Get Article

k4GetDocument( ) → Document

K4 Get Document

k4GetServerData( ) → K4ServerData

K4 Get Server Data

k4Place( k4PublicationId, k4WFObjectVariantId)

K4 Place Object into

`k4PublicationId`	string K4 Publication DB ID
`k4WFObjectVariantId`	string K4 Workflow Object Variant DB ID

k4SwitchVariant( k4Id)

K4 Switch Variant

k4Id string K4 ID

k4Update( )

K4 Update

makeCompoundPath( with) → PageItem

Creates a compound path by combining the path(s) of the TextFrame with the paths of other objects.

with Array<PageItem> The other objects whose paths to include in the new compound path.

markup( using)

Associates the page item with the specified XML element while preserving existing content.

using XMLElement The XML element.

minusBack( with) → PageItem

Creates a new page item by reverse subtracting the overlapping areas of the TextFrame and other objects.

with Array<PageItem> The object(s) to reverse subtract.

move( to [, by])

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.

`to`	The new location of the TextFrame,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
`by`	Array<Measurement Unit (Number or String)=any> The amount (in measurement units) to move the TextFrame relative to its current position, in the format (x, y). (Optional)

override( destinationPage)

Overrides a master page item and places the item on the document page as a new object.

destinationPage Page The document page that contains the master page item to override.

place( fileName [, showingOptions=false] [, withProperties])

Places the file.

`fileName`	File The file to place
`showingOptions`	bool Whether to display the import options dialog (Optional)
`withProperties`	Object Initial values for properties of the placed object(s) (Optional)

placeAndLink( parentStory [, showingOptions=false]) → Story

Deprecated: Use contentPlace method. Original Description: Create a linked story and place it into the target page item.

`parentStory`	Story The story to place and link from.
`showingOptions`	bool Whether to display the link options dialog (Optional)

placeXML( using)

Places XML content into the specified object. Note: Replaces any existing content.

using XMLElement The XML element whose content you want to place.

recompose( )

Recomposes the text in the TextFrame.

redefineScaling( [to])

Apply an item's scaling to its content if possible.

`to`	Array<number> The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

reframe( in, opposingCorners)

Move the bounding box of the page item

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

releaseCompoundPath( ) → PageItem

Releases a compound path.

remove( )

Deletes the TextFrame.

removeEventListener( eventType, handler [, captures=false]) → bool

Removes the event listener.

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

removeOverride( )

Removes the override from a previously overridden master page item.

resize( in, from, by, values [, resizeIndividually=true] [, consideringRulerUnits=false])

Resize the page item.

`in`	The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
`from`	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 How the current dimensions are affected by the given values
`values`	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)
`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)

resolve( location, in [, consideringRulerUnits=false])

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

`location`	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 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)

select( [existingSelection=SelectionOptions.REPLACE_WITH])

Selects the object.

existingSelection SelectionOptions The selection status of the TextFrame in relation to previously selected objects. (Optional)

sendBackward( )

Sends the TextFrame back one level in its layer.

sendToBack( [reference])

Sends the TextFrame to the back of its layer or behind a particular item (must have same parent).

reference PageItem The reference object to send the object behind (Optional)

store( using [, withProperties]) → Asset

Stores the object in the specified library.

`using`	Library The library in which to store the object.
`withProperties`	Object Initial values for properties of the new TextFrame (Optional)

subtractPath( with) → PageItem

Creates a new page item by subtracting the overlapping areas of the TextFrame and other objects.

with Array<PageItem> The object(s) to subtract.

toSource( ) → string

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

toSpecifier( ) → string

Retrieves the object specifier.

transform( in, from, withMatrix, replacingCurrent [, consideringRulerUnits=false])

Transform the page item.

`in`	CoordinateSpaces The coordinate space to use
`from`	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`	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
`replacingCurrent`	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)

transformAgain( ) → string

Transforms the TextFrame using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

transformAgainIndividually( ) → string

Transforms the TextFrame using the last transformation performed on any TextFrame. Transformations include moving, rotating, shearing, scaling, and flipping.

transformSequenceAgain( ) → string

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.

transformSequenceAgainIndividually( ) → string

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.

transformValuesOf( in) → TransformationMatrix

Get the transformation values of the page item.

`in`	CoordinateSpaces The coordinate space to use