TextStatus Object
Contents
The TextStatus object provides control over the typographical attributes of individual characters of a text, i.e. all the attributes that determine how a character will be printed: font, point size, color etc., similarly to what is achieved with the Ted.EditSetText command.
Methods and properties
Typeface, size, base
| FontCode Property | Returns or sets the code number of the characters' font. |
| HasFontCode Method | Returns true if the FontCode property has a value. |
| CharH Property | Returns and sets the characters' point size. |
| HasCharH Method | Returns true if the CharH property has a value. |
| CharW Property | Returns and sets the characters' width. |
| HasCharW Method | Returns true if the CharW property has a value. |
Italic, bold, slant
| Italic Property | Returns or sets the italic font variation. |
| HasItalic Method | Returns true if the Italic property has a value. |
| Bold Property | Returns or sets the bold font variation. |
| HasBold Method | Returns true if the Bold property has a value. |
| Slant Property | Returns or sets the characters' slant. |
| HasSlant Method | Returns true if the Slant property has a value. |
Color and tint
| Color Property | Returns or sets the name of the characters' color. |
| HasColor Method | Returns true if the Color property has a value. |
| Gray Property | Returns or sets the characters' tint. |
| HasGray Method | Returns true if the Gray property has a value. |
Baseline shift
| YOfs Property | Returns or sets the characters' vertical offset. |
| HasYOfs Method | Returns true if the YOfs property has a value. |
Capitals style
| Small Property | Returns or sets the style of capitals. |
| HasSmall Method | Returns true if the Small property has a value. |
Shadow and outline
| Shadow Property | Returns and sets the text shadow status. |
| HasShadow Method | Returns true if the Shadow property has a value. |
| Outline Property | Returns and sets the text outline status. |
| HasOutline Method | Returns true if the Outline property has a value. |
| SupColor Property | Returns and sets the name of the shadow color or outline fill. |
| HasSupColor Method | Returns true if the SupColor property has a value. |
| SupGray Property | Returns and sets tint of the shadow or fill of outline characters. |
| HasSupGray Method | Returns true if the SupGray property has a value. |
| SetShadow Method | Sets or resets the shadow with parametrized characters spacing, X and Y position of the shadow. |
| ShadowEnlarge Property | Returns and sets the value of the extra character spacing in the shadow. |
| ShadowMoveX Property | Returns and sets the value of the horizontal offset of the shadow. |
| ShadowMoveY Property | Returns and sets the value of the vertical offset of the shadow. |
Hyphenation
| Hyp Property | Returns and sets the hyphenation language. |
| HasHyp Method | Returns true if the Hyp property has a value. |
Tracking
| Kerning Property | Returns and sets the kerning between characters. |
| HasKerning Method | Returns true if the Kerning property has a value. |
Hidden text
| RemCode Property | Returns and sets the notes mode code. |
| HasRemCode Method | Returns true if the RemCode property has a value. |
| HasMode Method | Returns true if the Mode and ModeData properties have a value. |
| Mode Method | Returns and sets the value of the second parameter of the >rem...< GNML tag. |
| ModeData Method | Returns the value of the first parameter of the >rem...< GNML tag. |
| SetMode Method | Sets the two parameters of the >rem...< GNML tag. |
Underlines
| HasUnderlines Method | Returns true if the underline properties (UY, UH,UColor, UGray, UFlags and NUnderlines) have a value. |
| NUnderlines Property | Returns and sets the number of defined underlines. |
| UColor Property | Returns and sets the name of the color of the nIdx underline. |
| UFlags Property | Returns and sets options for the nIdx underline. |
| UGray Property | Returns and sets tint of the nIdx underline. |
| UH Property | Returns and sets the weight in millipoints of the nIdx underline. |
| UReset Method | Clears all the underlines. |
| UY Property | Returns and sets the vertical position in millipoints of the nIdx underline. |
Reset and Edit
| Reset Method | Resets all the properties to 'no value'. |
| Edit Method | Edits all the object's properties with a dialog. |
To create a TextStatus object:
•Dim objTS = Text.GetTextStatus
See also
TextStatus object and selection