MailMergeRecordStartedEventArgs.RecordDocument Property

Gets a template document before a record is merged.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public Document RecordDocument { get; }

VB.NET

Public ReadOnly Property RecordDocument As Document

Property Value

Type	Description
Document	A Document interface providing access to an interim document.

Remarks

The RecordDocument property enables you to modify a document template for each record individually. Use the MailMergeRecordStartedEventArgs.RecordIndex property to determine a current record.

Related GitHub Examples

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

how-to-use-document-variable-docvariable-fields-e3099/CS/DocumentVariablesExample/Form1.cs#L56

        private void richEditControl1_MailMergeRecordStarted(object sender, MailMergeRecordStartedEventArgs e) {
            DocumentRange _range = e.RecordDocument.InsertText(e.RecordDocument.Range.Start,
String.Format("Created on {0:G}\n\n", DateTime.Now));

VB.NET

how-to-use-document-variable-docvariable-fields-e3099/VB/DocumentVariablesExample/Form1.vb#L57

Private Sub richEditControl1_MailMergeRecordStarted(ByVal sender As Object, ByVal e As MailMergeRecordStartedEventArgs) Handles richEditControl1.MailMergeRecordStarted
    Dim _range As DocumentRange = e.RecordDocument.InsertText(e.RecordDocument.Range.Start, String.Format("Created on {0:G}" & vbLf & vbLf, Date.Now))
    Dim cp As CharacterProperties = e.RecordDocument.BeginUpdateCharacters(_range)