TextFrame

A text frame.

TextFrame Properties

Property Type Access Description
absoluteHorizontalScale Real r/w The horizontal scaling percentage applied to the object, not including any scaling applied to its containing object.
absoluteRotationAngle Real r/w The rotation angle applied to the object, not including any rotation applied to its containing object.
absoluteShearAngle Real r/w The shear angle applied to the object, not including any shearing applied to its containing object.
absoluteVerticalScale Real r/w The vertical scaling percentage applied to the object, not including any scaling applied to its containing object.
allGraphics Array of Graphics read All graphics contained by the object.
allPageItems Array of PageItems read All page items contained by the object.
anchoredObjectSettings AnchoredObjectSetting read Anchored object settings for the object.
appliedObjectStyle ObjectStyle r/w The object style applied to the object.
associatedXMLElement XMLItem read The XML element associated with the object.
baselineFrameGridOptions BaselineFrameGridOption read Baseline frame grid options.
blendMode BlendMode enumeration r/w The blending mode applied to the object.
buttons Buttons read The buttons contained by the object.
characters Characters read The characters of the object.
contents String, TextFrameContents enumeration, SpecialCharacters enumeration (see table at end of chapter) r/w The text contents.
contentType ContentType enumeration r/w The content type of the object.
cornerEffect CornerEffects enumeration r/w The corner effect applied to the object.
cornerRadius Real r/w The corner effect radius applied to the object.
endCap EndCap enumeration r/w The end cap applied to the stroke of the object.
endJoin EndJoin enumeration r/w The end join applied to the stroke of the object.
endTextFrame TextFrame, TextPath read The last text frame in the thread as TextFrame or TextPath.
featherCornerType FeatherCornerType enumeration r/w The type of feathering applied to the object.
featherMode FeatherMode enumeration r/w The feathering mode applied to the object.
featherNoise Real (0 – 100) r/w The amount of noise applied to the feathering applied to the object.
featherWidth Unit (0 – 1000 points) r/w The width of the feathering applied to the object.
fillColor Swatch, String r/w The fill of the object.
fillTint Real r/w The tint percentage applied to the fill of the object (-1 indicates 100%).
footnotes Footnotes read The footnotes contained by the object.
formFields FormFields read The form fields contained by the object.
gapColor Swatch r/w The gap color applied to the stroke of the object.
gapTint Real r/w The tint applied to the gap color of the object (-1 indicates 100%).
geometricBounds Array of 4 Units r/w The bounds of the page item excluding the stroke width, in the form (top, left, bottom, right).
gradientFillAngle Real r/w The angle of the gradient applied to the fill of the object.
gradientFillLength Unit r/w Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the fill of the object.
gradientFillStart Array of 2 Units r/w Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the fill of the object.
gradientStrokeAngle Real r/w The angle of the gradient applied to the stroke of the object.
gradientStrokeLength Unit r/w Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the stroke of the object.
gradientStrokeStart Array of 2 Units r/w Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the stroke of the object.
graphicLines GraphicLines read The graphic lines contained by the object.
groups Groups read The groups contained by the object.
horizontalScale Real r/w The horizontal scaling percentage applied to the object, including the scaling applied to its containing object(s).
id Long read A unique number identifying the object.
index Long read Index of the object within its parent object.
insertionPoints InsertionPoints read The insertion points in the object.
isolateBlending Boolean r/w If true, the object will blend in isolation.
itemLayer Layer r/w The layer the object is on.
knockoutGroup Boolean r/w If true, the object will blend as a knockout group.
label String r/w A label that can be set to any string.
leftLineEnd ArrowHead enumeration r/w A shape, such as an arrowhead, applied to the left end of the paths of the object. This shape will only appear on open paths.
lines Lines read The lines of text in the object.
localDisplaySetting DisplaySettingOptions enumeration r/w The display settings for the object.
locked Boolean r/w If true, the object is locked.
miterLimit Real r/w The point at which the rendering of a corner point switches from a miter join to a bevel join.
nextTextFrame TextFrame, TextPath r/w The next text frame in the thread.
nonprinting Boolean r/w If true, the object is non-printing.
notes Notes read Every note.
opacity Real (0 – 100) r/w The opacity of the object.
ovals Ovals read All ovals contained by the object.
overflows Boolean read If true, the object contains overset text.
overprintFill Boolean r/w If true, the fill of the object will overprint.
overprintGap Boolean r/w If true, the gap color applied to the stroke of the object will overprint.
overprintStroke Boolean r/w If true, the storke of the object will overprint.
overridden Boolean read If true, this object originated on a master spread, was overridden, and is still linked to the object on the master spread.
overriddenMasterPageItem PageItem, Guide, Graphic, Movie, Sound read A reference to the original object on the master spread (for overridden objects).
pageItems PageItems read The page items contained by the object.
paragraphs Paragraphs read The paragraphs contained by the object.
parent Object read The parent of the object.
parentStory Story read The story containing the object.
paths Paths read The paths of the object.
polygons Polygons read The polygons contained by the object.
previousTextFrame TextFrame, TextPath r/w The previous text frame in the thread.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
rectangles Rectangles read The rectangles contained by the object.
rightLineEnd ArrowHead enumeration r/w A shape, such as an arrowhead, applied the right end of the paths of the object. This shape will only appear on open paths.
rotationAngle Real r/w The rotation angle applied to the object, including any rotation applied to its containing object.
shadowBlendMode BlendMode enumeration r/w The blending mode applied to the drop shadow.
shadowBlurRadius Unit (0 – 144 points) r/w The blur radius of the the drop shadow.
shadowColor Swatch r/w The color of the drop shadow.
shadowMode ShadowMode enumeration r/w The shadow mode of the drop shadow.
shadowNoise Real (0 – 100) r/w The amount of noise applied to the drop shadow.
shadowOpacity Real (0 – 100) r/w The opacity of the drop shadow.
shadowSpread Real (0 – 100) r/w The distance to spread the drop shadow before applying blurring.
shadowXOffset Unit (-1000 – 1000 points) r/w The horizontal offset of the drop shadow from the object.
shadowYOffset Unit (-1000 – 1000 points) r/w The vertical offset of the drop shadow from the object.
shearAngle Real r/w The shear angle of the object, including any shearing applied to its containing object.
startTextFrame TextFrame, TextPath read The first text frame in the thread.
strokeAlignment StrokeAlignment enumeration r/w The stroke alignment of the object.
strokeColor Swatch, String r/w The stroke color of the object.
strokeCornerAdjustment StrokeCornerAdjustment enumeration r/w The adjustment method to apply to the corners of a dashed stroke.
strokeDashAndGap Array of Units r/w The dash and gap settings of a dashed stroke. A list of up to 6 values.
strokeTint Real r/w The tint percentage applied to the stroke (-1 indicates 100%).
strokeType StrokeStyle r/w The stroke type.
strokeWeight Unit r/w The stroke weight (thickness) of the stroke.
tables Tables read The tables contained by the object.
textColumns TextColumns read The text columns contained by the object.
textFrameIndex Long read Index of the text frame in its thread of linked frames.
textFramePreferences TextFramePreference read Text frame preferences.
textFrames TextFrames read The text frames contained by the object.
textPaths TextPaths read The text paths attached to the object.
texts Texts read The texts contained by the object.
textStyleRanges TextStyleRanges read The text style ranges contained by the object.
textWrapPreferences TextWrapPreference read Text wrap preferences for the object.
verticalScale Real r/w The vertical scaling percentage applied to the object, including the scaling applied to its containing object(s).
visibleBounds Array of 4 Units r/w The bounds of the page item, including the stroke width, in the form (top, left, bottom, right).
words Words read The words contained by the object.

