Aspose::Words::Settings::MailMergeSettings класс

MailMergeSettings class

Указывает всю информацию о слиянии почты для документа. Чтобы узнать больше, посетите статью документации Mail Merge and Reporting.

class MailMergeSettings : public System::Object

Методы

МетодОписание
Clear()Очищает настройки слияния почты таким образом, что при сохранении документа настройки слияния почты не сохраняются, и документ становится обычным.
Clone()Возвращает глубокую копию этого объекта.
get_ActiveRecord() constУказывает индекс записи из источника данных, начинающийся с 1, который будет отображаться в Microsoft Word. Значение по умолчанию — 1.
get_AddressFieldName() constУказывает столбец в источнике данных, содержащий адреса электронной почты. Значение по умолчанию — пустая строка.
get_CheckErrors() constУказывает тип отчётности об ошибках, который будет выполнять Microsoft Word при выполнении слияния почты. Значение по умолчанию — Default.
get_ConnectString() constУказывает строку подключения, используемую для соединения с внешним источником данных. Значение по умолчанию — пустая строка.
get_DataSource() constУказывает путь к источнику данных слияния почты. Значение по умолчанию — пустая строка.
get_DataType() constУказывает тип источника данных слияния почты и метод доступа к данным. Значение по умолчанию — Default.
get_Destination() constУказывает, как Microsoft Word будет выводить результаты слияния почты. Значение по умолчанию — Default.
get_DoNotSupressBlankLines() constУказывает, как приложение, выполняющее слияние почты, должно обрабатывать пустые строки в объединённых документах, полученных в результате слияния. Значение по умолчанию — false.
get_HeaderSource() constУказывает путь к источнику заголовка слияния почты. Значение по умолчанию — пустая строка.
get_LinkToQuery() constНе уверен в этом. Справочник автоматизации Microsoft Word предполагает, что это указывает, что запрос выполняется каждый раз при открытии документа в Microsoft Word. Но спецификация OOXML указывает, что это означает, что запрос содержит ссылку на внешний файл запроса, содержащий фактический запрос. Значение по умолчанию — false.
get_MailAsAttachment() constУказывает, что документы, создаваемые во время операции слияния почты, должны отправляться по электронной почте в виде вложения, а не в теле самого письма. Значение по умолчанию — false.
get_MailSubject() constУказывает текст, который будет отображаться в строке темы электронных писем или факсов, создаваемых при слиянии почты. Значение по умолчанию — пустая строка.
get_MainDocumentType() constУказывает тип основного документа слияния почты. Значение по умолчанию — Default.
get_Odso() constПолучает объект, который указывает настройки Office Data Source Object (ODSO).
get_Query() constСодержит строку Structured Query Language, которая будет выполнена против указанного внешнего источника данных для возврата набора записей, которые будут импортированы в документ при выполнении операции слияния почты. Значение по умолчанию — пустая строка.
get_ViewMergedData() constУказывает, что Microsoft Word должен отображать данные из указанного внешнего источника данных там, где вставлены поля слияния (например, предварительный просмотр объединённых данных). Значение по умолчанию — false.
GetType() const override
Is(const System::TypeInfo&) const override
MailMergeSettings()
set_ActiveRecord(int32_t)Указывает индекс записи из источника данных, начинающийся с 1, который будет отображаться в Microsoft Word. Значение по умолчанию — 1.
set_AddressFieldName(const System::String&)Указывает столбец в источнике данных, содержащий адреса электронной почты. Значение по умолчанию — пустая строка.
set_CheckErrors(Aspose::Words::Settings::MailMergeCheckErrors)Указывает тип отчётности об ошибках, который будет выполнять Microsoft Word при выполнении слияния почты. Значение по умолчанию — Default.
set_ConnectString(const System::String&)Указывает строку подключения, используемую для соединения с внешним источником данных. Значение по умолчанию — пустая строка.
set_DataSource(const System::String&)Указывает путь к источнику данных слияния почты. Значение по умолчанию — пустая строка.
set_DataType(Aspose::Words::Settings::MailMergeDataType)Указывает тип источника данных слияния почты и метод доступа к данным. Значение по умолчанию — Default.
set_Destination(Aspose::Words::Settings::MailMergeDestination)Указывает, как Microsoft Word будет выводить результаты слияния почты. Значение по умолчанию — Default.
set_DoNotSupressBlankLines(bool)Указывает, как приложение, выполняющее слияние почты, должно обрабатывать пустые строки в объединённых документах, полученных в результате слияния. Значение по умолчанию — false.
set_HeaderSource(const System::String&)Указывает путь к источнику заголовка слияния почты. Значение по умолчанию — пустая строка.
set_LinkToQuery(bool)Сеттер для Aspose::Words::Settings::MailMergeSettings::get_LinkToQuery.
set_MailAsAttachment(bool)Указывает, что документы, создаваемые во время операции слияния почты, должны отправляться по электронной почте в виде вложения, а не в теле самого письма. Значение по умолчанию — false.
set_MailSubject(const System::String&)Указывает текст, который будет отображаться в строке темы электронных писем или факсов, создаваемых при слиянии почты. Значение по умолчанию — пустая строка.
set_MainDocumentType(Aspose::Words::Settings::MailMergeMainDocumentType)Сеттер для Aspose::Words::Settings::MailMergeSettings::get_MainDocumentType.
set_Odso(const System::SharedPtr<Aspose::Words::Settings::Odso>&)Устанавливает объект, который указывает настройки Office Data Source Object (ODSO).
set_Query(const System::String&)Содержит строку Structured Query Language, которая будет выполнена против указанного внешнего источника данных для возврата набора записей, которые будут импортированы в документ при выполнении операции слияния почты. Значение по умолчанию — пустая строка.
set_ViewMergedData(bool)Указывает, что Microsoft Word должен отображать данные из указанного внешнего источника данных там, где вставлены поля слияния (например, предварительный просмотр объединённых данных). Значение по умолчанию — false.
static Type()

Примечания

Вы можете использовать этот объект, чтобы указать источник данных слияния почты для документа, и эта информация (вместе с доступными полями данных) появится в Microsoft Word, когда пользователь откроет документ. Либо вы можете использовать этот объект для запроса настроек слияния почты, которые пользователь указал в Microsoft Word для данного документа.

Обычно вам не нужно создавать объекты этого класса напрямую, потому что настройки слияния почты документа всегда доступны через свойство MailMergeSettings.

Чтобы определить, является ли этот документ основным документом слияния почты, проверьте значение свойства MainDocumentType.

Чтобы удалить настройки слияния почты и информацию о источнике данных из документа, вы можете использовать метод Clear. Aspose.Words не будет записывать настройки слияния почты в документ, если свойство MainDocumentType установлено в значение NotAMergeDocument или свойство DataType установлено в значение None.

Лучший способ узнать, как использовать свойства этого объекта, — создать документ с нужным источником данных вручную в Microsoft Word, а затем открыть этот документ с помощью Aspose.Words и изучить свойства объектов MailMergeSettings и Odso. Это хороший подход, если вы хотите, например, научиться программно настраивать источник данных.

Aspose.Words сохраняет информацию о слиянии почты при загрузке, сохранении и конвертации документов между разными форматами, но не использует эту информацию при выполнении собственного слияния почты с помощью объекта MailMerge.

См. также