Adobe InDesign CS2 (4.0) Object Model JS: TextFrame

InDesign CS2

Class

TextFrame

 A text frame. Base Class: PageItem

QuickLinks

addPath, applyObjectStyle, bringForward, bringToFront, checkIn, checkOut, createOutlines, detach, duplicate, excludeOverlapPath, exportFile, extractLabel, fit, flipItem, getElements, insertLabel, intersectPath, makeCompoundPath, markup, minusBack, move, override, place, placeXML, recompose, releaseCompoundPath, remove, removeOverride, resetScaling, resize, revert, rotate, scaleTextAttributes, search, select, sendBackward, sendToBack, shear, store, subtractPath, toSource, toSpecifier, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually

Hierarchy

Button | Cell | Character | Document | Footnote | GraphicLine | Group | InsertionPoint | Layer | Line | MasterSpread | Oval | Page | PageItem | Paragraph | Polygon | Rectangle | Spread | State | Story | Table | Text | TextColumn | TextFrame | TextStyleRange | Word
PageItem
TextFrame
AnchoredObjectSetting | BaselineFrameGridOption | Button | Character | Footnote | FormField | GraphicLine | Group | InsertionPoint | Line | Note | Oval | PageItem | Paragraph | Path | Polygon | Rectangle | Table | Text | TextColumn | TextFrame | TextFramePreference | TextPath | TextStyleRange | TextWrapPreference | Word

Properties

