TextRange class
Represents a text range
Syntax:
class TextRange {}
Remarks:
The TextRange class represents a text range.
Properties:
Name Description
Alignment Gets/sets the alignment of the text in the range
AutoHyphenate Gets/sets the value for automatic hyphenation
Baselines Returns a curve consisting of a set of line segments representing placement and direction of baselines of each text line in the range
Bold Gets/sets the Bold property of the range
BulletBaselineShift Gets or sets the vertical shift of the bullet symbol from baseline in points
BulletFont Gets or sets the font face of the bullet symbol
BulletHangingIndent Gets or sets the hanging indent for the paragraphs when bullet effect is applied
BulletHorizontalPosition Gets or sets the horizontal offset of the bullet symbol from the left text margin
BulletSize Gets or sets the font size of the bullet symbol in point
BulletSymbol Gets or sets the character to use as a bullet
Case Gets/sets the case of the text in the range
Characters Collection of all characters in the range
CharAngle Gets/sets the rotation angle
CharBackFill Returns the background color for the characters in the range
CharSet Gets/sets the character set of the text range
CharSpacing Gets/sets the character spacing property
Columns Collection of text columns in the range
DropCapDistanceFromText Gets or sets the distance between a drop cap and the rest of the text
DropCapHangingIndent Gets or sets the hanging indent for the paragraphs when drop cap effect is applied
DropCapLinesDropped Gets or sets the number of lines a drop cap effect drops
Effect Returns the paragraph formatting effect type
End Ending character position of the range in the text stream
Fill Gets the fill
FirstLineIndent Gets/sets the amount that the first line is indented
Font Gets/sets the font name
Frames Collection of text frames in the range
HorizShift Gets/sets the amount by which the text has been shifted horizontally
HyphenateAllCapWords Gets/sets whether to hyphenate all uppercase words
HyphenateCapitals Gets/sets whether to hyphenate uppercase words
HyphenHotZone Gets/sets the distance from the right margin at which words begin to be hyphenated
HyphenMinCharsAfter Gets/sets the minimum number of characters to use after a hyphen
HyphenMinCharsBefore Gets/sets the minimum number of characters to use before a hyphen
HyphenMinWordLength Gets/sets the minimum size of a word to hyphenate
IndentLevel Gets or sets the paragraph indent level
IndentLevelStyles Returns the styles of all possible indent level properties
IsEmpty Returns True if the text range is of zero length (has no characters in it)
Italic Gets/sets the Italic property of the range
LanguageID Gets/sets the LanguageID of the text range
LeftIndent Gets/sets the amount by which the text has been left-indented
Length The length of the range in characters
Lines Collection of all lines in the range
LineSpacing Gets/sets the line spacing property
LineSpacingType Gets the type of line spacing to use
MaxCharSpacing Gets/sets the maximum amount of space between each character
MaxWordSpacing Gets/sets the maximum amount of space between each word
MinWordSpacing Gets/sets the minimum amount of space between each word
ObjectStyle Returns the style currently applied to the text in the range
Outline Gets the outline
Overscore Gets/sets the Overscore property of the range
Paragraphs Collection of all paragraphs in the range
ParaSpacingAfter Gets/sets the amount of space after the paragraph
ParaSpacingBefore Gets/sets the amount of space before the paragraph
Position Gets/sets the font position
RangeKerning Gets or sets the character range kerning
RightIndent Gets/sets the amount by which the text has been right-indented
Size Gets/sets the font size
Start Starting character position of the range in the text stream
Strikethru Gets/sets the StrikeThru property of the range
Style Gets/sets the font style of the range
Tabs Returns a collection of all tabs stops defined for the text range
Text Text string in the range
TextFormatter Gets or sets the text formatter used for the text stream
TextLineRects Returns a curve consisting of a set of rectangular subpaths representing bounding boxes of each text line in the range
Underline Gets/sets the Underline property of the range
VariableAxes Returns the variable font axes values
VertShift Gets/sets the amount by which the text has been shifted vertically
WideText Unicode text string
Words Collection of all words in the range
WordSpacing Gets/sets the amount of space between each word
Methods:
Name Description
AlignToBaseline Removes vertical character shifts
ApplyBulletEffect Applies bullet effect to paragraphs in the range
ApplyDropCapEffect Applies drop cap effect to paragraphs in the range
ApplyNoEffect Removes any paragraph formatting effect (such as drop cap or bullets)
ApplyStyle Applies a style to the text in the range
ChangeCase Changes the case of the text
Collapse Collapses the text range
Combine Combines the current text range with the given range
Copy Copies the text to the clipboard
CopyAttributes Copies text attributes from the source text range and applies them to the current text range
Delete Deletes the characters in the range
Duplicate Returns a copy of the TextRange object
EnumRanges Gets a collection of text ranges sharing the same character attributes
Evaluate Evaluates the given CQL expression using properties of the text range and returns the result of the expression
FindRanges Find text character ranges using the supplied query condition in CQL
GetOpenTypeFeature Gets the current state of the OpenType feature for the text range
InRange Gets whether the current text range is within the given range
InsertAfter Inserts the new text after the last character in the range and returns a range containing only the inserted characters
InsertAfterWide Inserts the new Unicode text after the last character in the range and returns a range containing only the inserted characters
InsertBefore Inserts the new text before first character in the range and returns a range containing only the inserted characters
InsertBeforeWide Inserts the new Unicode text before first character in the range and returns a range containing only the inserted characters
IsSame Gets whether the current text range is the same as the given range
Paste Replaces the current text range and returns the new one
Range Returns a range of characters relative to the beginning of the current range
Replace Replaces the range with the text string and returns the new range
ReplaceWide Replaces the range with the Unicode text string and returns the new range
Select Selects the characters in the range
SetLineSpacing Sets the line spacing properties of the text range
SetOpenTypeFeature Changes the state of the OpenType feature for the text range
SetRange Sets the starting and ending position of the text range
Straighten Removes horizontal and vertical character shifts as well as their rotation
Version Information:
CorelDRAW: X7.4, X7, X7.6, X8, 2017, 2018, 2019, 2019.2, 2020, 2021, 2020.1, 2021.5, 2022-v24, 2022-v24.1, 2022-v24.2, 2023-v24.3
Corel DESIGNER: X7, 2017.1, 20.1, 2019.2, 2020.1, 2021.5, 2022-v24, 2022-v24.1, 2022-v24.2, 2023-v24.3

© Corel Corporation. All rights reserved. The content herein is in the form of a personal web log ("Blog") or forum posting. As such, the views expressed in this site are those of the participants and do not necessarily reflect the views of Corel Corporation, or its affiliates and their respective officers, directors, employees and agents. Terms of Use / Privacy​ ​/ ​Cookies / Terms and Conditions / User Guidelines.