Skip to main content
.NET Framework 4.5.2+

FormFieldCollection.InsertCheckBox(DocumentPosition) Method

Inserts a CheckBox object at a given document position.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

CheckBox InsertCheckBox(
    DocumentPosition position
)

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

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

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.

See Also