PropertyTypeAccessDescription
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.
allGraphics Array of Graphic readonlyLists all graphics contained by the TextFrame.
allPageItems Array of PageItem readonlyLists all page items contained by the TextFrame.
anchoredObjectSettingsAnchoredObjectSetting readonlyAnchored object settings.
appliedObjectStyleObjectStyle r/wThe object style applied to the TextFrame.
associatedXMLElementXMLItem readonlyThe XML element associated with the TextFrame.
baselineFrameGridOptionsBaselineFrameGridOption readonlyBaseline frame grid option settings.
blendModeBlendMode:
BlendMode.NORMAL
BlendMode.MULTIPLY
BlendMode.SCREEN
BlendMode.OVERLAY
BlendMode.SOFT_LIGHT
BlendMode.HARD_LIGHT
BlendMode.COLOR_DODGE
BlendMode.COLOR_BURN
BlendMode.DARKEN
BlendMode.LIGHTEN
BlendMode.DIFFERENCE
BlendMode.EXCLUSION
BlendMode.HUE
BlendMode.SATURATION
BlendMode.COLOR
BlendMode.LUMINOSITY
r/wThe blend mode used to combine the background with the color of the TextFrame.
buttonsButtons readonlyA collection of buttons.
charactersCharacters readonlyA collection of characters.
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.
cornerEffectCornerEffects:
CornerEffects.NONE
CornerEffects.ROUNDED_CORNER
CornerEffects.INVERSE_ROUNDED_CORNER
CornerEffects.INSET_CORNER
CornerEffects.BEVEL_CORNER
CornerEffects.FANCY_CORNER
r/wThe shape to apply to corner points in a path. Note: corner effect differs from end join in that you can set a radius for a corner effect, whereas the rounded or beveled effect of an end join depends upon the stroke weight.
cornerRadiusnumber r/wThe radius of the corner
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.
featherCornerTypeFeatherCornerType:
FeatherCornerType.SHARP
FeatherCornerType.ROUNDED
FeatherCornerType.DIFFUSION
r/wThe type of feathering.
featherModeFeatherMode:
FeatherMode.NONE
FeatherMode.STANDARD
r/wThe feather-enabling mode.
featherNoisenumber (range: 0 - 100) r/wThe amount (as a percentage) of noise to apply to the feather. (Range: 0 to 100)
featherWidthMeasurement Unit (Number or String) (range: 0 - 1000) r/wThe width of the feathering.
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.)
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.)
geometricBounds Array 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.
gradientFillStart Array 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.
gradientStrokeStart Array 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.
groupsGroups readonlyA collection of groups.
horizontalScalenumber r/wThe horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
idnumber readonlyThe unique ID of the TextFrame.
indexnumber readonlyThe index of the TextFrame within its containing object.
insertionPointsInsertionPoints readonlyA collection of insertion points.
isolateBlendingbool r/wIf true, the TextFrame blends in isolation.
itemLayerLayer r/wThe layer that the TextFrame is on.
knockoutGroupbool r/wIf true, the TextFrame is a knockout group.
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.
localDisplaySettingDisplaySettingOptions:
DisplaySettingOptions.HIGH_QUALITY
DisplaySettingOptions.TYPICAL
DisplaySettingOptions.OPTIMIZED
DisplaySettingOptions.DEFAULT_VALUE
r/wDisplay performance options for the TextFrame.
lockStateLockStateValues:
LockStateValues.NONE
LockStateValues.UNMANAGED_STORY
LockStateValues.CHECKED_IN_STORY
LockStateValues.CHECKED_OUT_STORY
LockStateValues.LOCKED_STORY
LockStateValues.EMBEDDED_STORY
LockStateValues.MISSING_LOCK_STATE
LockStateValues.MIXED_LOCK_STATE
readonlyThe lock state.
lockedbool r/wIf true, the TextFrame is locked.
miterLimitnumber r/wThe limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (Range: 1 to 500)
nextTextFrameTextFrame
TextPath
r/wThe next text frame in the thread. Can return: TextFrame or TextPath.
nonprintingbool r/wIf true, the TextFrame does not print.
notesNotes readonlyA collection of notes.
opacitynumber (range: 0 - 100) r/wThe opacity of the TextFrame. (Range: 0 to 100)
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.
parentButton
Cell
Character
Document
Footnote
GraphicLine
Group
InsertionPoint
Layer
Line
MasterSpread
Oval
Page
PageItem
Paragraph
Polygon
Rectangle
Spread
State
Story
Table
Text
TextColumn
TextFrame
TextStyleRange
Word
readonlyThe parent of the TextFrame (a Spread, MasterSpread, PageItem, Oval, Rectangle, Polygon, GraphicLine, Group, State, Document, Layer, Button, TextFrame, Story, Text, Word, Line, TextColumn, Paragraph, TextStyleRange, Cell, Table, InsertionPoint, Page, Character or Footnote).
parentStoryStory readonlyThe story that contains the text.
pathsPaths readonlyA collection of paths.
polygonsPolygons readonlyA collection of polygons.
previousTextFrameTextFrame
TextPath
r/wThe previous text frame in the thread. Can return: TextFrame or TextPath.
propertiesObject r/wA property that allows setting of several properties at the same time.
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)
shadowBlendModeBlendMode:
BlendMode.NORMAL
BlendMode.MULTIPLY
BlendMode.SCREEN
BlendMode.OVERLAY
BlendMode.SOFT_LIGHT
BlendMode.HARD_LIGHT
BlendMode.COLOR_DODGE
BlendMode.COLOR_BURN
BlendMode.DARKEN
BlendMode.LIGHTEN
BlendMode.DIFFERENCE
BlendMode.EXCLUSION
BlendMode.HUE
BlendMode.SATURATION
BlendMode.COLOR
BlendMode.LUMINOSITY
r/wThe blend mode to use for drawing the shadow.
shadowBlurRadiusMeasurement Unit (Number or String) (range: 0 - 144) r/wThe radius of the shadow blur.
shadowColorSwatch r/wThe swatch (color or mixed ink) applied to the shadow.
shadowModeShadowMode:
ShadowMode.NONE
ShadowMode.DROP
r/wThe shadow mode.
shadowNoisenumber (range: 0 - 100) r/wThe amount (as a percentage) of noise to apply to the shadow. (Range: 0 to 100)
shadowOpacitynumber (range: 0 - 100) r/wThe opacity of the shadow. (Range: 0 to 100)
shadowSpreadnumber (range: 0 - 100) r/wThe amount (as a percentage) of the blur radius to use as the shadow footprint. (Range: 0 to 100) For information, see shadow blur radius.
shadowXOffsetMeasurement Unit (Number or String) (range: -1000 - 1000) r/wThe horizontal offset of the shadow.
shadowYOffsetMeasurement Unit (Number or String) (range: -1000 - 1000) r/wThe vertical offset of the shadow.
shearAnglenumber r/wThe skewing angle applied to the TextFrame. (Range: -360 to 360)
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.
strokeDashAndGap Array 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.)
strokeTypeStrokeStyle r/wThe stroke type
strokeWeightMeasurement Unit (Number or String) r/wThe weight (in points) to apply to the TextFrame's stroke.
tablesTables readonlyA collection of tables.
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.
textWrapPreferencesTextWrapPreference readonlyThe text wrap preference properties that define the default formatting for wrapping text around objects.
textsTexts readonlyA collection of text objects.
verticalScalenumber r/wThe vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
visibleBounds Array 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.

