MappedDataFieldCollection

MappedDataFieldCollection class

允许在数据源 中的字段名称与文档中的邮件合并字段名称之间自动映射。

要了解更多信息，请访问邮件合并和报告文档文章。

public class MappedDataFieldCollection : IEnumerable<KeyValuePair<string, string>>

特性

姓名描述
Count { get; }获取集合中包含的元素数量。
Item { get; set; }获取或设置数据源中与指定邮件合并字段关联的字段名称。

方法

姓名描述
Add(string, string)添加新字段映射。
Clear()从集合中删除所有元素。
ContainsKey(string)确定集合中是否存在文档中指定字段的映射。
ContainsValue(string)确定集合中是否存在来自数据源中指定字段的映射。
GetEnumerator()返回一个字典枚举器对象，可用于迭代集合中的所有项目。
Remove(string)删除字段映射。

评论

这是作为字符串键到字符串值的集合来实现的。 键是文档中邮件合并字段的名称，值 是数据源中字段的名称。

例子

演示如何映射具有不同名称的数据列和 MERGEFIELD，以便在邮件合并期间在它们之间传输数据。

public void MappedDataFieldCollection()
{
    Document doc = CreateSourceDocMappedDataFields();
    DataTable dataTable = CreateSourceTableMappedDataFields();

    // 该表有一列名为“Column2”，但没有具有该名称的 MERGEFIELD。
    // 另外，我们有一个名为“Column3”的 MERGEFIELD，但数据源没有具有该名称的列。
    // 如果“Column2”中的数据适合“Column3”MERGEFIELD，
    // 我们可以将该列名称映射到“MappedDataFields”键/值对中的 MERGEFIELD。
    MappedDataFieldCollection mappedDataFields = doc.MailMerge.MappedDataFields;

    // 我们可以像这样将数据源列名称链接到 MERGEFIELD 名称。
    mappedDataFields.Add("MergeFieldName", "DataSourceColumnName");

    // 将名为“Column2”的数据源列链接到名为“Column3”的 MERGEFIELD。
    mappedDataFields.Add("Column3", "Column2");

    // MERGEFIELD 名称是相应数据源列名称“值”的“键”。
    Assert.AreEqual("DataSourceColumnName", mappedDataFields["MergeFieldName"]);
    Assert.True(mappedDataFields.ContainsKey("MergeFieldName"));
    Assert.True(mappedDataFields.ContainsValue("DataSourceColumnName"));

    // 现在，如果我们运行此邮件合并，“Column3”MERGEFIELD 将从表的“Column2”中获取数据。
    doc.MailMerge.Execute(dataTable);

    doc.Save(ArtifactsDir + "MailMerge.MappedDataFieldCollection.docx");

    // 我们可以迭代这个集合中的元素。
    Assert.AreEqual(2, mappedDataFields.Count);

    using (IEnumerator<KeyValuePair<string, string>> enumerator = mappedDataFields.GetEnumerator())
        while (enumerator.MoveNext())
            Console.WriteLine(
                $"Column named {enumerator.Current.Value} is mapped to MERGEFIELDs named {enumerator.Current.Key}");

    // 我们还可以从集合中删除元素。
    mappedDataFields.Remove("MergeFieldName");

    Assert.False(mappedDataFields.ContainsKey("MergeFieldName"));
    Assert.False(mappedDataFields.ContainsValue("DataSourceColumnName"));

    mappedDataFields.Clear();

    Assert.AreEqual(0, mappedDataFields.Count);
}

/// <summary>
/// 创建一个包含 2 个 MERGEFIELD 的文档，其中一个没有
/// 通过下面的方法得到数据表中的相应列。
/// </summary>
private static Document CreateSourceDocMappedDataFields()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    builder.InsertField(" MERGEFIELD Column1");
    builder.Write(", ");
    builder.InsertField(" MERGEFIELD Column3");

    return doc;
}

/// <summary>
/// 创建一个有2列的数据表，其中一列没有
/// 上面方法中源文档中对应的MERGEFIELD。
/// </summary>
private static DataTable CreateSourceTableMappedDataFields()
{
    DataTable dataTable = new DataTable("MyTable");
    dataTable.Columns.Add("Column1");
    dataTable.Columns.Add("Column2");
    dataTable.Rows.Add(new object[] { "Value1", "Value2" });

    return dataTable;
}

也可以看看

MailMergeRegionInfo Class MustacheTag Class