FieldCollection.Add(DocumentRange) Method

OBSOLETE

This method has become obsolete. Use the 'Create' method instead.

Create a field from the specified range and add it to the field collection.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[Obsolete("This method has become obsolete. Use the 'Create' method instead.")]
Field Add(
    DocumentRange range
)

VB.NET

<Obsolete("This method has become obsolete. Use the 'Create' method instead.")>
Function Add(
    range As DocumentRange
) As Field

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange representing a range transformed to a field.

Returns

Type	Description
Field	A Field object representing the newly created field.

Remarks

The Add method transforms the specified range to the field. The text content of the range becomes the code of the newly created field.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Add(DocumentRange) 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#

how-to-create-nested-fields-programmatically-e4004/CS/Form1.cs#L23

foreach (DocumentRange range in dvFieldRanges) {
    richEditControl1.Document.Fields.Add(range);
}