CheckBox Interface

An interface implementing the check box functionality.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

public interface CheckBox :
    FormField

VB.NET

Public Interface CheckBox
    Inherits FormField

Related API Members

The following members return CheckBox objects:

• FormFieldCollection.InsertCheckBox(DocumentPosition)

Remarks

Call the FormFieldCollection.InsertCheckBox method to create a checkbox at a given document position. The CheckBox objects are contained in the FormFieldCollection (can be accessed using the SubDocument.FormFields property). To distinguish checkboxes within the collection, check the collection item’s FormField.FieldType property.

Example

The following code sample shows how to create a checkbox on a caret’s position:

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

FormFields.vb

Dim currentPosition As DocumentPosition = document.CaretPosition
Dim checkBox As DevExpress.XtraRichEdit.API.Native.CheckBox = document.FormFields.InsertCheckBox(currentPosition)
checkBox.Name = "check1"
checkBox.State = CheckBoxState.Checked
checkBox.SizeMode = CheckBoxSizeMode.Auto
checkBox.HelpTextType = FormFieldTextType.Custom
checkBox.HelpText = "help text"

FormFields.cs

DocumentPosition currentPosition = document.CaretPosition;
DevExpress.XtraRichEdit.API.Native.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";