MailMergeSettings

MailMergeSettings class

指定文档的所有邮件合并信息。

要了解更多信息，请访问邮件合并和报告文档文章。

public class MailMergeSettings

构造函数

姓名	描述
MailMergeSettings()	默认构造函数。

特性

姓名	描述
ActiveRecord { get; set; }	指定数据源中记录的从一开始的索引，该索引应显示在 Microsoft Word 中。默认值为 1。
AddressFieldName { get; set; }	指定数据源中包含电子邮件地址的列。默认值为空字符串。
CheckErrors { get; set; }	指定 Microsoft Word 在执行邮件合并时应进行的错误报告类型。默认值为Default.
ConnectString { get; set; }	指定用于连接外部数据源的连接字符串。默认值为空字符串。
DataSource { get; set; }	指定邮件合并数据源的路径。默认值为空字符串。
DataType { get; set; }	指定邮件合并数据源的类型和数据访问方法。默认值为Default.
Destination { get; set; }	指定 Microsoft Word 如何输出邮件合并的结果。默认值为Default.
DoNotSupressBlankLines { get; set; }	指定执行邮件合并的应用程序应如何处理邮件合并产生的合并文档中的空白行。默认值为`错误的`.
HeaderSource { get; set; }	指定邮件合并标头源的路径。默认值为空字符串。
LinkToQuery { get; set; }	对此不太确定。 Microsoft Word 自动化参考建议，这指定每次在 Microsoft Word 中打开文档时都会执行查询。但 OOXML 规范建议，这指定查询包含对包含实际查询的外部查询文件的引用。默认值为`错误的`.
MailAsAttachment { get; set; }	指定邮件合并操作期间生成的文档应作为附件发送，而不是作为实际电子邮件的正文发送。默认值为`错误的`.
MailSubject { get; set; }	指定邮件合并期间生成的电子邮件或传真主题行中显示的文本。默认值为空字符串。
MainDocumentType { get; set; }	指定邮件合并主文档类型。默认值为Default.
Odso { get; set; }	获取或设置指定 Office 数据源对象 (ODSO) 设置的对象。
Query { get; set; }	包含结构化查询语言字符串，该字符串应针对指定的外部数据源运行，以返回执行邮件合并操作时应导入文档的记录集。默认值为空字符串。
ViewMergedData { get; set; }	指定 Microsoft Word 应显示来自指定外部数据源的数据，其中已插入合并字段（例如，预览合并数据）。默认值为`错误的`.

方法

姓名	描述
Clear()	清除邮件合并设置，以便在保存文档时，不会保存任何邮件合并设置，并且它将成为普通文档。
Clone()	返回此对象的深度克隆。

您可以使用此对象为文档指定邮件合并数据源，并且当用户打开此文档时，此信息（连同可用的数据字段）将显示在 Microsoft Word 中。或者您可以使用此对象查询用户在 Microsoft Word 中为此文档指定的邮件合并设置。

通常不需要直接创建此类的对象，因为文档的邮件合并设置始终可以通过MailMergeSettings财产。

要检测此文档是否为邮件合并主文档，请检查的值MainDocumentType财产。

要从文档中删除邮件合并设置和数据源信息，您可以使用 Clear方法。如果出现错误，Aspose.Words 将不会将邮件合并设置写入文档MainDocumentType属性设置为NotAMergeDocument 或DataType属性设置为None。

学习如何使用此对象的属性的最佳方法是在 Microsoft Word 中手动创建具有所需数据源的文档，然后使用 Aspose.Words 打开该文档并检查MailMergeSettings和Odso对象。例如，如果您想学习如何以编程方式配置数据源，这是一种不错的方法。

Aspose.Words 在加载、保存和转换不同格式的文档时保留邮件合并信息，但在使用执行自己的邮件合并时不使用此信息MailMerge目的。

例子

展示如何使用来自 Office 数据源对象的数据执行邮件合并。

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

// 以ASCII文件的形式创建数据源，以“|”字符
// 充当分隔列的分隔符。第一行包含三列的名称，
// 并且每个后续行都是具有各自值的一行。
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());

 // 在 Microsoft Word 中打开此文档将在显示内容之前执行邮件合并。
doc.Save(ArtifactsDir + "MailMerge.MailMergeSettings.docx");

也可以看看

命名空间 Aspose.Words.Settings
部件 Aspose.Words

MailMergeMainDocumentType Enum MsWordVersion Enum

MailMergeSettings