MailMerge

MailMerge class

表示邮件合并功能。

public class MailMerge

特性

姓名 描述
CleanupOptions { get; set; } 获取或设置一组标志，指定在邮件合并期间应删除哪些项目。
CleanupParagraphsWithPunctuationMarks { get; set; } 获取或设置一个值，该值指示带有标点符号的段落是否被视为空 ，如果RemoveEmptyParagraphs选项已指定。
FieldMergingCallback { get; set; } 在文档中遇到邮件合并字段时在邮件合并期间发生。
MailMergeCallback { get; set; } 允许在邮件合并期间处理特定事件。
MappedDataFields { get; } 返回代表邮件合并操作的映射数据字段的集合。
MergeDuplicateRegions { get; set; } 获取或设置一个值，该值指示在针对数据源执行与区域的邮件合并时，是否应合并具有数据源 名称的所有文档邮件合并区域，或者仅合并第一个。
MergeWholeDocument { get; set; } 获取或设置一个值，该值指示在执行与区域的邮件合并时是否更新整个文档中的字段。
PreserveUnusedTags { get; set; } 获取或设置一个值，指示是否应保留未使用的“小胡子”标签。
RegionEndTag { get; set; } 获取或设置邮件合并区域结束标记。
RegionStartTag { get; set; } 获取或设置邮件合并区域开始标记。
RestartListsAtEachSection { get; set; } 获取或设置一个值，该值指示是否在执行邮件合并后在每个部分重新启动列表。
RetainFirstSectionStart { get; set; } 获取或设置一个值，指示是否SectionStart第一个文档部分及其后续数据源 rows 的副本在邮件合并期间保留或根据 MS Word 行为进行更新。
TrimWhitespaces { get; set; } 获取或设置一个值，该值指示是否从邮件合并值中修剪尾随和前导空格。
UnconditionalMergeFieldsAndRegions { get; set; } 获取或设置一个值，该值指示是否合并合并字段和合并区域，而不考虑父 IF 字段的条件。
UseNonMergeFields { get; set; } 为真时，指定除了 MERGEFIELD 字段外，邮件合并到一些其他类型的字段中， 也合并到“{{fieldName}}”标签中。
UseWholeParagraphAsRegion { get; set; } 获取或设置一个值，该值指示是否应将带有 TableStart 或 TableEnd 字段 的整个段落或 TableStart 和 TableEnd 字段之间的特定范围包含到邮件合并区域中。

方法

姓名 描述
DeleteFields() 从文档中删除与邮件合并相关的字段。
Execute(DataRow) 将数据行中的邮件合并到文档中。
Execute(DataTable) 将数据表中的邮件合并到文档中。
Execute(DataView) 执行从 DataView 到文档的邮件合并。
Execute(IDataReader) 将邮件从 IDataReader 合并到文档中。
Execute(IMailMergeDataSource) 从自定义数据源执行邮件合并。
Execute(string[], object[]) 对单个记录执行邮件合并操作。
ExecuteADO(object) 执行从 ADO Recordset 对象到文档的邮件合并。
ExecuteWithRegions(DataSet) 将数据集的邮件合并到具有邮件合并区域的文档中。
ExecuteWithRegions(DataTable) 将数据表中的邮件合并到带有邮件合并区域的文档中。
ExecuteWithRegions(DataView) 将数据视图中的邮件合并到带有邮件合并区域的文档中。
ExecuteWithRegions(IMailMergeDataSource) 使用邮件合并区域从自定义数据源执行邮件合并。
ExecuteWithRegions(IMailMergeDataSourceRoot) 使用邮件合并区域从自定义数据源执行邮件合并。
ExecuteWithRegions(IDataReader, string) 执行从 IDataReader 到具有邮件合并区域的文档的邮件合并。
ExecuteWithRegionsADO(object, string) 执行从 ADO 记录集对象到具有邮件合并区域的文档的邮件合并。
GetFieldNames() 返回文档中可用的邮件合并字段名称的集合。
GetFieldNamesForRegion(string) 返回区域中可用的邮件合并字段名称的集合。
GetFieldNamesForRegion(string, int) 返回区域中可用的邮件合并字段名称的集合。
GetRegionsByName(string) 返回具有指定名称的邮件合并区域的集合。
GetRegionsHierarchy() 返回文档中可用区域（带字段）的完整层次结构。

评论

要使邮件合并操作正常工作，文档应包含 Word MERGEFIELD 和 （可选的 NEXT 字段）。在邮件合并操作期间，文档中的合并字段将 替换为您的数据源中的值。

使用邮件合并有两种不同的方式：使用邮件合并区域和不使用邮件合并区域。

最简单的邮件合并是没有区域的，它与 Word 中的邮件 merge 的工作方式非常相似。利用执行合并来自 some 数据源的信息的方法，例如 数据表, 数据集, 数据视图, 数据读取器 或一个对象数组到您的文档中。 The 邮件合并对象处理数据源的所有记录，并为每条记录复制和附加整个文档的内容。

请注意，当 邮件合并对象遇到 NEXT 字段，它选择数据源中的下一个 record 并继续合并而不复制任何内容。

利用ExecuteWithRegions将信息合并到定义了邮件合并区域的 a 文档中的方法。你可以使用 数据集, 数据表, 数据视图或者 数据读取器 作为此操作的数据源。

如果要在 文档中动态增长部分，则需要使用邮件合并区域。如果没有邮件合并区域，整个文档将针对 数据源的每条记录重复。

例子

演示如何使用 DataTable 中的数据执行邮件合并。

public void ExecuteDataTable()
{
    DataTable table = new DataTable("Test");
    table.Columns.Add("CustomerName");
    table.Columns.Add("Address");
    table.Rows.Add(new object[] { "Thomas Hardy", "120 Hanover Sq., London" });
    table.Rows.Add(new object[] { "Paolo Accorti", "Via Monte Bianco 34, Torino" });

    // 下面是使用 DataTable 作为邮件合并数据源的两种方式。
    // 1 - 使用整个表进行邮件合并，为表中的每一行创建一个输出邮件合并文档：
    Document doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.WholeTable.docx");

    // 2 - 使用表格的一行创建一个输出邮件合并文档：
    doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table.Rows[1]);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.OneRow.docx");
}

/// <summary>
/// 创建邮件合并源文档。
/// </summary>
private static Document CreateSourceDocExecuteDataTable()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    builder.InsertField(" MERGEFIELD CustomerName ");
    builder.InsertParagraph();
    builder.InsertField(" MERGEFIELD Address ");

    return doc;
}

也可以看看

ImageFieldMergingArgs MailMergeCleanupOptions