FieldCollection.Create(DocumentRange) Method

Creates a field from the specified range and adds it to the field collection.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

Field Create(
    DocumentRange range
)

VB.NET

Function Create(
    range As DocumentRange
) As Field

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange object specifying a range to be transformed to a field.

Returns

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

Remarks

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

This code snippet creates a field from the selected range so that the selected text becomes the field code.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Field.vb

document.BeginUpdate()
'Insert the text to the document end
document.AppendText("SYMBOL 0x54 \f Wingdings \s 24")
document.EndUpdate()

'Convert the inserted text to the field 
document.Fields.Create(document.Paragraphs(0).Range)
document.Fields.Update()

Field.cs

document.BeginUpdate();
//Insert the text to the document end
document.AppendText("SYMBOL 0x54 \\f Wingdings \\s 24");
document.EndUpdate();

//Convert the inserted text to the field 
document.Fields.Create(document.Paragraphs[0].Range);
document.Fields.Update();

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Create(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#

dxrichedit-for-wpf-fields-in-the-document-the-basics-e3269/CS/MainWindow.xaml.cs#L54

    Document document = richEditControl1.Document;
    document.Fields.Create(document.Selection);
}

fields-in-the-document-the-basics-e1605/CS/Form1.cs#L65

#region #FieldFromRange
richEditControl1.Document.Fields.Create(richEditControl1.Document.Selection);
#endregion #FieldFromRange

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/DocumentFieldActions.cs#L56

document.EndUpdate();
document.Fields.Create(document.Paragraphs[0].Range);
document.Fields.Update();

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Field.cs#L66

//Convert the inserted text to the field
document.Fields.Create(document.Paragraphs[0].Range);
document.Fields.Update();

word-document-api-examples/CS/CodeExamples/FieldActions.cs#L51

document.EndUpdate();
document.Fields.Create(document.Paragraphs[0].Range);
document.Fields.Update();

VB.NET

dxrichedit-for-wpf-fields-in-the-document-the-basics-e3269/VB/MainWindow.xaml.vb#L60

    Dim document As Document = richEditControl1.Document
    document.Fields.Create(document.Selection)
End Sub

fields-in-the-document-the-basics-e1605/VB/Form1.vb#L60

'            #Region "#FieldFromRange"
            richEditControl1.Document.Fields.Create(richEditControl1.Document.Selection)
'            #End Region ' #FieldFromRange

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/DocumentFieldActions.vb#L49

document.EndUpdate()
document.Fields.Create(document.Paragraphs(0).Range)
document.Fields.Update()

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Field.vb#L60

'Convert the inserted text to the field
document.Fields.Create(document.Paragraphs(0).Range)
document.Fields.Update()

word-document-api-examples/VB/CodeExamples/FieldActions.vb#L44

document.EndUpdate()
document.Fields.Create(document.Paragraphs(0).Range)
document.Fields.Update()