Class

TextFrame

 A text frame. Base Class: PageItem

QuickLinks

addEventListener, addPath, applyObjectStyle, asynchronousExportFile, autoTag, bringForward, bringToFront, changeGlyph, changeGrep, changeObject, changeText, changeTransliterate, clearObjectStyleOverrides, clearTransformations, contentPlace, 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, select, sendBackward, sendToBack, store, subtractPath, toSource, toSpecifier, transform, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually, transformValuesOf

Hierarchy

Character | ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | Snippet | SplineItem | Spread | State | TextBox
PageItem
TextFrame
AnchoredObjectSetting | AnimationSetting | BaselineFrameGridOption | Character | ContentTransparencySetting | Event | EventListener | FillTransparencySetting | Footnote | GridDataInformation | HiddenText | InsertionPoint | Line | LinkedPageItemOption | MutationEvent | Note | ObjectExportOption | Paragraph | Path | Preference | StrokeTransparencySetting | Table | Text | TextColumn | TextFramePreference | TextPath | TextStyleRange | TextVariableInstance | TextWrapPreference | TimingSetting | TransparencySetting | Word

Properties

PropertyTypeAccessDescription
absoluteFlipFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
r/wIndicates whether the TextFrame has been flipped independently of its parent object and, if yes, the direction in which the TextFrame was flipped.
absoluteHorizontalScalenumber r/wThe horizontal scale of the TextFrame relative to its containing object.
absoluteRotationAnglenumber r/wThe rotation angle of the TextFrame relative to its containing object. (Range: -360 to 360)
absoluteShearAnglenumber r/wThe skewing angle of the TextFrame relative to its containing object. (Range: -360 to 360)
absoluteVerticalScalenumber r/wThe vertical scale of the TextFrame relative to its containing object.
allArticlesArray of Article readonlyThe list of all articles this page item is part of
allGraphicsArray of Graphic readonlyLists all graphics contained by the TextFrame.
allPageItemsArray of PageItem readonlyLists all page items contained by the TextFrame.
allowOverridesbool r/wIf true, the master page item can be overridden.
anchoredObjectSettingsAnchoredObjectSetting readonlyAnchored object settings.
animationSettingsAnimationSetting readonlyThe page item animation settings.
appliedObjectStyleObjectStyle r/wThe object style applied to the TextFrame.
associatedXMLElementXMLItem readonlyThe XML element associated with the TextFrame.
baselineFrameGridOptionsBaselineFrameGridOption readonlyBaseline frame grid option settings.
bottomLeftCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe shape to apply to the bottom left corner of rectangular shapes.
bottomLeftCornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
bottomRightCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe shape to apply to the bottom right corner of rectangular shapes.
bottomRightCornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
buttonsButtons readonlyA collection of buttons.
charactersCharacters readonlyA collection of characters.
checkBoxesCheckBoxes readonlyA collection of checkboxes.
comboBoxesComboBoxes readonlyA collection of comboboxes.
contentTransparencySettingsContentTransparencySetting readonlyTransparency settings for the content of the TextFrame.
contentTypeContentType:
ContentType.UNASSIGNED
ContentType.GRAPHIC_TYPE
ContentType.TEXT_TYPE
r/wThe type of content that a frame can contain.
contentsSpecialCharacters
String
TextFrameContents
r/wThe contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator.
endCapEndCap:
EndCap.BUTT_END_CAP
EndCap.ROUND_END_CAP
EndCap.PROJECTING_END_CAP
r/wThe end shape of an open path.
endJoinEndJoin:
EndJoin.MITER_END_JOIN
EndJoin.ROUND_END_JOIN
EndJoin.BEVEL_END_JOIN
r/wThe corner join applied to the TextFrame.
endTextFrameTextFrame
TextPath
readonlyThe last text frame in the thread. Can return: TextFrame or TextPath.
epstextsEPSTexts readonlyEPSTexts
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the TextFrame. . Can also accept: String.
fillTintnumber r/wThe 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.)
fillTransparencySettingsFillTransparencySetting readonlyTransparency settings for the fill applied to the TextFrame.
flipFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
r/wThe direction in which to flip the printed image.
footnotesFootnotes readonlyA collection of footnotes.
formFieldsFormFields readonlyA collection of form fields.
gapColorSwatch r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTintnumber r/wThe 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.)
geometricBoundsArray of Measurement Unit (Number or String) r/wThe 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.
gradientFillAnglenumber r/wThe angle of a linear gradient applied to the fill of the TextFrame. (Range: -180 to 180)
gradientFillLengthMeasurement Unit (Number or String) r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the TextFrame.
gradientFillStartArray of Measurement Unit (Number or String) r/wThe starting point (in page coordinates) of a gradient applied to the fill of the TextFrame, in the format [x, y].
gradientStrokeAnglenumber r/wThe angle of a linear gradient applied to the stroke of the TextFrame. (Range: -180 to 180)
gradientStrokeLengthMeasurement Unit (Number or String) r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the TextFrame.
gradientStrokeStartArray of Measurement Unit (Number or String) r/wThe starting point (in page coordinates) of a gradient applied to the stroke of the TextFrame, in the format [x, y].
graphicLinesGraphicLines readonlyA collection of graphic lines.
gridDataGridDataInformation readonlyDefault grid properties. Note: Applies to named, layout, and frame (story) grids.
groupsGroups readonlyA collection of groups.
hiddenTextsHiddenTexts readonlyA collection of hidden text objects.
horizontalLayoutConstraintsArray of DimensionsConstraints:
DimensionsConstraints.FIXED_DIMENSION
DimensionsConstraints.FLEXIBLE_DIMENSION
r/wThe left margin, width, and right margin constraints this item is subject to when using the object-based layout rule.
horizontalScalenumber r/wThe horizontal scaling applied to the TextFrame.
idnumber readonlyThe unique ID of the TextFrame.
indexnumber readonlyThe index of the TextFrame within its containing object.
insertionPointsInsertionPoints readonlyA collection of insertion points.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
itemLayerLayer r/wThe layer that the TextFrame is on.
labelstring r/wA property that can be set to any string.
leftLineEndArrowHead:
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/wThe arrowhead applied to the start of the path.
linesLines readonlyA collection of lines.
linkedPageItemOptionsLinkedPageItemOption readonlyLinked Page Item options
listBoxesListBoxes readonlyA collection of listboxes.
localDisplaySettingDisplaySettingOptions:
DisplaySettingOptions.HIGH_QUALITY
DisplaySettingOptions.TYPICAL
DisplaySettingOptions.OPTIMIZED
DisplaySettingOptions.DEFAULT_VALUE
r/wDisplay performance options for the TextFrame.
lockedbool r/wIf true, the TextFrame is locked.
miterLimitnumber (range: 1 - 500) r/wThe limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4)
multiStateObjectsMultiStateObjects readonlyA collection of multi-state objects.
namestring r/wThe name of the TextFrame.
nextTextFrameNothingEnum
TextFrame
TextPath
r/wThe next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
nonprintingbool r/wIf true, the TextFrame does not print.
notesNotes readonlyA collection of notes.
objectExportOptionsObjectExportOption readonlyExport options for the object
ovalsOvals readonlyA collection of ellipses.
overflowsbool readonlyIf true, the story has overset text.
overprintFillbool r/wIf true, the TextFrame's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGapbool r/wIf true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStrokebool r/wIf true, the TextFrame's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overriddenbool readonlyIf 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.
overriddenMasterPageItemGraphic
Guide
Movie
PageItem
Sound
readonlyAn object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
pageItemsPageItems readonlyThe 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.
paragraphsParagraphs readonlyA collection of paragraphs.
parentCharacter
ComboBox
GraphicLine
Group
ListBox
MasterSpread
Oval
PlaceGun
Polygon
Rectangle
SignatureField
Snippet
SplineItem
Spread
State
TextBox
readonlyThe parent of the TextFrame (a ComboBox, ListBox, TextBox, SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character, PlaceGun or Snippet).
parentPagePage readonlyThe page on which this page item appears.
parentStoryStory readonlyThe story that contains the text.
pathsPaths readonlyA collection of paths.
polygonsPolygons readonlyA collection of polygons.
preferencesPreferences readonlyA collection of preferences objects.
previousTextFrameNothingEnum
TextFrame
TextPath
r/wThe previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
propertiesObject r/wA property that allows setting of several properties at the same time.
radioButtonsRadioButtons readonlyA collection of radio buttons.
rectanglesRectangles readonlyA collection of rectangles.
rightLineEndArrowHead:
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/wThe arrowhead applied to the end of the path.
rotationAnglenumber r/wThe rotatation angle of the TextFrame. (Range: -360 to 360)
shearAnglenumber r/wThe skewing angle applied to the TextFrame. (Range: -360 to 360)
signatureFieldsSignatureFields readonlyA collection of signature fields.
splineItemsSplineItems readonlyThe spline items collection.
startTextFrameTextFrame
TextPath
readonlyThe first text frame in the thread. Can return: TextFrame or TextPath.
strokeAlignmentStrokeAlignment:
StrokeAlignment.CENTER_ALIGNMENT
StrokeAlignment.INSIDE_ALIGNMENT
StrokeAlignment.OUTSIDE_ALIGNMENT
r/wThe stroke alignment applied to the TextFrame.
strokeColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the TextFrame. Can also accept: String.
strokeCornerAdjustmentStrokeCornerAdjustment:
StrokeCornerAdjustment.NONE
StrokeCornerAdjustment.DASHES
StrokeCornerAdjustment.GAPS
StrokeCornerAdjustment.DASHES_AND_GAPS
r/wThe corner adjustment applied to the TextFrame.
strokeDashAndGapArray of Measurement Unit (Number or String) r/wThe 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].
strokeTintnumber r/wThe 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.)
strokeTransparencySettingsStrokeTransparencySetting readonlyTransparency settings for the stroke.
strokeTypeString
StrokeStyle
r/wThe name of the stroke style to apply. Can also accept: String.
strokeWeightMeasurement Unit (Number or String) r/wThe weight (in points) to apply to the TextFrame's stroke.
tablesTables readonlyA collection of tables.
textBoxesTextBoxes readonlyA collection of text boxes.
textColumnsTextColumns readonlyA collection of text columns.
textFrameIndexnumber readonlyThe index of the text frame within the story.
textFramePreferencesTextFramePreference readonlyText frame preference settings.
textFramesTextFrames readonlyA collection of text frames.
textPathsTextPaths readonlyA collection of text paths.
textStyleRangesTextStyleRanges readonlyA collection of text style ranges.
textVariableInstancesTextVariableInstances readonlyA collection of text variable instances.
textWrapPreferencesTextWrapPreference readonlyThe text wrap preference properties that define the default formatting for wrapping text around objects.
textsTexts readonlyA collection of text objects.
timingSettingsTimingSetting readonlyThe object timing settings.
topLeftCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe 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.
topLeftCornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
topRightCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe shape to apply to the top right corner of rectangular shapes
topRightCornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
transparencySettingsTransparencySetting readonlyTransparency settings.
verticalLayoutConstraintsArray of DimensionsConstraints:
DimensionsConstraints.FIXED_DIMENSION
DimensionsConstraints.FLEXIBLE_DIMENSION
r/wThe top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule.
verticalScalenumber r/wThe vertical scaling applied to the TextFrame.
visiblebool r/wIf true, the TextFrame is visible.
visibleBoundsArray of Measurement Unit (Number or String) r/wThe 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.
wordsWords readonlyA collection of words.

