Description
Sets the empty width (that is, the width of the field when there is no text displayed) for a form field. The type of the form field may be FormFieldCheckBox, FormFieldComboBox, FormFieldText, and FormFieldDate.
Applies to
Syntax
rtename.FormFieldSetEmptyWidth (integer fieldID, integer width)
|
Argument |
Description |
|---|---|
|
fieldID |
The unique ID assigned to the form field. |
| width | The width, in twips, when the form 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 1 if it succeeds. Returns -1 if an error occurs, or if the field ID maps to a checkbox form field. Returns -2 if the fieldID is non-existent, illegal, or not of the required type, or if the field ID maps to a non-form field. If any argument's value is null, returns null.
Examples
This example sets the empty width of the specified form field to 1000 twips.
integer li_formid,li_rtn
li_formid = rte_1.FormTextFieldInsert("")
li_rtn = rte_1.FormFieldSetEmptyWidth(li_formid,1000)
messagebox("",string(li_rtn))
