Back to Devexpress

CheckBox Interface

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-6d92307e.md

latest2.8 KB
Original Source

CheckBox Interface

An interface implementing the check box functionality.

Namespace : DevExpress.XtraRichEdit.API.Native

Assembly : DevExpress.RichEdit.v25.2.Core.dll

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
public interface CheckBox :
    FormField
vb
Public Interface CheckBox
    Inherits FormField

The following members return CheckBox objects:

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

View Example

csharp
DocumentPosition currentPosition = server.Document.Range.Start;
DevExpress.XtraRichEdit.API.Native.CheckBox checkBox = server.Document.FormFields.InsertCheckBox(currentPosition);
checkBox.Name = "check1";
checkBox.State = CheckBoxState.Checked;
checkBox.SizeMode = CheckBoxSizeMode.Auto;
checkBox.HelpTextType = FormFieldTextType.Custom;
checkBox.HelpText = "help text";
vb
Dim currentPosition As DocumentPosition = server.Document.Range.Start
Dim checkBox As DevExpress.XtraRichEdit.API.Native.CheckBox = server.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

CheckBox Members

DevExpress.XtraRichEdit.API.Native Namespace