FormCheckBoxGetChecked

Description

Gets the checked status of the checkbox form field at the given field ID.

Applies to

RichTextEdit control

Syntax

rtename.FormCheckBoxGetChecked(integer fieldID)

Argument

Description

fieldID

The unique ID assigned to the checkbox form field.


Return value

Boolean.

Returns true if the field is selected, returns false if the field is not selected or the function fails, and returns null if the argument is null.

Examples

This example inserts a checkbox form field, and then calls the FormCheckBoxGetChecked function to get its status:

integer li_formid
boolean lb_rtn

li_formid = rte_1.FormCheckBoxInsert(true)
lb_rtn = rte_1.FormCheckBoxGetChecked(li_formid)