Methods

Instances

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
with Array 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)

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

void bringToFront ()
Brings the TextFrame to the front.

bool checkIn ()
Checks in the story.

bool checkOut ()
Checks out the story.

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 ([by: Array of Measurement Unit (Number or String)])
Duplicates the TextFrame.

ParameterTypeDescription
by Array of Measurement Unit (Number or String)The amount (in points) to offset the new TextFrame, in the format [x, y]. (Optional)

PageItem excludeOverlapPath (with: Array of PageItem)
Creates a new page item by excluding the overlapping areas of the TextFrame and other objects.

ParameterTypeDescription
with Array of PageItemThe object(s) to exclude.

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

ParameterTypeDescription
formatExportFormat
String
The export format. Can accept: ExportFormat enumerator or String.
toFileThe path of the export file.
showingOptionsboolIf true, prompts the user to select export options. (Optional) (default: false)
usingPDFExportPresetThe export style to use. (Optional)

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

ParameterTypeDescription
keystringThe key.

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
The fit option to use.

void flipItem (given: FlipItemOptions[, around: any][, transformingContent: bool=true])
Flip item about given axis

ParameterTypeDescription
givenFlipItemOptions:
FlipItemOptions.HORIZONTAL
FlipItemOptions.VERTICAL
FlipItemOptions.BOTH
flip item options
aroundAnchorPoint
Array of 2 Units
The point to flip around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
transformingContentboolIf true then both the object and items within it are flipped (Optional) (default: true)

Array of Object 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
with Array 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
with Array 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
with Array of PageItemThe object(s) to reverse subtract.

void move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])
Move Page Item to a new location. One of the 'To' or 'By' parameters is required.

ParameterTypeDescription
to Array of 2 Units
Layer
Page
Spread
The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by Array of Measurement Unit (Number or String)Amount by which to move the object relative to its current position (Optional)
transformingContentboolIf true then both the object and items within it are moved (Optional) (default: true)

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.

any place (fileName: File[, showingOptions: bool=false][, withProperties: Object])
Place a 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)

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.

Array of PageItem releaseCompoundPath ()
Releases a compound path.

void remove ()
Deletes the TextFrame.

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

void resetScaling ()
Resets the TextFrame's scaling to 100%. Note: This does not change the size of the TextFrame. Instead, it makes the current size of the TextFrame the basis for future scaling.

void resize ([horizontalScale: number][, verticalScale: number][, around: any][, consideringCurrentScale: bool=false][, transformingContent: bool=true][, consideringParentsScale: bool=false])
Resize the page item. You must specify either horizontal scale or vertical scale or both.

ParameterTypeDescription
horizontalScalenumberThe percentage of horizontal scale (Optional)
verticalScalenumberThe percentage of vertical scale (Optional)
aroundAnchorPoint
Array of 2 Units
The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentScaleboolIf true then the object's current scale and new scale will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContentboolIf true then both the object and items within it are scaled (Optional) (default: true)
consideringParentsScaleboolIf true then the object is scaled relative to its parent page item. If false it is scaled relative to the spread. (Optional) (default: false)

