Description
Deletes the specified form field. The type of the form field may be FormFieldCheckBox, FormFieldComboBox, FormFieldText, and FormFieldDate.
Applies to
Syntax
rtename.integer FormFieldDelete(integer fieldID, boolean deleteTotal)
Argument |
Description |
---|---|
fieldID |
The unique ID assigned to the form field. |
deleteTotal | True means deleting the field completely. False means changing the form field to plain text. |
Return value
Integer.
Returns 1 if it succeeds. Returns -1 if an error occurs. Returns -2 if the fieldID is non-existent, illegal, or not of the required type. If any argument's value is null, returns null.
Examples
This example changes the specified form field to plain text.
integer li_formid,li_rtn li_formid = rte_1.FormCheckBoxInsert(false) li_rtn = rte_1.FormFieldDelete(li_formid,false) messagebox("",string(li_rtn))