Class

PropertyTypeAccessDescription
AFTER_PLACEstring readonlyDispatched after a TextFrame is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
BEFORE_PLACEstring readonlyDispatched 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
withArray of PageItemThe object(s) to add.

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

ParameterTypeDescription
usingObjectStyleThe object style to apply.
clearingOverridesboolIf true, clears the TextFrame's existing attributes before applying the style. (Optional) (default: true)
clearingOverridesThroughRootObjectStyleboolIf 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: bool=false][, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])
asynchronously exports the object(s) to a file.

ParameterTypeDescription
formatExportFormat
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.
toFileThe path to the export file.
showingOptionsboolIf true, displays the export options dialog. (Optional) (default: false)
usingPDFExportPresetThe export style. (Optional)
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (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.

ParameterTypeDescription
referencePageItemThe 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.

ParameterTypeDescription
reverseOrderboolIf 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.

ParameterTypeDescription
reverseOrderboolIf 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.

ParameterTypeDescription
reverseOrderboolIf 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.

ParameterTypeDescription
reverseOrderboolIf 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.

ParameterTypeDescription
reverseOrderboolIf 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.

Array of any contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])
Duplicate an object and place it into the target page item.

ParameterTypeDescription
pageItemsArray of PageItemOne or more page items to place or load
linkPageItemsboolWhether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false)
linkStoriesboolWhether 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)
mapStylesboolWhether to map styles in content placer (Optional) (default: false)
showingOptionsboolWhether to display the link options dialog (Optional) (default: false)

