TXTextControl.FormCheckBoxInsert Method

This method inserts a checkbox field into the document at the current text input position.

Introduced: 28.0.

Syntax

TXTextControl.FormCheckBoxInsert IsChecked [, CheckedChar [, UncheckedChar]]
Parameter Description
IsChecked

Specifies whether the checkbox is initially checked.

CheckedChar

Optional. Specifies the character code of the checked symbol. This value must be the code of a character in the Unicode character set. If this parameter is omitted, the default character &H2612 is used.

UncheckedChar

Optional. Specifies the character code of the unchecked symbol. This value must be the code of a character in the Unicode character set. If this parameter is omitted, the default character &H2610 is used.

Return Value

The method returns True if the checkbox field could be inserted, otherwise it returns False.

Remarks

Inserting a form field changes the value of the FieldCurrent property to the identifier of the newly created field.

Data Types

IsChecked: Boolean
CheckedChar: Integer
UncheckedChar: Integer

See Also