MailMerge

MailMerge class

Rappresenta la funzionalità di unione di posta.

Per saperne di più, visita ilUnione di posta e creazione di report articolo di documentazione.

public class MailMerge

Proprietà

NomeDescrizione
CleanupOptions { get; set; }Ottiene o imposta un set di flag che specificano quali elementi devono essere rimossi durante la stampa unione.
CleanupParagraphsWithPunctuationMarks { get; set; }Ottiene o imposta un valore che indica se i paragrafi con segni di punteggiatura sono considerati vuoti e dovrebbero essere rimossi seRemoveEmptyParagraphs l’opzione è specificata.
FieldMergingCallback { get; set; }Si verifica durante la stampa unione quando nel documento viene rilevato un campo di stampa unione.
MailMergeCallback { get; set; }Consente di gestire eventi particolari durante la stampa unione.
MappedDataFields { get; }Restituisce una raccolta che rappresenta i campi dati mappati per l’operazione di unione di posta.
MergeDuplicateRegions { get; set; }Ottiene o imposta un valore che indica se tutte le aree di unione di documenti con il nome di un’origine dati devono essere unite durante l’esecuzione di un’unione di documenti con aree relative all’origine dati o solo la prima.
MergeWholeDocument { get; set; }Ottiene o imposta un valore che indica se i campi dell’intero documento vengono aggiornati durante l’esecuzione di una stampa unione con regioni.
PreserveUnusedTags { get; set; }Ottiene o imposta un valore che indica se i tag “baffi” non utilizzati devono essere conservati.
RegionEndTag { get; set; }Ottiene o imposta un tag di fine regione di unione di posta.
RegionStartTag { get; set; }Ottiene o imposta un tag di inizio regione di unione di posta.
RestartListsAtEachSection { get; set; }Ottiene o imposta un valore che indica se gli elenchi vengono riavviati a ogni sezione dopo l’esecuzione di una stampa unione.
RetainFirstSectionStart { get; set; }Ottiene o imposta un valore che indica se ilSectionStart della prima sezione del documento e le sue copie per le righe successive della sorgente dati vengono conservate durante la stampa unione o aggiornate in base al comportamento di MS Word.
TrimWhitespaces { get; set; }Ottiene o imposta un valore che indica se gli spazi vuoti iniziali e finali vengono tagliati dai valori di unione di posta.
UnconditionalMergeFieldsAndRegions { get; set; }Ottiene o imposta un valore che indica se i campi di unione e le regioni di unione vengono uniti indipendentemente dalla condizione del campo IF padre.
UseNonMergeFields { get; set; }QuandoVERO , specifica che oltre ai campi MERGEFIELD, la stampa unione viene eseguita in alcuni altri tipi di campi e anche nei tag “{{fieldName}}”.
UseWholeParagraphAsRegion { get; set; }Ottiene o imposta un valore che indica se l’intero paragrafo conTableStart OTableEnd field o intervallo particolare traTableStart ETableEnd i campi dovrebbero essere inclusi nell’area di unione della stampa.

Metodi

