FormFieldCollection Interface

The collection of FormField objects.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

public interface FormFieldCollection :
    ReadOnlyFormFieldCollection,
    ISimpleCollection<FormField>,
    IEnumerable<FormField>,
    IEnumerable,
    ICollection

VB.NET

Public Interface FormFieldCollection
    Inherits ReadOnlyFormFieldCollection,
             ISimpleCollection(Of FormField),
             IEnumerable(Of FormField),
             IEnumerable,
             ICollection

Related API Members

The following members return FormFieldCollection objects:

• SubDocument.FormFields

Remarks

Access the FormFieldCollection collection using the SubDocument.FormFields 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";