Class DocxMailMergeReport

Namespace

DocToolkit

Assembly

DocToolkit.Docx.dll

What happened to every merge field in a document.

public sealed class DocxMailMergeReport

Inheritance

object

DocxMailMergeReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Fields

Every merge field the template contained, in document order — one entry per occurrence, not per name. A name used twice in a letter, in the salutation and again in the body, appears twice. Measured.

public IReadOnlyList<DocxMailMergeField> Fields { get; }

Property Value

IReadOnlyList<DocxMailMergeField>

IsComplete

Whether every field in the template received a value.

public bool IsComplete { get; }

Property Value

bool

Remarks

True does not mean the document reads correctly. A supplied value that is an empty string merges and counts as complete, which is the honest report — the engine was given a value and used it. See DocxMailMerge for why a null value is refused rather than treated as one of these.

MergedCount

How many field occurrences received a value.

public int MergedCount { get; }

Property Value

int

MissingFieldNames

The distinct names no value was supplied for. Empty when IsComplete is true.

public IReadOnlyList<string> MissingFieldNames { get; }

Property Value

IReadOnlyList<string>