TextFrame Methods

Method Returns Description
addPath PageItem Create a new shape by adding the path(s) of this object with the paths of other objects. This method corresponds to the Add pathfinder.
bringForward Nothing Brings the object forward.
bringToFront Nothing Brings object to the front.
createOutlines Array of PageItems Create outlines from the text.
detach Nothing Detaches an overridden page item from the master page item.
duplicate PageItem Duplicates the object.
excludeOverlapPath PageItem Creates a new shape by excluding area of intersection of this object with the other objects. This method corresponds to the Exclude Overlap pathfinder.
exportFile Nothing Export the object to file.
extractLabel String Gets the content of the label associated with the specified key (name).
fit Nothing Applies fitting options to the content of a frame.
flipItem Nothing Flips the object around a specified axis.
getElements Array of Objects Resolve the object specifier.
insertLabel Nothing Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
intersectPath PageItem Create a new shape based on the area(s) of intersection between this object and the other objects. This method corresponds to the Intersect pathfinder.
makeCompoundPath PageItem Creates a compound path by adding the paths of this object to the paths of other objects.
markup Nothing Mark up layout content with XML preserving the existing content.
minusBack PageItem Creates a new shape by reverse subtracting this object from the specified other objects. This method corresponds to the Minus Back pathfinder.
move Nothing Move Page Item to a new location. One of the ‘To’ or ‘By’ parameters is required.
override PageItem, Guide, Graphic, Movie or Sound Overrides an item from the master page and places it on the page.
place PageItem, Graphic, Movie, Sound, Story or Text Places a file.
placeXML Nothing Places content into the specified XML element (replacing the existing content).
recompose Nothing Recomposes the text in the object.
releaseCompoundPath Array of PageItems Releases a compound path and returns the released page items.
remove Nothing Delete the object.
removeOverride Nothing Removes a locally overridden master page item.
resetScaling Nothing Resets the scaling to 100%. Note that this does not change the size of the object; instead, it makes the current size of the object the basis for future scaling.
resize Nothing Resizes the object.
rotate Nothing Rotates the object.
scaleTextAttributes Nothing Move a text frame’s scaling into the text attributes.
search Array of Texts Searches for text and returns a list of text objects matching the search string and/or formatting specified by the find preferences. Search can also replace the text and/or formatting. This command corresponds to InDesign’s Find/Change feature.
select Nothing Selects the object.
sendBackward Nothing Send object backward.
sendToBack Nothing Send object to the back.
shear Nothing Shears the page item.
store Asset Stores the object in a library.
subtractPath PageItem Create a new shape by subtracting the area(s) of intersection of this object from the specified objects. This method corresponds to the Subtract pathfinder.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.
transformAgain Array of Strings Repeats the last transformation.
transformAgainIndividually Array of Strings Transforms the object using the last transformation (applied individually).
transformSequenceAgain Array of Strings Transforms the object using the last sequence of transformations.
transformSequenceAgainIndividually Array of Strings Transforms the object using the last sequence of transformations (applied individually).

Leave a Comment

Previous post:

Next post: