FormFieldGetDeletable

Description

Gets the deletable setting of the specified form field. The type of the form field may be FormFieldCheckBox, FormFieldComboBox, FormFieldText, and FormFieldDate.

Applies to

RichTextEdit control

Syntax

rtename.FormFieldGetDeleteable(integer fieldID)

Argument

Description

fieldID

The unique ID assigned to the form field.


Return value

Integer. The following are the possible return values and their description:

1 (Default value) -- The form field can be deleted by pressing the keyboard key, or by calling the corresponding delete function (for example, FormFieldDelete, or ClearAll).

0 -- The form field cannot be deleted by pressing the keyboard key, but can be deleted by calling the corresponding delete function (for example, FormFieldDelete, or ClearAll).

-1 -- Failure.

-2 -- The field ID does not exist, is illegal or is not a form field.

null -- Null argument.

Examples

This example gets the deletable setting of the specified form field.

integer li_formid,li_rtn

li_formid = rte_1.FormCheckBoxInsert(true)
li_rtn = rte_1.FormFieldGetDeletable(li_formid)
messagebox("",string(li_rtn))