Класс Aspose::Words::MailMerging::MailMerge
Содержание
[
Скрывать
]MailMerge class
Представляет функциональность слияния почты. Чтобы узнать больше, посетите статью документации Mail Merge and Reporting.
class MailMerge : public System::Object
Методы
| Метод | Описание |
|---|---|
| DeleteFields() | Удаляет из документа поля, связанные со слиянием почты. |
| Execute(const System::SharedPtr<Aspose::Words::MailMerging::IMailMergeDataSource>&) | Выполняет слияние почты из пользовательского источника данных. |
| Execute(const System::ArrayPtr<System::String>&, const System::ArrayPtr<System::SharedPtr<System::Object>>&) | Выполняет операцию слияния почты для одной записи. |
| ExecuteWithRegions(const System::SharedPtr<Aspose::Words::MailMerging::IMailMergeDataSource>&) | Выполняет слияние почты из пользовательского источника данных с регионами слияния почты. |
| ExecuteWithRegions(const System::SharedPtr<Aspose::Words::MailMerging::IMailMergeDataSourceRoot>&) | Выполняет слияние почты из пользовательского источника данных с регионами слияния почты. |
| get_CleanupOptions() const | Возвращает набор флагов, указывающих, какие элементы следует удалить во время слияния почты. |
| get_CleanupParagraphsWithPunctuationMarks() const | Получает или задает значение, указывающее, считаются ли абзацы с знаками пунктуации пустыми и должны ли они быть удалены, если указана опция RemoveEmptyParagraphs. |
| get_FieldMergingCallback() const | Происходит во время слияния почты, когда в документе встречается поле слияния почты. |
| get_MailMergeCallback() const | Позволяет обрабатывать определённые события во время слияния почты. |
| get_MappedDataFields() | Возвращает коллекцию, представляющую сопоставленные поля данных для операции слияния почты. |
| get_MergeDuplicateRegions() const | Получает значение, указывающее, должны ли все регионы слияния почты в документе с именем источника данных быть объединены при выполнении слияния почты с регионами против источника данных, или только первый. |
| get_MergeWholeDocument() const | Получает значение, указывающее, обновляются ли поля во всём документе при выполнении слияния почты с регионами. |
| get_PreserveUnusedTags() const | Получает значение, указывающее, следует ли сохранять неиспользуемые теги “mustache”. |
| get_RegionEndTag() const | Получает тег окончания региона слияния почты. |
| get_RegionStartTag() const | Получает тег начала региона слияния почты. |
| get_RestartListsAtEachSection() const | Получает значение, указывающее, перезапускаются ли списки в каждом разделе после выполнения слияния почты. |
| get_RetainFirstSectionStart() const | Получает значение, указывающее, сохраняются ли SectionStart первой секции документа и её копии для последующих строк источника данных во время слияния почты или обновляются в соответствии с поведением MS Word. |
| get_TrimWhitespaces() const | Получает значение, указывающее, обрезаются ли начальные и конечные пробелы в значениях слияния почты. |
| get_UnconditionalMergeFieldsAndRegions() const | Получает значение, указывающее, объединяются ли поля слияния и регионы слияния независимо от условия родительского поля IF. |
| get_UseNonMergeFields() const | Когда true, указывает, что помимо полей MERGEFIELD слияние почты выполняется и в некоторые другие типы полей, а также в теги “{{fieldName}}”. |
| get_UseWholeParagraphAsRegion() const | Получает значение, указывающее, следует ли включать в регион слияния почты весь абзац с полем TableStart или TableEnd, либо определённый диапазон между полями TableStart и TableEnd. |
| GetFieldNames() | Возвращает коллекцию имён полей слияния почты, доступных в документе. |
| GetFieldNamesForRegion(const System::String&) | Возвращает коллекцию имён полей слияния почты, доступных в регионе. |
| GetFieldNamesForRegion(const System::String&, int32_t) | Возвращает коллекцию имён полей слияния почты, доступных в регионе. |
| GetRegionsByName(const System::String&) | Возвращает коллекцию регионов слияния почты с указанным именем. |
| GetRegionsHierarchy() | Возвращает полную иерархию регионов (с полями), доступных в документе. |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| set_CleanupOptions(Aspose::Words::MailMerging::MailMergeCleanupOptions) | Устанавливает набор флагов, определяющих, какие элементы следует удалять во время слияния почты. |
| set_CleanupParagraphsWithPunctuationMarks(bool) | Сеттер для Aspose::Words::MailMerging::MailMerge::get_CleanupParagraphsWithPunctuationMarks. |
| set_FieldMergingCallback(const System::SharedPtr<Aspose::Words::MailMerging::IFieldMergingCallback>&) | Происходит во время слияния почты, когда в документе встречается поле слияния почты. |
| set_MailMergeCallback(const System::SharedPtr<Aspose::Words::MailMerging::IMailMergeCallback>&) | Позволяет обрабатывать определённые события во время слияния почты. |
| set_MergeDuplicateRegions(bool) | Устанавливает значение, указывающее, следует ли объединять все регионы слияния почты в документе с именем источника данных при выполнении слияния почты с регионами против источника данных или только первый. |
| set_MergeWholeDocument(bool) | Устанавливает значение, указывающее, обновляются ли поля во всём документе при выполнении слияния почты с регионами. |
| set_PreserveUnusedTags(bool) | Устанавливает значение, указывающее, следует ли сохранять неиспользуемые теги “mustache”. |
| set_RegionEndTag(const System::String&) | Устанавливает тег окончания региона слияния почты. |
| set_RegionStartTag(const System::String&) | Устанавливает тег начала региона слияния почты. |
| set_RestartListsAtEachSection(bool) | Устанавливает значение, указывающее, перезапускаются ли списки в каждом разделе после выполнения слияния почты. |
| set_RetainFirstSectionStart(bool) | Устанавливает значение, указывающее, сохраняются ли SectionStart первой секции документа и её копии для последующих строк источника данных во время слияния почты или обновляются в соответствии с поведением MS Word. |
| set_TrimWhitespaces(bool) | Устанавливает значение, указывающее, обрезаются ли начальные и конечные пробелы в значениях слияния почты. |
| set_UnconditionalMergeFieldsAndRegions(bool) | Устанавливает значение, указывающее, объединяются ли поля слияния и регионы слияния независимо от условия родительского поля IF. |
| set_UseNonMergeFields(bool) | Сеттер для Aspose::Words::MailMerging::MailMerge::get_UseNonMergeFields. |
| set_UseWholeParagraphAsRegion(bool) | Устанавливает значение, указывающее, следует ли включать в регион слияния почты весь абзац с полем TableStart или TableEnd, либо определённый диапазон между полями TableStart и TableEnd. |
| static Type() |
Примечания
Чтобы операция слияния почты работала, документ должен содержать поля Word MERGEFIELD и, при необходимости, NEXT. Во время операции слияния почты поля слияния в документе заменяются значениями из вашего источника данных.
Существует два разных способа использования слияния почты: с регионами слияния почты и без них.
Самое простое слияние почты — без регионов, и оно очень похоже на то, как слияние почты работает в Word. Используйте методы Execute для слияния информации из какого-либо источника данных, такого как DataTable, DataSet или массив объектов, в ваш документ. Объект MailMerge обрабатывает все записи источника данных и копирует и добавляет содержимое всего документа для каждой записи.
Обратите внимание, что когда объект MailMerge встречает поле NEXT, он выбирает следующую запись в источнике данных и продолжает слияние без копирования какого-либо содержимого.
Используйте ExecuteWithRegions() и другие перегрузки для слияния информации в документ с определёнными регионами слияния почты. Вы можете использовать их в качестве источников данных для этой операции.
Вам необходимо использовать регионы слияния почты, если вы хотите динамически расширять части внутри документа. Без регионов слияния почты весь документ будет повторяться для каждой записи источника данных.
См. также
- Namespace Aspose::Words::MailMerging
- Library Aspose.Words for C++
