IMailMergeDataSource Interface

Namespace:

GemBox.Document.MailMerging

Assembly:

GemBox.Document.dll

Represents a mail merge data source. By adapting your custom data source to implement this interface, you can use it as a data source in mail merging.

• C#
• VB.NET

public interface IMailMergeDataSource

Public Interface IMailMergeDataSource

Remarks

For more information, see mail merge.

Properties

Name

Gets the data source name. Used in ranged mail merging.

• C#
• VB.NET

string Name { get; }

ReadOnly Property Name As String

Property Value

String

The data source name.

Methods

MoveNext()

Moves to the next record in the data source.

• C#
• VB.NET

bool MoveNext()

Function MoveNext As Boolean

Returns

Boolean

true if next record is available; otherwise false.

TryGetValue(String, out Object)

Tries to get the value with a name (column / property / relation name) equal to valueName from the current record in data source.

• C#
• VB.NET

bool TryGetValue(string valueName, out object value)

Function TryGetValue(valueName As String, ByRef value As Object) As Boolean

Parameters

valueName

String

The value (column / property /relation) name.

value

Object

The value.

Returns

Boolean

true if the current record has a value with a name equal to valueName.