FormCheckBoxInsert
PowerScript function
Description
Inserts a checkbox type form field at the current text input
position in a RichTextEdit control. Users can click the checkbox form
field to change the field value if necessary.
Applies to
Syntax
|
1 |
rtename.FormCheckBoxInsert(boolean checked{, char checkedChar, char uncheckedChar}) |
|
Argument |
Description |
|---|---|
|
checked |
The status of the checkbox when it is initially |
|
checkedChar |
The character to show in the field if the checked status |
| uncheckedChar | The character to show in the fieldif the checked status is false. You can only pass one character to the argument, for example, T. The default value is 0x25A1, which is  . |
Return value
Integer.
Returns a value greater than 0 if it succeeds and this value
represents the unique ID of the form field that was successfully inserted.
If any argument’s value is null, returns null. Returns -1 if an error
occurs.
If the checkedchar or uncheckedchar argument is used but is not
assigned with a value, returns -1, and the form field is not
inserted.
Examples
This example inserts a checkbox form field which shows
:
|
1 2 |
integer li_rtn li_rtn = rte_1.FormCheckBoxInsert(false) |
This example inserts a checkbox form field which shows the
corresponding character (Y or N):
|
1 2 |
integer li_rtn li_rtn = rte_1.FormCheckBoxInsert(true,"Y","N") |