GetChildDataSource

IMailMergeDataSource.GetChildDataSource method

Aspose.Words 邮件合并引擎在遇到嵌套邮件合并区域的开头时调用此方法。

public IMailMergeDataSource GetChildDataSource(string tableName)
范围类型描述
tableNameString模板文档中指定的邮件合并区域的名称。不区分大小写。

返回值

提供对指定表的数据记录的访问的数据源对象。

评论

当 Aspose.Words 邮件合并引擎用数据填充邮件合并区域并遇到嵌套 邮件合并区域的开头（形式为 MERGEFIELD TableStart:TableName）时，它会调用GetChildDataSource在 current 数据源对象上。您的实现需要返回一个新的数据源对象，该对象将提供对当前父记录的 child 记录的访问。Aspose.Words 将使用返回的数据源来填充嵌套的邮件合并区域。

以下是实施的规则GetChildDataSource必须遵循。

如果此数据源对象所表示的表具有指定名称的相关子（详细）表， 则您的实现需要返回一个新的IMailMergeDataSource对象将提供对当前记录子记录的访问权限。例如，Orders / OrderDetails 关系。假设当前IMailMergeDataSourceobject 代表 Orders 表，其中包含一条当前订单记录。接下来，Aspose.Words 在文档中遇到 “MERGEFIELD TableStart:OrderDetails” 并调用GetChildDataSource您需要创建并返回一个IMailMergeDataSource 对象将允许 Aspose.Words 访问当前订单的 OrderDetails 记录。

如果此数据源对象与指定名称的表没有关系，则需要返回 IMailMergeDataSource提供对指定表的所有记录的访问的对象。

如果具有指定名称的表不存在，则您的实现应该返回无效的.

例子

展示如何以自定义对象的形式执行与数据源的邮件合并。

public void CustomDataSource()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);
    builder.InsertField(" MERGEFIELD FullName ");
    builder.InsertParagraph();
    builder.InsertField(" MERGEFIELD Address ");

    List<Customer> customers = new List<Customer>
    {
        new Customer("Thomas Hardy", "120 Hanover Sq., London"),
        new Customer("Paolo Accorti", "Via Monte Bianco 34, Torino")
    };

     // 要使用自定义对象作为数据源，它必须实现 IMailMergeDataSource 接口。
    CustomerMailMergeDataSource dataSource = new CustomerMailMergeDataSource(customers);

    doc.MailMerge.Execute(dataSource);

    doc.Save(ArtifactsDir + "MailMergeCustom.CustomDataSource.docx");
}

/// <summary>
/// 您的应用程序中“数据实体”类的示例。
/// </summary>
public class Customer
{
    public Customer(string aFullName, string anAddress)
    {
        FullName = aFullName;
        Address = anAddress;
    }

    public string FullName { get; set; }
    public string Address { get; set; }
}

/// <summary>
 /// 您实现的自定义邮件合并数据源，以允许 Aspose.Words
/// 将客户对象中的数据通过邮件合并到 Microsoft Word 文档中。
/// </summary>
public class CustomerMailMergeDataSource : IMailMergeDataSource
{
    public CustomerMailMergeDataSource(List<Customer> customers)
    {
        mCustomers = customers;

        // 当我们初始化数据源时，它的位置必须在第一个记录之前。
        mRecordIndex = -1;
    }

    /// <summary>
    /// 数据源的名称。仅在执行可重复区域的邮件合并时由 Aspose.Words 使用。
    /// </summary>
    public string TableName
    {
        get { return "Customer"; }
    }

    /// <summary>
    /// Aspose.Words 调用此方法来获取每个数据字段的值。
    /// </summary>
    public bool GetValue(string fieldName, out object fieldValue)
    {
        switch (fieldName)
        {
            case "FullName":
                fieldValue = mCustomers[mRecordIndex].FullName;
                return true;
            case "Address":
                fieldValue = mCustomers[mRecordIndex].Address;
                return true;
            default:
                // 返回“false”给 Aspose.Words 邮件合并引擎以表示
                // 我们找不到具有此名称的字段。
                fieldValue = null;
                return false;
        }
    }

    /// <summary>
    /// 移动到集合中的下一个记录的标准实现。
    /// </summary>
    public bool MoveNext()
    {
        if (!IsEof)
            mRecordIndex++;

        return !IsEof;
    }

    public IMailMergeDataSource GetChildDataSource(string tableName)
    {
        return null;
    }

    private bool IsEof
    {
        get { return (mRecordIndex >= mCustomers.Count); }
    }

    private readonly List<Customer> mCustomers;
    private int mRecordIndex;
}

也可以看看

IMailMergeDataSource.TableName IMailMergeDataSource.GetValue