Description
Sets whether a form field is deletable by pressing the keyboard key. The type of the form field may be FormFieldCheckBox, FormFieldComboBox, FormFieldText, and FormFieldDate.
When a form field is newly-inserted, it is deletable. If the deletable is set to false, it is not deletable by pressing the keyboard key, but can still be deletable by calling the corresponding delete function (for example, FormFieldDelete, or ClearAll),
Applies to
Syntax
rtename.FormFieldSetDeleteable(integer fieldID, boolean deleteable)
|
Argument |
Description |
|---|---|
|
fieldID |
The unique ID assigned to the form field. |
| deletable | Specifies whether the form field is deletable by pressing the keyboard key. True means deletable, and false means not deletable. |
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 sets the form field (fieldID: 22) as not deletable by pressing the keyboard key.
integer li_n li_n = rte_1.FormFieldSetDeletable(22, false)
