TxtPosDesc Object
Contents
The TxtPosDesc object provides the description of the content on which is the cursor.
Methods
Tag, style, type
| GetType Method | Returns an integer specifying the type of the text at the cursor position. |
| GetCmdType Method | Returns an a tag type |
| HasStyle Method | Returns true if the cursor position has an associated style (text or paragraph). |
| GetIsExpansion Method | Returns true if the text at the cursor position has been generated by the expansion of a style. |
| GetStyle Method | Returns a gn3ted.Style object describing the text or paragraph style at the cursor position. |
Character code, dimensions, position
| GetChar Method | Returns the code of the character at the cursor position. |
| GetCharH Method | Returns the characters' point size in millipoints. |
| GetCharW Method | Returns the characters' width in millipoints. |
| GetIsJust Method | Returns true if the text at the cursor position has been generated by the justification (e.g. an hyphen). |
| GetJustElementType Method | Returns an integer identifying the associated element generated by justification |
| GetYOfs Method | Returns characters' vertical offset in millipoints. |
Font, bold and italics
| GetFontCode Method | Returns the code of the characters' font. |
| GetBold Method | Returns TRUE if the bold font variation is active, otherwise it returns FALSE. |
| GetItalic Method | Returns true if there's an italic font variation. |
| GetSlant Method | Returns characters' slant in degrees clockwise. |
| GetSmall Method | Returns the status of the capitals attribute. |
Color and tint
| GetColor Method | Returns the name of the characters' color. |
| GetGray Method | Returns the characters' tint |
| GetHyp Method | Returns the hyphenation language. |
| GetKerning Method | Returns kerning between characters in millipoints. |
Hidden text
| GetMode Method | Returns the second parameter of the >rem...< GNML tag. |
| GetModeData Method | Returns the first parameter of the >rem...< GNML tag. |
| GetRemCode Method | Returns notes mode code, 0 when not in notes mode. |
Shadow and outline
| GetShadow Method | Returns shadow font variation, and it can be either true = set shadow or false = no shadow. |
| GetShadowEnlarge Method | Returns the value of the extra character spacing in the shadow. |
| GetShadowMoveX Method | Returns the value of the x offset in the shadow. |
| GetShadowMoveY Method | Returns the value of the Y offset in the shadow. |
| GetOutline Method | Returns TRUE if there's an outline font variation active. |
| GetSupColor Method | Returns the name of the shadow color or outline fill color. |
Underlines
| GetNUnderlines Method | Returns the number of defined underlines. |
| GetUColor Method | Returns the name of the color of the nIdx underline. |
| GetUFlags Method | Returns options for the nIdx underline. |
| GetGray Method | Returns tint of the nIdx underline. |
| GetUH Method | Returns the weight of the nIdx underline. |
| GetUY Method | Returns the vertical position of the nIdx underline. |
To create a TxtPosDesc object:
Dim objCur = Text.GetCursor(modeSrcOn,cposCursor,False)
Dim objdesc As TxtPosDesc = objCur.GetDesc
See also