GetChildDataSource

IMailMergeDataSource.GetChildDataSource method

Il motore di stampa unione Aspose.Words richiama questo metodo quando incontra l’inizio di una regione di stampa unione nidificata.

public IMailMergeDataSource GetChildDataSource(string tableName)
ParametroTipoDescrizione
tableNameStringIl nome dell’area di stampa unione come specificato nel documento modello. Senza distinzione tra maiuscole e minuscole.

Valore di ritorno

Un oggetto origine dati che fornirà l’accesso ai record di dati della tabella specificata.

Osservazioni

Quando i motori di stampa unione Aspose.Words popolano un’area di stampa unione con dati e incontrano l’inizio di una regione di stampa unione nidificata sotto forma di MERGEFIELD TableStart:TableName, richiamaGetChildDataSource sull’oggetto origine dati current . La tua implementazione deve restituire un nuovo oggetto origine dati che fornirà l’accesso ai record child del record padre corrente. Aspose.Words utilizzerà l’origine dati restituita per popolare la regione di stampa unione nidificata.

Di seguito sono riportate le regole che ne prevedono l’implementazioneGetChildDataSource deve seguire.

Se la tabella rappresentata da questo oggetto origine dati ha una tabella secondaria correlata (dettagli) con il nome specificato, , l’implementazione deve restituire un nuovoIMailMergeDataSourceoggetto che fornirà access ai record secondari del record corrente. Un esempio di ciò è la relazione Orders / OrderDetails. Supponiamo che la correnteIMailMergeDataSource object rappresenta la tabella Ordini e ha un record dell’ordine corrente. Successivamente, Aspose.Words incontra “MERGEFIELD TableStart:OrderDetails” nel documento e invocaGetChildDataSource . È necessario creare e restituire aIMailMergeDataSource Oggetto che consentirà ad Aspose.Words di accedere al record OrderDetails per l’ordine corrente.

Se questo oggetto origine dati non ha una relazione con la tabella con il nome specificato, è necessario restituire aIMailMergeDataSource oggetto che fornirà l’accesso a tutti i record della tabella specificata.

Se una tabella con il nome specificato non esiste, l’implementazione dovrebbe restituirenullo .

Esempi

Mostra come eseguire una stampa unione con un’origine dati sotto forma di oggetto personalizzato.

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

     // Per utilizzare un oggetto personalizzato come origine dati, è necessario implementare l'interfaccia IMailMergeDataSource.
    CustomerMailMergeDataSource dataSource = new CustomerMailMergeDataSource(customers);

    doc.MailMerge.Execute(dataSource);

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

/// <summary>
/// Un esempio di classe "entità dati" nella tua applicazione.
/// </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>
 /// Un'origine dati di stampa unione personalizzata implementata per consentire Aspose.Words
/// per inviare tramite posta unione i dati dagli oggetti Cliente ai documenti Microsoft Word.
/// </summary>
public class CustomerMailMergeDataSource : IMailMergeDataSource
{
    public CustomerMailMergeDataSource(List<Customer> customers)
    {
        mCustomers = customers;

        // Quando inizializziamo l'origine dati, la sua posizione deve essere prima del primo record.
        mRecordIndex = -1;
    }

    /// <summary>
    /// Il nome dell'origine dati. Utilizzato da Aspose.Words solo durante l'esecuzione della stampa unione con regioni ripetibili.
    /// </summary>
    public string TableName
    {
        get { return "Customer"; }
    }

    /// <summary>
    /// Aspose.Words chiama questo metodo per ottenere un valore per ogni campo dati.
    /// </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:
                // Restituisce "false" al motore di stampa unione Aspose.Words per indicare
                // che non siamo riusciti a trovare un campo con questo nome.
                fieldValue = null;
                return false;
        }
    }

    /// <summary>
    /// Un'implementazione standard per passare al record successivo in una raccolta.
    /// </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;
}

Guarda anche

IMailMergeDataSource.TableName IMailMergeDataSource.GetValue