GetChildDataSource

IMailMergeDataSource.GetChildDataSource method

Aspose.Words-kopplingsmotorn anropar den här metoden när den stöter på början av ett kapslat kopplingsområde.

public IMailMergeDataSource GetChildDataSource(string tableName)

Parameter	Typ	Beskrivning
tableName	String	Namnet på den kopplade dokumentregionen som anges i malldokumentet. Skiftlägesokänsligt.

Returvärde

Ett datakällobjekt som ger åtkomst till dataposterna i den angivna tabellen.

Anmärkningar

När Aspose.Words-kopplingsmotorerna fyller ett kopplingsområde med data och stöter på början av ett kapslat kopplingsområde med i form av MERGEFIELD TableStart:TableName, anropasGetChildDataSource på datakällobjektet current . Din implementering behöver returnera ett nytt datakällobjekt som ger åtkomst till child -posterna för den aktuella överordnade posten. Aspose.Words kommer att använda den returnerade datakällan för att fylla i den kapslade kopplingsregionen.

Nedan följer reglerna för implementeringen avGetChildDataSource måste följa.

Om tabellen som representeras av detta datakällobjekt har en relaterad underordnad (detalj) tabell med det angivna namnet måste din implementering returnera en nyIMailMergeDataSource objekt som ger åtkomst till underposterna till den aktuella posten. Ett exempel på detta är relationen Order / OrderDetails. Låt oss anta att den aktuellaIMailMergeDataSource object representerar tabellen Orders och har en aktuell orderpost. Därefter stöter Aspose.Words på “MERGEFIELD TableStart:OrderDetails” i dokumentet och anroparGetChildDataSource Du måste skapa och returnera enIMailMergeDataSource objekt som tillåter Aspose.Words att komma åt OrderDetails-posten för den aktuella ordern.

Om detta datakällobjekt inte har en relation till tabellen med det angivna namnet måste du returnera aIMailMergeDataSourceobjekt som ger åtkomst till alla poster i den angivna tabellen.

Om en tabell med det angivna namnet inte finns, ska din implementering returneranull .

Exempel

Visar hur man utför en dokumentkoppling med en datakälla i form av ett anpassat objekt.

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

     // För att använda ett anpassat objekt som datakälla måste det implementera IMailMergeDataSource-gränssnittet.
    CustomerMailMergeDataSource dataSource = new CustomerMailMergeDataSource(customers);

    doc.MailMerge.Execute(dataSource);

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

/// <summary>
/// Ett exempel på en "data entity"-klass i din applikation.
/// </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>
 /// En anpassad datakälla för dokumentkoppling som du implementerar för att tillåta Aspose.Words
/// för att koppla data från dina kundobjekt till Microsoft Word-dokument.
/// </summary>
public class CustomerMailMergeDataSource : IMailMergeDataSource
{
    public CustomerMailMergeDataSource(List<Customer> customers)
    {
        mCustomers = customers;

        // När vi initierar datakällan måste dess position vara före den första posten.
        mRecordIndex = -1;
    }

    /// <summary>
    /// Namnet på datakällan. Används endast av Aspose.Words vid dokumentkoppling med repeterbara regioner.
    /// </summary>
    public string TableName
    {
        get { return "Customer"; }
    }

    /// <summary>
    /// Aspose.Words anropar den här metoden för att hämta ett värde för varje datafält.
    /// </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:
                // Returnera "false" till Aspose.Words-kopplingsmotorn för att beteckna
                // att vi inte kunde hitta ett fält med detta namn.
                fieldValue = null;
                return false;
        }
    }

    /// <summary>
    /// En standardimplementering för att gå till nästa post i en samling.
    /// </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;
}

Se även

IMailMergeDataSource.TableName IMailMergeDataSource.GetValue