Sg2.0
TextFrame
Packages
About
News
Gallery
Scripts
Download
Documentation
Reference
Forum
Users
 

TextFrame extends Art

Properties

characterStyle
The character style of the text frame.
Returns:
content
content
The text contents of the text frame.
Returns:
String
end
Read-only.Returns the index of the last visible character of the text frame.(this is the equivalent of calling TextFrame.visibleRange.end)
Returns:
Number
index
Read-only.Returns the index of this text frame in the story's list of text frames.
Returns:
Number
linked
Read-only.Returns true if the text frame is linked, false otherwise.
Returns:
Boolean
nextFrame
Read-only.Returns the next text frame in a story of various linked text frames
Returns:
opticalAlignment
Specifies wether to use optical alignment within the text frame.
Optical aligment hangs punctuation outside the edges of a text frame.
Returns:
Boolean
orientation
The orientation of the text in the text frame asspecified by the TextFrame.ORIENTATION_* static properties.
Returns:
Number
paragraphStyle
The paragraph style of the text frame.
Returns:
previousFrame
Read-only.Returns the previous text frame in a story of various linked text frames
Returns:
range
Read-only.Returns a text range for all the characters, even the invisible ones outsidethe container.
Returns:
selection
Read-only.Returns the selected text of the text frame as a text range
Returns:
spacing
The line spacing value for the text frame in points.
Returns:
Number
start
Read-only.Returns the index of the first visible character of the text frame.(this is the equivalent of calling TextFrame.visibleRange.start)
Returns:
Number
story
story
Read-only.Returns the Story that the text frame belongs to.
Returns:
visibleRange
Read-only.In case there's an overflow in the text, this only returns a rangeover the visible characters, while getRange() returns one over thewhole text.
Returns:
ORIENTATION_HORIZONTAL
Returns:
Number
ORIENTATION_VERTICAL
Returns:
Number

Functions

createOutline()
Converts the text in the text frame to outlines. Unlike the Illustrator 'Create Outlines' action, this won't remove the text frame.
Returns:
Art - An Art item containing the outlined text.
link(next)
Links the supplied text frame to this one.
Parameters:
next: TextFrame - The text frame that will be linked.
Returns:
Boolean - True if the text frame was linked, false otherwise
nativeGetRange(includeOverflow)
Parameters:
includeOverflow: Boolean
Returns:
Number
unlink()
Unlinks the text frame from its current story.
Returns:
Boolean - True if the operation was successful, false otherwise
unlinkAfter()
Unlinks the text frame from its current story and breaks up the story into two parts after the text frame.
Returns:
Boolean - True if the operation as successful, false otherwise
unlinkBefore()
Unlinks the text frame from its current story and breaks up the story into two parts before the text frame.
Returns:
Boolean - True if the operation as successful, false otherwise

Inheritance