FieldMergingEventArgs Class

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

Provides data for the FieldMerging event.

public sealed class FieldMergingEventArgs
Public NotInheritable Class FieldMergingEventArgs
Inheritance:
System.Object
FieldMergingEventArgs
Remarks

For more information, see customize mail merge example.

Properties

Document

Gets the owner document.

public DocumentModel Document { get; }
Public ReadOnly Property Document As DocumentModel
Property Value
DocumentModel

The owner document.

Field

Gets the Field that will be replaced.

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

The Field that will be replaced.

FieldName

Gets the field name if Field type is MergeField, otherwise (if it is If, MergeRec or MergeSeq) null.

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

The field name if Field type is MergeField, otherwise (if it is If, MergeRec or MergeSeq) null.

Remarks

To successfully retrieve field name, InstructionInlines must contain only Runs.

Field's instruction text is then constructed by calling GetInstructionText() method and field name is parsed from the instruction text.

For more information, see customize mail merge example.

Inline

Gets or sets the Inline that will replace the Field.

public Inline Inline { get; set; }
Public Property Inline As Inline
Property Value
Inline

The Inline that will replace the Field.

Remarks

Value of this property depends on a value of the Inlines property.

If Inlines is not empty, this property represents the first Inline element from it, otherwise null.

Setting this property will automatically clear Inlines collection and will add new value to it, if value is not null.

Inlines

Gets the Inlines that will replace the Field.

public IList<Inline> Inlines { get; }
Public ReadOnly Property Inlines As IList(Of Inline)
Property Value
System.Collections.Generic.IList<Inline>

The Inlines that will replace the Field.

IsValueFound

Gets a value indicating whether a value was found in the data source.

public bool IsValueFound { get; }
Public ReadOnly Property IsValueFound As Boolean
Property Value
System.Boolean

true if a value was found in the data source; otherwise, false.

MergeContext

Gets the mail merge execution context.

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

The mail merge execution context.

Value

Gets the data source value for a specified Field.

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

The data source value for a specified Field.