Class DocxMailMergeBatchItem

Namespace

DocToolkit

Assembly

DocToolkit.Docx.dll

One record's document, from a batch call, together with what happened to every field in it.

public sealed class DocxMailMergeBatchItem

Inheritance

object

DocxMailMergeBatchItem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Returned by the lenient batch overloads only — MergeBatch(byte[], IEnumerable<IReadOnlyDictionary<string, string>>) refuses to produce a document for an incomplete record at all, so there is nothing to report for that record.

Properties

Document

The merged document — complete or not. When Report's IsComplete is false this still opens cleanly and looks finished; the unfilled fields show their placeholder text.

public byte[] Document { get; }

Property Value

byte[]

RecordIndex

The record's position in the sequence passed in, starting at 0.

public int RecordIndex { get; }

Property Value

int

Report

What happened to every field in this record's document.

public DocxMailMergeReport Report { get; }

Property Value

DocxMailMergeReport