MailMergeContext Class

Namespace:
GemBox.Document.MailMerging
Assembly:
GemBox.Document.dll

Represents the mail merge execution context.

public sealed class MailMergeContext
Public NotInheritable Class MailMergeContext
Inheritance:
System.Object
MailMergeContext

Properties

ParentContext

Gets the parent mail merge execution context or null if this is the root mail merge execution context.

public MailMergeContext ParentContext { get; }
Public ReadOnly Property ParentContext As MailMergeContext
Property Value
MailMergeContext

The parent mail merge execution context or null if this is the root mail merge execution context.

RangeEndField

Gets the Field that represents the end of the mail merge range.

public Field RangeEndField { get; }
Public ReadOnly Property RangeEndField As Field
Property Value
Field

The Field that is the end of the mail merge range.

RangeName

Gets the mail merge range name.

public string RangeName { get; }
Public ReadOnly Property RangeName As String
Property Value
System.String

The mail merge range name.

RangeStartField

Gets the Field that represents the start of the mail merge range.

public Field RangeStartField { get; }
Public ReadOnly Property RangeStartField As Field
Property Value
Field

The Field that is the start of the mail merge range.

Record

Gets the data source record.

public object Record { get; }
Public ReadOnly Property Record As Object
Property Value
System.Object

The data source record.

RecordIndex

Gets the data source record index.

public int RecordIndex { get; }
Public ReadOnly Property RecordIndex As Integer
Property Value
System.Int32

The data source record index.

Remarks

Record index starts from 0.

Methods

ToString()

Returns a System.String that represents this MailMergeContext instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this MailMergeContext instance.

Overrides
System.Object.ToString()
Remarks

This method should be used primarily for debugging purposes and format of its return value might change in future versions.