MailMergeMainDocumentType
Contents
[
Hide
]MailMergeMainDocumentType enumeration
Specifies the possible types for a mail merge source document.
public enum MailMergeMainDocumentType
Values
Name | Value | Description |
---|---|---|
NotAMergeDocument | 0 | This document is not a mail merge document. |
FormLetters | 1 | Specifies that the mail merge source document is of the form letter type. |
MailingLabels | 2 | Specifies that the mail merge source document is of the mailing label type. |
Envelopes | 4 | Specifies that the mail merge source document is of the envelope type. |
Catalog | 8 | Specifies that the mail merge source document is of the catalog type. |
16 | Specifies that the mail merge source document is of the e-mail message type. | |
Fax | 32 | Specifies that the mail merge source document is of the fax type. |
Default | 0 | Equals to NotAMergeDocument |
Examples
Shows how to execute a mail merge with data from an Office Data Source Object.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Write("Dear ");
builder.InsertField("MERGEFIELD FirstName", "<FirstName>");
builder.Write(" ");
builder.InsertField("MERGEFIELD LastName", "<LastName>");
builder.Writeln(": ");
builder.InsertField("MERGEFIELD Message", "<Message>");
// Create a data source in the form of an ASCII file, with the "|" character
// acting as the delimiter that separates columns. The first line contains the three columns' names,
// and each subsequent line is a row with their respective values.
string[] lines = { "FirstName|LastName|Message",
"John|Doe|Hello! This message was created with Aspose Words mail merge." };
string dataSrcFilename = ArtifactsDir + "MailMerge.MailMergeSettings.DataSource.txt";
File.WriteAllLines(dataSrcFilename, lines);
MailMergeSettings settings = doc.MailMergeSettings;
settings.MainDocumentType = MailMergeMainDocumentType.MailingLabels;
settings.CheckErrors = MailMergeCheckErrors.Simulate;
settings.DataType = MailMergeDataType.Native;
settings.DataSource = dataSrcFilename;
settings.Query = "SELECT * FROM " + doc.MailMergeSettings.DataSource;
settings.LinkToQuery = true;
settings.ViewMergedData = true;
Assert.AreEqual(MailMergeDestination.Default, settings.Destination);
Assert.False(settings.DoNotSupressBlankLines);
Odso odso = settings.Odso;
odso.DataSource = dataSrcFilename;
odso.DataSourceType = OdsoDataSourceType.Text;
odso.ColumnDelimiter = '|';
odso.FirstRowContainsColumnNames = true;
Assert.AreNotSame(odso, odso.Clone());
Assert.AreNotSame(settings, settings.Clone());
// Opening this document in Microsoft Word will execute the mail merge before displaying the contents.
doc.Save(ArtifactsDir + "MailMerge.MailMergeSettings.docx");
See Also
- property MainDocumentType
- namespace Aspose.Words.Settings
- assembly Aspose.Words