Description
Returns the text of a text frame in the RichTextEdit control.
Applies to
Syntax
string rtename.TextFrameGetText(integer textFrameID)
string TextFrameGetText(integer textFrameID, long start, long length)
|
Argument |
Description |
|---|---|
|
textFrameID |
The unique ID that identifies the text frame. |
| start | The starting position of the text in the text frame. 0 means the start of the text. |
| length | The length of the text to get from the text frame. -1 means till the end of the text. |
Return value
String.
Returns the text in the text frame. If the start and length arguments are not specified, returns the full text. Otherwise, returns the specified text.
Returns null if any argument is null.
Examples
The following example gets the text in the specified text frame.
string ls_rtn
integer li_frameid
li_frameid = rte_1.TextFrameInsertAsChar(-1,5000,1000)
rte_1.TextFrameSetText(li_frameid,"Test ABC 456!")
//getting whole text
ls_rtn = rte_1.TextFrameGetText(li_frameid)
messagebox("TextFrameSetText",ls_rtn)
//getting part text
ls_rtn = rte_1.TextFrameGetText(li_frameid,5,3)
messagebox("TextFrameSetText",ls_rtn)
