Class

TextRange

 A range of characters from a text item.

QuickLinks

changeCaseTo, deSelect, duplicate, move, remove, removeAll, select

Hierarchy

Object

TextRange

Properties

Property	Type	Access	Description
characterAttributes	CharacterAttributes	readonly	The character properties for the text range.
characterOffset	int	r/w	Offset of the first character of the range from the beginning of the story, in characters.
characterStyles	CharacterStyles	readonly	List of referenced character styles in the text range.
characters	Characters	readonly	All the characters in this text range.
contents	string	r/w	The text string.
insertionPoints	InsertionPoints	readonly	All the insertion points in this text range.
kerning	int	r/w	Controls the spacing between two characters (in milli-ems)
length	int (min: 0)	r/w	Length of text range.
lines	Lines	readonly	All the lines in this text range.
paragraphAttributes	ParagraphAttributes	readonly	The paragraph properties for the text range.
paragraphStyles	ParagraphStyles	readonly	List of referenced paragraph styles in the text range.
paragraphs	Paragraphs	readonly	All the paragraphs in this text range.
parent	Object	readonly	The object's container.
story	Story	readonly	The story of the text range.
textRanges	TextRanges	readonly	All the text in this text range.
textSelection	Array of TextRange	readonly	The selected text (ranges) in the text range.
typename	string	readonly	The class name of the object.
words	Words	readonly	All the words in this text range.

Methods

Instances

void changeCaseTo (type: CaseChangeType)
Change the capitalization of text.

Parameter	Type	Description
type	CaseChangeType: CaseChangeType.UPPERCASE CaseChangeType.LOWERCASE CaseChangeType.TITLECASE CaseChangeType.SENTENCECASE	The type of case.

void deSelect ()
Deselect the text range.

TextRange duplicate (relativeObject: Object, insertionLocation: ElementPlacement)
Duplicate this object.

Parameter	Type	Description
relativeObject	Object
insertionLocation	ElementPlacement

TextRange move (relativeObject: Object, insertionLocation: ElementPlacement)
Move the object.

Parameter	Type	Description
relativeObject	Object
insertionLocation	ElementPlacement

void remove ()
Deletes this object.

void removeAll ()
Deletes all elements.

void select ([addToDocument: bool=false])
Select the text range.

Parameter	Type	Description
addToDocument	bool	Whether to add the text range to the document text selection. (default: false) (Optional)

Element of

Story.textRange

Story.textSelection

TextFrameItem.textRange

TextFrameItem.textSelection

TextRange.textSelection

Return

TextRange Characters.[] (index: uint)

TextRange Characters.add (contents: string)

TextRange Characters.addBefore (contents: string)

TextRange Characters.getByName (name: string)

TextRange Lines.[] (index: uint)

TextRange Lines.getByName (name: string)

TextRange Paragraphs.[] (index: uint)

TextRange Paragraphs.add (contents: string)

TextRange Paragraphs.addBefore (contents: string)

TextRange Paragraphs.getByName (name: string)

TextRange TextRange.duplicate (relativeObject: Object, insertionLocation: ElementPlacement)

TextRange TextRange.move (relativeObject: Object, insertionLocation: ElementPlacement)

TextRange TextRanges.[] (index: uint)

TextRange TextRanges.getByName (name: string)

TextRange Words.[] (index: uint)

TextRange Words.add (contents: string)

TextRange Words.addBefore (contents: string)

TextRange Words.getByName (name: string)

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index