NomeDescrizione
DeleteFields()Rimuove i campi relativi alla stampa unione dal documento.
Execute(DataRow)Esegue la stampa unione da unRiga di dati nel documento.
Execute(DataTable)Esegue la stampa unione da una tabella dati nel documento.
Execute(DataView)Esegue la stampa unione da unVisualizzazione dati nel documento.
Execute(IDataReader)Esegue la stampa unione daLettore di dati IData nel documento.
Execute(IMailMergeDataSource)Esegue una stampa unione da una fonte dati personalizzata.
Execute(string[], object[])Esegue un’operazione di unione di posta per un singolo record.
ExecuteADO(object)Esegue la stampa unione da un oggetto ADO Recordset nel documento.
ExecuteWithRegions(DataSet)Esegue la stampa unione da unInsieme di dati in un documento con aree di unione di stampa.
ExecuteWithRegions(DataTable)Esegue la stampa unione da unTabella dati nel documento con aree di unione.
ExecuteWithRegions(DataView)Esegue la stampa unione da unVisualizzazione dati nel documento con aree di unione.
ExecuteWithRegions(IMailMergeDataSource)Esegue una stampa unione da un’origine dati personalizzata con regioni di stampa unione.
ExecuteWithRegions(IMailMergeDataSourceRoot)Esegue una stampa unione da un’origine dati personalizzata con regioni di stampa unione.
ExecuteWithRegions(IDataReader, string)Esegue la stampa unione daLettore di dati IData nel documento con aree di unione.
ExecuteWithRegionsADO(object, string)Esegue la stampa unione da un oggetto ADO Recordset nel documento con aree di stampa unione.
GetFieldNames()Restituisce una raccolta di nomi di campi di unione di posta disponibili nel documento.
GetFieldNamesForRegion(string)Restituisce una raccolta di nomi di campi di unione di posta disponibili nella regione.
GetFieldNamesForRegion(string, int)Restituisce una raccolta di nomi di campi di unione di posta disponibili nella regione.
GetRegionsByName(string)Restituisce una raccolta di aree di unione di stampa con il nome specificato.
GetRegionsHierarchy()Restituisce una gerarchia completa delle regioni (con campi) disponibili nel documento.

Osservazioni

Affinché l’operazione di stampa unione funzioni, il documento deve contenere i campi MERGEFIELD e (opzionale) di Word. Durante l’operazione di stampa unione, i campi unione nel documento vengono sostituiti con i valori provenienti dall’origine dati.

Esistono due modi distinti per utilizzare la stampa unione: con le aree di stampa unione e senza.

La stampa unione più semplice è senza regioni ed è molto simile al funzionamento di stampa unione in Word. UsaEseguire metodi per unire informazioni da una sorgente dati some comeTabella dati ,Insieme di dati ,Visualizzazione dati ,Lettore di dati IData o un array di oggetti nel tuo documento. The MailMerge L’oggetto elabora tutti i record dell’origine dati e copia e aggiunge il contenuto dell’intero documento per ciascun record.

Nota che quandoMailMergel’oggetto incontra un campo NEXT, seleziona il record successivo record nell’origine dati e continua l’unione senza copiare alcun contenuto.

UtilizzoExecuteWithRegions e altri sovraccarichi per unire le informazioni in un documento con aree di stampa unione definite. Puoi usare Insieme di dati ,Tabella dati ,Visualizzazione dati OLettore di dati IData come origini dati per questa operazione.

È necessario utilizzare le aree di stampa unione se si desidera espandere dinamicamente le porzioni all’interno del documento . Senza le aree di stampa unione, l’intero documento verrà ripetuto per ogni record di , l’origine dati.

Esempi

Mostra come eseguire una stampa unione con i dati di una DataTable.

public void ExecuteDataTable()
{
    DataTable table = new DataTable("Test");
    table.Columns.Add("CustomerName");
    table.Columns.Add("Address");
    table.Rows.Add(new object[] { "Thomas Hardy", "120 Hanover Sq., London" });
    table.Rows.Add(new object[] { "Paolo Accorti", "Via Monte Bianco 34, Torino" });

    // Di seguito sono riportati due modi per utilizzare una DataTable come origine dati per una stampa unione.
    // 1 - Utilizza l'intera tabella per la stampa unione per creare un documento di stampa unione in output per ogni riga della tabella:
    Document doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.WholeTable.docx");

    // 2 - Utilizzare una riga della tabella per creare un documento di stampa unione in output:
    doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table.Rows[1]);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.OneRow.docx");
}

/// <summary>
/// Crea un documento sorgente per la stampa unione.
/// </summary>
private static Document CreateSourceDocExecuteDataTable()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    builder.InsertField(" MERGEFIELD CustomerName ");
    builder.InsertParagraph();
    builder.InsertField(" MERGEFIELD Address ");

    return doc;
}

Guarda anche

ImageFieldMergingArgs Class MailMergeCleanupOptions Enum