GetChildDataSource

IMailMergeDataSource.GetChildDataSource method

El motor de combinación de correspondencia Aspose.Words invoca este método cuando encuentra el comienzo de una región de combinación de correspondencia anidada.

public IMailMergeDataSource GetChildDataSource(string tableName)
ParámetroEscribeDescripción
tableNameStringEl nombre de la región de combinación de correspondencia, tal como se especifica en el documento de plantilla. No distingue entre mayúsculas y minúsculas.

Valor_devuelto

Un objeto de fuente de datos que proporcionará acceso a los registros de datos de la tabla especificada.

Observaciones

Cuando los motores de combinación de correspondencia Aspose.Words rellenan una región de combinación de correspondencia con datos y encuentran el comienzo de una región de combinación de correspondencia anidada en el formato MERGEFIELD TableStart:TableName, invocaGetChildDataSource En el objeto de origen de datos current . Su implementación debe devolver un nuevo objeto de origen de datos que proporcione acceso a los registros child del registro principal actual. Aspose.Words usará el origen de datos devuelto para rellenar la región de combinación de correspondencia anidada.

A continuación se presentan las reglas que rigen la implementación deGetChildDataSource debe seguir.

Si la tabla representada por este objeto de origen de datos tiene una tabla secundaria (detalle) relacionada con el nombre especificado, entonces su implementación debe devolver una nuevaIMailMergeDataSource objeto que proporcionará acceso a los registros secundarios del registro actual. Un ejemplo de esto es la relación Pedidos / Detalles del pedido. Supongamos que el registro actualIMailMergeDataSource object representa la tabla Pedidos y contiene un registro de pedido actual. A continuación, Aspose.Words encuentra “MERGEFIELD TableStart:OrderDetails” en el documento e invocaGetChildDataSource Necesita crear y devolver unIMailMergeDataSource objeto que permitirá a Aspose.Words acceder al registro OrderDetails del pedido actual.

Si este objeto de origen de datos no tiene una relación con la tabla con el nombre especificado, entonces debe devolver unaIMailMergeDataSourceobjeto que proporcionará acceso a todos los registros de la tabla especificada.

Si no existe una tabla con el nombre especificado, su implementación debe devolvernulo .

Ejemplos

Muestra cómo ejecutar una combinación de correspondencia con una fuente de datos en forma de un objeto personalizado.

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")
    };

     // Para utilizar un objeto personalizado como fuente de datos, debe implementar la interfaz IMailMergeDataSource.
    CustomerMailMergeDataSource dataSource = new CustomerMailMergeDataSource(customers);

    doc.MailMerge.Execute(dataSource);

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

/// <summary>
/// Un ejemplo de una clase de "entidad de datos" en su aplicación.
/// </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>
 /// Una fuente de datos de combinación de correspondencia personalizada que se implementa para permitir Aspose.Words
/// para combinar datos de sus objetos de Cliente en documentos de Microsoft Word.
/// </summary>
public class CustomerMailMergeDataSource : IMailMergeDataSource
{
    public CustomerMailMergeDataSource(List<Customer> customers)
    {
        mCustomers = customers;

        // Cuando inicializamos la fuente de datos, su posición debe ser anterior al primer registro.
        mRecordIndex = -1;
    }

    /// <summary>
    /// El nombre de la fuente de datos. Aspose.Words lo utiliza solo al ejecutar la combinación de correspondencia con regiones repetibles.
    /// </summary>
    public string TableName
    {
        get { return "Customer"; }
    }

    /// <summary>
    /// Aspose.Words llama a este método para obtener un valor para cada campo de datos.
    /// </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:
                // Devuelve "falso" al motor de combinación de correspondencia Aspose.Words para indicar
                // que no pudimos encontrar un campo con este nombre.
                fieldValue = null;
                return false;
        }
    }

    /// <summary>
    /// Una implementación estándar para pasar al siguiente registro en una colección.
    /// </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;
}

Ver también

IMailMergeDataSource.TableName IMailMergeDataSource.GetValue