Field.CodeRange Property

Gets the range containing the field codes.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

DocumentRange CodeRange { get; }

VB.NET

ReadOnly Property CodeRange As DocumentRange

Property Value

Type	Description
DocumentRange	A DocumentRange object representing the range occupied by the field’s code.

Remarks

Use the CodeRange method to check field codes or to modify them.

Note

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

Field.vb

document.BeginUpdate()

'Create a DATE field at the caret position
document.Fields.Create(document.CaretPosition, "DATE")
document.EndUpdate()
For i As Integer = 0 To document.Fields.Count - 1
    Dim fieldCode As String = document.GetText(document.Fields(i).CodeRange)
    If fieldCode = "DATE" Then
        'Retrieve the range obtained by the field code
        Dim position As DocumentPosition = document.Fields(i).CodeRange.End

        'Insert the format switch to the end of the field code range
        document.InsertText(position, "\@ ""M/d/yyyy h:mm am/pm""")
    End If
Next i

'Update all document fields
document.Fields.Update()

Field.cs

document.BeginUpdate();

//Create a DATE field at the caret position
document.Fields.Create(document.CaretPosition, "DATE");
document.EndUpdate();
for (int i = 0; i < document.Fields.Count; i++)
{
    string fieldCode = document.GetText(document.Fields[i].CodeRange);
    if (fieldCode == "DATE")
    {
        //Retrieve the range obtained by the field code
        DocumentPosition position = document.Fields[i].CodeRange.End;

        //Insert the format switch to the end of the field code range
        document.InsertText(position, @"\@ ""M/d/yyyy h:mm am/pm""");
    }
}

//Update all document fields
document.Fields.Update();

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CodeRange property.

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#

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Export.cs#L79

foreach (Field item in document.Fields) {
    string fieldCode = document.GetText(item.CodeRange);
    string[] fieldParts = fieldCode.Split(' ');

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

Document document = richEditControl1.Document;
string fieldCode = document.GetText(document.Fields[0].CodeRange);
if (!fieldCode.Contains("\\@")) {

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

{
    string fieldCode = document.GetText(document.Fields[i].CodeRange);
    if (fieldCode == "DATE")

how-to-dynamically-generate-table-of-contents-by-adding-toc-field-with-different-nesting-l-t424524/CS/WindowsFormsApplication1/Form1.cs#L29

Field currentField = richEditControl1.Document.Fields[i];
string fieldCode = richEditControl1.Document.GetText(currentField.CodeRange);
if(fieldCode.Contains("TOC")) {

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

{
    string fieldCode = document.GetText(document.Fields[i].CodeRange);
    if (fieldCode == "DATE")

VB.NET

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

For i As Integer = 0 To currentDocument.Fields.Count - 1
    Dim fieldCode As String = document.GetText(currentDocument.Fields(i).CodeRange)
    If fieldCode = "DATE" Then

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

Dim document As Document = richEditControl1.Document
Dim fieldCode As String = document.GetText(document.Fields(0).CodeRange)
If Not fieldCode.Contains("\@") Then

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

For i As Integer = 0 To document.Fields.Count - 1
    Dim fieldCode As String = document.GetText(document.Fields(i).CodeRange)
    If fieldCode = "DATE" Then

how-to-dynamically-generate-table-of-contents-by-adding-toc-field-with-different-nesting-l-t424524/VB/WindowsFormsApplication1/Form1.vb#L33

Dim currentField As Field = richEditControl1.Document.Fields(i)
Dim fieldCode As String = richEditControl1.Document.GetText(currentField.CodeRange)
If fieldCode.Contains("TOC") Then

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

For i As Integer = 0 To currentDocument.Fields.Count - 1
    Dim fieldCode As String = document.GetText(currentDocument.Fields(i).CodeRange)
    If fieldCode = "DATE" Then