Description
Inserts a text type form field at the current text input position in a RichTextEdit control. It is a text input field. If such a field is empty, it can be set to a specified width so that the users can see where to enter text.
Applies to
Syntax
rtename.FormTextFieldInsert(string text{, integer emptyWidth})
|
Argument |
Description |
|---|---|
|
text |
The text to display in the text input field. |
| emptyWidth | The width of the field, in twips, when the field is empty. If this parameter is omitted, a default width of 2000 twips is used. For almost all units of measurement in the RichTextEdit control, twips are used. Twip is a fabricated word meaning twentieth of a point (pt). |
Return value
Integer.
Returns a value greater than 0 if it succeeds and this value represents the unique ID of the form field that was successfully inserted. If any argument's value is null, returns null. Returns -1 if an error occurs.
Examples
This example inserts a text form field which shows "Please input text" in the text input field.
integer li_rtn
li_rtn = rte_1.FormTextFieldInsert("Please input text")
This example inserts a text form field without display text in the text input field.
integer li_rtn
li_rtn = rte_1.FormTextFieldInsert("",1000)
