SubDocument.FormFields Property

Provides access to the collection of the document’s FormField objects.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

FormFieldCollection FormFields { get; }

VB.NET

ReadOnly Property FormFields As FormFieldCollection

Property Value

Type	Description
FormFieldCollection	A FormFieldCollection object that is the document’s check box form fields collection.

Remarks

Use the FormFieldCollection.InsertCheckBox method to create a new CheckBox form field.

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";