Table of Contents

Class XlsxMergeData

Namespace
DocWright.MailMerge
Assembly
DocWright.MailMerge.dll

A recipient list read from an Excel workbook (Phase 167): a sheet's first row names the fields and each later row is a record, as Word's Mailings > Select Recipients reads one. Values are the cells' values as Word merges them (measured, tools/Probe-WordXlsxMerge.ps1): a number in full (0.1 is 0.10000000000000001, a currency or percent format ignored), a date as 1/15/2024, a boolean as True/False, a formula as its cached result, text as it is.

public sealed class XlsxMergeData
Inheritance
XlsxMergeData
Inherited Members

Remarks

The workbook is untrusted: at most MaxEntries package entries and MaxPartLength bytes per part read (from the entry headers, before inflating; the inflated bytes are counted too), no DTD, at most MaxFields columns and MaxValueLength characters a value.

Fields

DefaultMaxRecords

The most records read when the caller sets no limit.

MaxEntries

The most entries a workbook package may hold.

MaxPartLength

The largest part read, uncompressed.

Properties

FieldNames

Gets the field names, as merge fields name them (FieldName(string)).

Records

Gets the records, each a field name to its text.

Methods

CreateReader()

A reader over the records, for a merge.

Read(Stream, string?, int)

Reads a sheet as a recipient list.

SheetNames(Stream)

The names of a workbook's sheets, in order.