void convertShape (given: ConvertShapeOptions[, numberOfSides: number][, insetPercentage: number][, cornerRadius: Measurement Unit (Number or String)])
Converts the TextFrame to a different shape.

ParameterTypeDescription
givenConvertShapeOptions:
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.
numberOfSidesnumber (range: 3 - 100)The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentagenumber (range: 0 - 100)The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadiusMeasurement 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.

ParameterTypeDescription
deleteOriginalboolIf 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.

ParameterTypeDescription
toArray 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)
byArray 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.

ParameterTypeDescription
withArray of PageItemThe object(s) to exclude.

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

ParameterTypeDescription
formatExportFormat
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.
toFileThe path to the export file.
showingOptionsboolIf true, displays the export options dialog. (Optional) (default: false)
usingPDFExportPresetThe export style. (Optional)
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

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

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

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

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

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

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

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

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

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

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

void fit (given: FitOptions)
Applies the specified fit option to content in a frame.

ParameterTypeDescription
givenFitOptions:
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.

ParameterTypeDescription
givenFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
The axis around which to flip the TextFrame.
aroundAnchorPoint
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.

ParameterTypeDescription
keystringThe key.
valuestringThe 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.

ParameterTypeDescription
withArray of PageItemThe 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.

ParameterTypeDescription
withArray of PageItemThe 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.

