RichEditMailMergeOptions.ActiveRecord Property

Specifies the index of a data record displayed by fields in a mail merge document.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[Browsable(false)]
public int ActiveRecord { get; set; }

VB.NET

<Browsable(False)>
Public Property ActiveRecord As Integer

Property Value

Type	Description
Int32	The ordinal number of a record in a data source.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ActiveRecord
RichEditControlOptionsBase	.MailMerge .ActiveRecord

Remarks

When the RichEditMailMergeOptions.ViewMergedData property is enabled, a field displays the data record with the index specified by the ActiveRecord property.

The code example below makes document fields display the tenth data record:

C#

this.richEditControl1.LoadDocument(documentFile);

var document = this.richEditControl1.Document;
document.InsertText(document.Range.End, " ");
document.Fields.Create(document.Range.End, @"MERGEFIELD FirstName");

richEditControl1.Options.MailMerge.DataSource = table;
richEditControl1.Options.MailMerge.ViewMergedData = true;
richEditControl1.Options.MailMerge.ActiveRecord = 10;

VB.NET

Me.richEditControl1.LoadDocument(documentFile)
Dim document = Me.richEditControl1.Document
document.InsertText(document.Range.End, " ")
document.Fields.Create(document.Range.End, "MERGEFIELD FirstName")

richEditControl1.Options.MailMerge.DataSource = table
richEditControl1.Options.MailMerge.ViewMergedData = True
richEditControl1.Options.MailMerge.ActiveRecord = 10

Related GitHub Examples

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

mail-merge-in-a-richeditcontrol/CS/MailMerge/Form1.cs#L65

// Navigate to a previous data source record
if (richEditControl1.Options.MailMerge.ActiveRecord > 0)
    richEditControl1.Options.MailMerge.ActiveRecord--;

VB.NET

mail-merge-in-a-richeditcontrol/VB/MailMerge/Form1.vb#L60

    'Navigate to the previous data source record
    If richEditControl1.Options.MailMerge.ActiveRecord > 0 Then richEditControl1.Options.MailMerge.ActiveRecord -= 1
End Sub