bool revert ()
Reverts the document to its state at the last save operation.

void rotate (by: number[, around: any][, consideringCurrentRotation: bool=false][, transformingContent: bool=true][, consideringParentsRotation: bool=false])
Rotate the page item

ParameterTypeDescription
bynumberAngle by which to rotate the page item
aroundAnchorPoint
Array of 2 Units
The point to rotate around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentRotationboolIf true then the object's current rotation and new rotation will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContentboolIf true then both the object and items within it are rotated (Optional) (default: true)
consideringParentsRotationboolIf true then the object is rotated relative to its parent page item. If false it is rotated relative to the spread. Cannot rotate with considering current rotation and considering parents rotation both set at the same time. (Optional) (default: false)

void scaleTextAttributes ()
Scales attributes of the text in the text frame to reflect scaling performed on the text frame. Note: Changes text attributes only when executed in the script after the text frame has been scaled.

Array of Text search ([for: string][, wholeWord: bool][, caseSensitive: bool][, replacingWith: string][, withFindAttributes: Object][, withChangeAttributes: Object])
Look for occurrences of text that matches specific criteria

ParameterTypeDescription
forstringWhat to look for (Optional)
wholeWordboolIf true, then disregard text embedded within a larger word (Optional)
caseSensitiveboolIf true, then search only for text that matches case (Optional)
replacingWithstringWhat to replace the found text with, either a string or a special character (Optional)
withFindAttributesObjectA record of find preference settings to use (Optional)
withChangeAttributesObjectA record of change preference settings to use (Optional)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
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 ()
Sends the TextFrame to the back.

void shear (by: number[, around: any][, shearAxisAngle: number=0][, consideringCurrentShear: bool=false][, transformingContent: bool=true][, consideringParentsShear: bool=false])
Shear the page item

ParameterTypeDescription
bynumberAngle by which to shear the object
aroundAnchorPoint
Array of 2 Units
The point to shear around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
shearAxisAnglenumberThe amount that the shear axis is rotated. If 0 degree then shear at its horizontal axis. If 90 degrees then shear at the vertical axis. (Optional) (default: 0)
consideringCurrentShearboolIf true then the object's current shear and new shear will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContentboolIf true then both the object and items within it are sheared (Optional) (default: true)
consideringParentsShearboolIf true then the object is sheared relative to its parent page item. If false it is sheared relative to the spread. Cannot shear with considering current shear and considering parents shear both set at the same time. (Optional) (default: false)

Asset store (using: Library)
Store a page item in a library

ParameterTypeDescription
usingLibraryThe library in which to store

PageItem subtractPath (with: Array of PageItem)
Creates a new page item by subtracting the overlapping areas of the TextFrame and other objects.

ParameterTypeDescription
with Array of PageItemThe object(s) to subtract.

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

string toSpecifier ()
Retrieves the object specifier.

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.

Element of

BaselineFrameGridOption.parent

Footnote.footnoteTextFrame

Note.parentTextFrame

TextFrame.endTextFrame

TextFrame.nextTextFrame

TextFrame.previousTextFrame

TextFrame.startTextFrame

TextFramePreference.parent

TextPath.endTextFrame

TextPath.nextTextFrame

TextPath.parent

TextPath.previousTextFrame

TextPath.startTextFrame

Used in:

Table Tables.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

array of TextFrame TextFrames.itemByRange (from: any, to: any)

TextFrame TextFrames.nextItem (obj: TextFrame)

TextFrame TextFrames.previousItem (obj: TextFrame)

Return

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

TextFrame TextFrames.anyItem ()

Array of TextFrame TextFrames.everyItem ()

TextFrame TextFrames.firstItem ()

TextFrame TextFrames.item (index: any)

TextFrame TextFrames.itemByID (id: number)

TextFrame TextFrames.itemByName (name: string)

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

TextFrame TextFrames.lastItem ()

TextFrame TextFrames.middleItem ()

TextFrame TextFrames.nextItem (obj: TextFrame)

TextFrame TextFrames.previousItem (obj: TextFrame)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index