.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
A newer version of this page is available. Switch to the current version.

CheckBox Interface

An interface implementing the check box functionality.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

public interface CheckBox :
    FormField
Public Interface CheckBox
    Inherits FormField

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.

Examples

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

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"
See Also