ParameterTypeDescription
usingXMLElementThe 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.

ParameterTypeDescription
withArray of PageItemThe 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.

ParameterTypeDescription
toArray 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)
byArray 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.

ParameterTypeDescription
destinationPagePageThe document page that contains the master page item to override.

Array of any place (fileName: File[, showingOptions: bool=false][, withProperties: Object])
Places the file.

ParameterTypeDescription
fileNameFileThe file to place
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
withPropertiesObjectInitial 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.

ParameterTypeDescription
parentStoryStoryThe story to place and link from.
showingOptionsboolWhether 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.

ParameterTypeDescription
usingXMLElementThe 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.

ParameterTypeDescription
toArray of numberThe 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

ParameterTypeDescription
inboundsKind: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.
opposingCornersArray 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
inBoundingBoxLimits
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.
fromAnchorPoint
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.
byResizeMethods:
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
valuesArray 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.
resizeIndividuallyboolIf 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)
consideringRulerUnitsboolIf 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.

ParameterTypeDescription
locationAnchorPoint
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.
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.PAGE_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use.
consideringRulerUnitsboolIf 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 select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

ParameterTypeDescription
existingSelectionSelectionOptions:
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)

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

ParameterTypeDescription
referencePageItemThe reference object to send the object behind (Optional)

Asset store (using: Library[, withProperties: Object])
Stores the object in the specified library.

ParameterTypeDescription
usingLibraryThe library in which to store the object.
withPropertiesObjectInitial 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.

ParameterTypeDescription
withArray of PageItemThe 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.

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.PAGE_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use
fromAnchorPoint
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.
withMatrixArray of 6 Reals
TransformationMatrix
Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrentArray 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)
consideringRulerUnitsboolIf 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 string transformAgain ()
Transforms the TextFrame using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformAgainIndividually ()
Transforms the TextFrame using the last transformation performed on any TextFrame. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of 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.

Array of 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.

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

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.PAGE_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use

Element of

AnimationSetting.parent

BaselineFrameGridOption.parent

Footnote.parent

GridDataInformation.parent

LinkedPageItemOption.parent

ObjectExportOption.parent

TextFrame.endTextFrame

TextFrame.nextTextFrame

TextFrame.previousTextFrame

TextFrame.startTextFrame

TextFramePreference.parent

TextPath.endTextFrame

TextPath.nextTextFrame

TextPath.parent

TextPath.previousTextFrame

TextPath.startTextFrame

Used in:

TextFrame TextFrames.nextItem (obj: TextFrame)

TextFrame TextFrames.previousItem (obj: TextFrame)

Return

Array of TextFrame TextFrame.getElements ()

TextFrame TextFrames.[] (index: number)

TextFrame TextFrames.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])

TextFrame TextFrames.anyItem ()

Array of TextFrame TextFrames.everyItem ()

TextFrame TextFrames.firstItem ()

TextFrame TextFrames.item (index: varies)

TextFrame TextFrames.itemByID (id: number)

TextFrame TextFrames.itemByName (name: string)

Array of TextFrame TextFrames.itemByRange (from: varies, to: varies)

TextFrame TextFrames.lastItem ()

TextFrame TextFrames.middleItem ()

TextFrame TextFrames.nextItem (obj: TextFrame)

TextFrame TextFrames.previousItem (obj: TextFrame)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index