How to: Create a Checkbox Form Field
- 2 minutes to read
The RichEditControl allows you to view and export a document containing checkbox form fields. These form fields are interactive, so users can toggle their state as needed. The resulting document can be exported to PDF or HTML format.
Important
Rich
#Checkboxes in API
Use members from the table below to manage checkboxes in code.
API | Description |
---|---|
Form |
Inserts a checkbox form field to a given document position and adds the created CheckForm occurs on attempt to insert the checkbox into a comment, header, footer or text box. |
Form |
Specifies a bookmark name associated with the checkbox. |
Check |
Gets or sets the checkbox’s state. |
Check |
Defines the checkbox’s size mode. Use the Check |
Form Form |
Specifies the instructional text type that accompanies the checkbox. |
Form Form |
Gets or sets the checkbox’s instructional text. With the ... property set to Form... property value is equal to one of the document’s Auto |
The following code sample shows how to create a checkbox on a caret’s position:
using DevExpress.XtraRichEdit.API.Native;
Document document = richEditControl.Document;
DocumentPosition currentPosition = document.CaretPosition;
CheckBox checkBox = document.FormFields.InsertCheckBox(currentPosition);
checkBox.Name = "check1";
checkBox.State = CheckBoxState.Checked;
checkBox.SizeMode = CheckBoxSizeMode.Auto;
checkBox.HelpTextType = FormFieldTextType.Custom;
checkBox.HelpText = "help text";
#Checkboxes in the User Interface
End-users can change the checkbox’s state by double-clicking the object. The state defined by an end-user is passed to the CheckBox.DefaultState property.
Note
Rich
- It does not provide user interface elements to manage checkboxes.
- It cannot display instructional text provided for the checkbox.
- It does not support macros assigned to the checkbox.