FormFieldCollection.InsertCheckBox(DocumentPosition) Method

Inserts a CheckBox object at a given document position.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

CheckBox InsertCheckBox(
    DocumentPosition position
)

VB.NET

Function InsertCheckBox(
    position As DocumentPosition
) As CheckBox

Parameters

Name	Type	Description
position	DocumentPosition	A DocumentPosition object that is the position within the document to place the checkbox.

Returns

Type	Description
CheckBox	A CheckBox object that is the target checkbox.

Remarks

Note

Checkboxes cannot be inserted to the document header,footer, comment or floating objects (text boxes or shapes). Otherwise, an exception occurs.

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the InsertCheckBox(DocumentPosition) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.cs#L16

DocumentPosition currentPosition = document.CaretPosition;
DevExpress.XtraRichEdit.API.Native.CheckBox checkBox = document.FormFields.InsertCheckBox(currentPosition);
checkBox.Name = "check1";

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/FormFields.cs#L18

SubDocument currentDocument = currentPosition.BeginUpdateDocument();
DevExpress.XtraRichEdit.API.Native.CheckBox checkBox = document.FormFields.InsertCheckBox(currentPosition);
checkBox.Name = "check1";

word-document-api-examples/CS/CodeExamples/FormFieldsActions.cs#L17

DocumentPosition currentPosition = server.Document.Range.Start;
DevExpress.XtraRichEdit.API.Native.CheckBox checkBox = server.Document.FormFields.InsertCheckBox(currentPosition);
checkBox.Name = "check1";

VB.NET

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.vb#L13

Dim currentPosition As DocumentPosition = document.CaretPosition
Dim checkBox As DevExpress.XtraRichEdit.API.Native.CheckBox = document.FormFields.InsertCheckBox(currentPosition)
checkBox.Name = "check1"

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/FormFields.vb#L14

Dim currentPosition As DocumentPosition = document.CaretPosition
Dim checkBox As DevExpress.XtraRichEdit.API.Native.CheckBox = document.FormFields.InsertCheckBox(currentPosition)
checkBox.Name = "check1"

word-document-api-examples/VB/CodeExamples/FormFieldsActions.vb#L14

Dim currentPosition As DocumentPosition = server.Document.Range.Start
Dim checkBox As DevExpress.XtraRichEdit.API.Native.CheckBox = server.Document.FormFields.InsertCheckBox(currentPosition)
checkBox.Name = "check1"