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

Functions

append(text)
Appends the supplied text to this text range.
Parameters:
text: String
append(range)
Appends the supplied text range to this text range.
Parameters:
range: TextRange
changeCase(type)
Changes the case of the text in the text range.
Parameters:
type: Number - TextRange.CASE_*
changeHandle(newHandle)
Parameters:
newHandle: Number
clone()
Clones the text range.
Returns:
Object
deselect()
Deselects the text range in the document. Note that deselecting a text range can cause defragmented selection, if the text range is a subrange of the current selection.
fitHeadlines()
Adjusts the tracking of the text in the text range to fit on one line spanning the width of the area text.
getSubRange(start, end)
Returns a text range from the story given in indices relative to the current text range's start index.
Parameters:
start: Number
end: Number
Returns:
TextRange - sub range
prepend(text)
Prepends the supplied text to the text range.
Parameters:
text: String
prepend(range)
Prepends the supplied text range to the text range.
Parameters:
range: TextRange
remove()
Deletes all the characters in the text range.
select(addToSelection)
Selects the text range.
Parameters:
addToSelection: Boolean - If set to true, the text range will be added to the current selection in the document.
If set to false, it will clear the current selection in the document and only select the text range.