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

Смотрите также