RichEditMailMergeOptions.ActiveRecord Property

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v22.1.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