MailMerge

Наследование: java.lang.Object

public class MailMerge

Представляет функцию слияния почты.

Чтобы узнать больше, посетитеMail Merge and Reporting документальная статья.

Чтобы операция слияния работала, документ должен содержать поля Word MERGEFIELD и, возможно, NEXT. Во время операции слияния поля слияния в документе заменяются значениями из вашего источника данных.

Существует два разных способа использования слияния: с областями слияния и без них.

Самое простое слияние без регионов и очень похоже на то, как работает слияние в Word. Используйте методы Execute для слияния информации из какого-либо источника данных, напримерDataTable, DataSet или массив объектов в ваш документ.MailMergeобъект обрабатывает все записи источника данных, копирует и добавляет содержимое всего документа для каждой записи.

Обратите внимание, что когдаMailMerge объект встречает поле NEXT, он выбирает следующую запись в источнике данных и продолжает слияние без копирования какого-либо содержимого.

Используйте методы ExecuteWithRegions для объединения информации в документ с определенными областями слияния. Вы можете использовать или в качестве источников данных для этой операции.

Вам нужно использовать области слияния, если вы хотите динамически увеличивать части внутри документа. Без областей слияния весь документ будет повторяться для каждой записи источника данных.

Методы

МетодОписание
deleteFields()Удаляет поля, связанные со слиянием почты, из документа.
equals(Object arg0)
execute(IMailMergeDataSource dataSource)Выполняет слияние почты из пользовательского источника данных.
execute(System.Data.DataRow row)Выполняет слияние почты из DataRow в документ.
execute(System.Data.DataTable table)Выполняет слияние почты из com.aspose.words.net.System.Data.DataTable в документ.
execute(System.Data.DataView dataView)Выполняет слияние почты из DataView в документ.
execute(System.Data.IDataReader dataReader)Выполняет слияние почты из IDataReader в документ.
execute(String[] fieldNames, Object[] values)Выполняет операцию слияния почты.
executeWithRegions(IMailMergeDataSource dataSource)Выполняет слияние из пользовательского источника данных с областями слияния.
executeWithRegions(IMailMergeDataSourceRoot dataSourceRoot)Выполняет слияние из пользовательского источника данных с областями слияния.
executeWithRegions(System.Data.DataSet dataSet)Выполняет операцию слияния в документ с областями слияния.
executeWithRegions(System.Data.DataTable dataTable)Выполняет слияние почты из DataTable в документ с областями слияния.
executeWithRegions(System.Data.DataView dataView)Выполняет слияние почты из DataView в документ с областями слияния.
executeWithRegions(System.Data.IDataReader dataReader, String tableName)Выполняет слияние почты из IDataReader в документ с областями слияния.
getClass()
getCleanupOptions()Получает набор флагов, указывающих, какие элементы следует удалить во время слияния.
getCleanupParagraphsWithPunctuationMarks()Получает значение, указывающее, считаются ли абзацы со знаками препинания пустыми и должны ли они быть удалены, еслиMailMergeCleanupOptions.REMOVE_EMPTY_PARAGRAPHS опция указана.
getFieldMergingCallback()Происходит во время слияния, когда в документе встречается поле слияния.
getFieldNames()Возвращает коллекцию имен полей слияния, доступных в документе.
getFieldNamesForRegion(String regionName)Получить имена полей слияния из региона.
getFieldNamesForRegion(String regionName, int regionIndex)Возвращает коллекцию имен полей слияния, доступных в регионе.
getMailMergeCallback()Позволяет обрабатывать определенные события во время слияния почты.
getMappedDataFields()Возвращает коллекцию, представляющую сопоставленные поля данных для операции слияния.
getMergeDuplicateRegions()Получает значение, указывающее, следует ли объединять все области слияния документов с именем источника данных при выполнении слияния с областями для источника данных или только первую.
getMergeWholeDocument()Получает значение, указывающее, обновляются ли поля во всем документе при выполнении слияния почты с областями.
getPreserveUnusedTags()Получает значение, указывающее, следует ли сохранять неиспользуемые теги «усы».
getRegionEndTag()Получает конечный тег области слияния.
getRegionStartTag()Получает начальный тег области слияния.
getRegionsByName(String regionName)Возвращает коллекцию областей слияния с указанным именем.
getRegionsHierarchy()Возвращает полную иерархию областей (с полями), доступных в документе.
getRestartListsAtEachSection()Получает значение, указывающее, перезапускаются ли списки в каждом разделе после выполнения слияния.
getRetainFirstSectionStart()Получает значение, указывающее, является лиPageSetup.getSectionStart() / PageSetup.setSectionStart(int) первого раздела документа и его копии для последующих строк источника данных сохраняются во время слияния или обновляются в соответствии с поведением MS Word.
getTrimWhitespaces()Получает значение, указывающее, обрезаются ли конечные и начальные пробелы из значений слияния.
getUnconditionalMergeFieldsAndRegions()Получает значение, указывающее, объединяются ли поля слияния и области слияния независимо от условия родительского поля ЕСЛИ.
getUseNonMergeFields()Значение true указывает, что в дополнение к полям MERGEFIELD слияние выполняется с некоторыми другими типами полей, а также с “{{имя поля}}” теги.
getUseWholeParagraphAsRegion()Получает значение, указывающее, следует ли включать в область слияния весь абзац с полем TableStart или TableEnd или определенный диапазон между полями TableStart и TableEnd.
hashCode()
notify()
notifyAll()
setCleanupOptions(int value)Задает набор флагов, указывающих, какие элементы должны быть удалены во время слияния.
setCleanupParagraphsWithPunctuationMarks(boolean value)Задает значение, указывающее, считаются ли абзацы со знаками препинания пустыми и должны ли они быть удалены, еслиMailMergeCleanupOptions.REMOVE_EMPTY_PARAGRAPHS опция указана.
setFieldMergingCallback(IFieldMergingCallback value)Происходит во время слияния, когда в документе встречается поле слияния.
setMailMergeCallback(IMailMergeCallback value)Позволяет обрабатывать определенные события во время слияния почты.
setMergeDuplicateRegions(boolean value)Задает значение, указывающее, должны ли объединяться все области слияния документов с именем источника данных при выполнении слияния с областями для источника данных или только первая.
setMergeWholeDocument(boolean value)Задает значение, указывающее, обновляются ли поля во всем документе при выполнении слияния почты с областями.
setPreserveUnusedTags(boolean value)Устанавливает значение, указывающее, следует ли сохранять неиспользуемые теги «усы».
setRegionEndTag(String value)Устанавливает конечный тег области слияния.
setRegionStartTag(String value)Задает начальный тег области слияния.
setRestartListsAtEachSection(boolean value)Задает значение, указывающее, перезапускаются ли списки в каждом разделе после выполнения слияния.
setRetainFirstSectionStart(boolean value)Устанавливает значение, указывающее,PageSetup.getSectionStart() / PageSetup.setSectionStart(int) первого раздела документа и его копии для последующих строк источника данных сохраняются во время слияния или обновляются в соответствии с поведением MS Word.
setTrimWhitespaces(boolean value)Задает значение, указывающее, обрезаются ли конечные и начальные пробелы из значений слияния.
setUnconditionalMergeFieldsAndRegions(boolean value)Задает значение, указывающее, объединяются ли поля слияния и области слияния независимо от условия родительского поля ЕСЛИ.
setUseNonMergeFields(boolean value)Значение true указывает, что в дополнение к полям MERGEFIELD слияние выполняется с некоторыми другими типами полей, а также с “{{имя поля}}” теги.
setUseWholeParagraphAsRegion(boolean value)Задает значение, указывающее, следует ли включать в область слияния весь абзац с полем TableStart или TableEnd или определенный диапазон между полями TableStart и TableEnd.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

deleteFields()

public void deleteFields()

Удаляет поля, связанные со слиянием почты, из документа.

Этот метод удаляет поля MERGEFIELD и NEXT из документа.

Этот метод может быть полезен, если ваша операция слияния не всегда требует заполнения всех полей в документе. Используйте этот метод, чтобы удалить все оставшиеся поля слияния.

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

ПараметрТипОписание
arg0java.lang.Object

Возвращает: логический

execute(IMailMergeDataSource dataSource)

public void execute(IMailMergeDataSource dataSource)

Выполняет слияние почты из пользовательского источника данных.

Используйте этот метод для заполнения полей слияния в документе значениями из любого источника данных, например списка, хеш-таблицы или объектов. Вам нужно написать свой собственный класс, реализующийIMailMergeDataSource интерфейс.

Вы можете использовать этот метод только тогда, когдаFieldOptions.isBidiTextSupportedOnUpdate() / FieldOptions.isBidiTextSupportedOnUpdate(boolean) неверно, то есть вам не нужна совместимость с языками с письмом справа налево (такими как арабский или иврит).

Этот метод игнорируетMailMergeCleanupOptions.REMOVE_UNUSED_REGIONS вариант.

Параметры:

ПараметрТипОписание
dataSourceIMailMergeDataSourceОбъект, реализующий настраиваемый интерфейс источника данных для слияния почты.

execute(System.Data.DataRow row)

public void execute(System.Data.DataRow row)

Выполняет слияние почты из DataRow в документ.

Используйте этот метод для заполнения полей слияния в документе значениями изDataRow.

Этот метод игнорируетMailMergeCleanupOptions.REMOVE_UNUSED_REGIONS вариант.

Параметры:

ПараметрТипОписание
rowDataRowСтрока, содержащая данные для вставки в поля слияния. Имена полей не чувствительны к регистру. Если встречается имя поля, которого нет в документе, оно игнорируется.

execute(System.Data.DataTable table)

public void execute(System.Data.DataTable table)

Выполняет слияние почты из com.aspose.words.net.System.Data.DataTable в документ.

Используйте этот метод для заполнения полей слияния в документе значениями изDataTable.

Все записи из таблицы объединяются в документ.

Вы можете использовать поле NEXT в документе Word, чтобы вызватьMailMerge объект для выбора следующей записи изDataTable и продолжить слияние. Это можно использовать при создании таких документов, как почтовые этикетки.

КогдаMailMerge объект достигает конца основного документа, а вDataTable, он копирует все содержимое основного документа и добавляет его в конец целевого документа, используя в качестве разделителя разрыв раздела.

Этот метод игнорируетMailMergeCleanupOptions.REMOVE_UNUSED_REGIONS вариант.

Параметры:

ПараметрТипОписание
tableDataTableТаблица, содержащая данные для вставки в поля слияния. Имена полей не чувствительны к регистру. Если встречается имя поля, которого нет в документе, оно игнорируется.

execute(System.Data.DataView dataView)

public void execute(System.Data.DataView dataView)

Выполняет слияние почты из DataView в документ.

Этот метод полезен, если вы извлекаете данные вDataTable но затем необходимо применить фильтр или сортировку перед слиянием почты.

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

Этот метод игнорируетMailMergeCleanupOptions.REMOVE_UNUSED_REGIONS вариант.

Параметры:

ПараметрТипОписание
dataViewDataViewИсточник данных для операции слияния почты.

execute(System.Data.IDataReader dataReader)

public void execute(System.Data.IDataReader dataReader)

Выполняет слияние почты из IDataReader в документ.

Вы можете пройтиSqlDataReader или жеOleDbDataReader объект в этот метод в качестве параметра, потому что они оба реализовалиIDataReader интерфейс.

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

Этот метод игнорируетMailMergeCleanupOptions.REMOVE_UNUSED_REGIONS вариант.

Параметры:

ПараметрТипОписание
dataReaderIDataReaderИсточник данных для операции слияния почты.

execute(String[] fieldNames, Object[] values)

public void execute(String[] fieldNames, Object[] values)

Выполняет операцию слияния почты. Выполняет операцию слияния почты для одной записи.

Используйте этот метод для заполнения полей слияния в документе значениями из массива объектов.

Этот метод объединяет данные только для одной записи. Массив имен полей и массив значений представляют собой данные одной записи.

Этот метод не использует регионы слияния.

Этот метод игнорируетMailMergeCleanupOptions.REMOVE_UNUSED_REGIONS вариант.

Параметры:

ПараметрТипОписание
fieldNamesjava.lang.String[]Массив имен полей слияния. Имена полей не чувствительны к регистру. Если встречается имя поля, которого нет в документе, оно игнорируется.
valuesjava.lang.Object[]Массив значений для вставки в поля слияния. Количество элементов в этом массиве должно совпадать с количеством элементов в fieldNames.

executeWithRegions(IMailMergeDataSource dataSource)

public void executeWithRegions(IMailMergeDataSource dataSource)

Выполняет слияние из пользовательского источника данных с областями слияния.

Используйте этот метод, чтобы заполнить поля слияния в документе значениями из любого пользовательского источника данных, такого как XML-файл или коллекции бизнес-объектов. Вам нужно написать свой собственный класс, реализующийIMailMergeDataSource интерфейс.

Вы можете использовать этот метод только тогда, когдаFieldOptions.isBidiTextSupportedOnUpdate() / FieldOptions.isBidiTextSupportedOnUpdate(boolean) неверно, то есть вам не нужна совместимость с языками с письмом справа налево (такими как арабский или иврит).

Параметры:

ПараметрТипОписание
dataSourceIMailMergeDataSourceОбъект, реализующий настраиваемый интерфейс источника данных для слияния почты.

executeWithRegions(IMailMergeDataSourceRoot dataSourceRoot)

public void executeWithRegions(IMailMergeDataSourceRoot dataSourceRoot)

Выполняет слияние из пользовательского источника данных с областями слияния.

Используйте этот метод, чтобы заполнить поля слияния в документе значениями из любого пользовательского источника данных, такого как XML-файл или коллекции бизнес-объектов. Вам нужно написать свои собственные классы, которые реализуютIMailMergeDataSourceRoot а такжеIMailMergeDataSource интерфейсы.

Вы можете использовать этот метод только тогда, когдаFieldOptions.isBidiTextSupportedOnUpdate() / FieldOptions.isBidiTextSupportedOnUpdate(boolean) неверно, то есть вам не нужна совместимость с языками с письмом справа налево (такими как арабский или иврит).

Параметры:

ПараметрТипОписание
dataSourceRootIMailMergeDataSourceRootОбъект, реализующий настраиваемый корневой интерфейс источника данных слияния.

executeWithRegions(System.Data.DataSet dataSet)

public void executeWithRegions(System.Data.DataSet dataSet)

Выполняет операцию слияния в документ с областями слияния. Поддерживает источники данных «родитель-потомок» (основной-подробности) и вложенные области слияния почты. Выполняет слияние почты из набора данных в документ с областями слияния.

Используйте этот метод для выполнения слияния из одной или нескольких таблиц в повторяющиеся области слияния в документе. Области слияния внутри документа будут динамически увеличиваться, чтобы вместить записи в соответствующих таблицах.

В документе должны быть определены области слияния с именами, которые ссылаются на таблицы в наборе данных.

Чтобы указать область слияния в документе, вам нужно вставить два поля слияния, чтобы отметить начало и конец области слияния.

Все содержимое документа, включенного в область слияния, будет автоматически повторяться для каждой записи в DataTable.

Чтобы отметить начало области слияния, вставьте MERGEFIELD с именем TableStart:MyTable, где MyTable соответствует одному из имен таблиц в вашем наборе данных.

Чтобы отметить конец области слияния, вставьте еще одно поле MERGEFIELD с именем TableEnd:MyTable.

Чтобы вставить MERGEFIELD в Word, используйте команду Insert/Field и выберите MergeField, затем введите имя поля.

Поля TableStart и TableEnd должны находиться в одном и том же разделе документа.

При использовании внутри таблицы TableStart и TableEnd должны находиться в одной и той же строке таблицы.

Области слияния в документе должны быть правильно сформированы (всегда должна быть пара совпадающих полей слияния TableStart и TableEnd с одинаковым именем таблицы).

Параметры:

ПараметрТипОписание
dataSetDataSetНабор данных, содержащий данные для вставки в поля слияния.

executeWithRegions(System.Data.DataTable dataTable)

public void executeWithRegions(System.Data.DataTable dataTable)

Выполняет слияние почты из DataTable в документ с областями слияния.

Если в документе определены другие области слияния, они остаются нетронутыми. Это позволяет выполнять несколько операций слияния почты.

Параметры:

ПараметрТипОписание
dataTableDataTableИсточник данных для операции слияния почты. Таблица должна иметь свойTableName набор свойств.

executeWithRegions(System.Data.DataView dataView)

public void executeWithRegions(System.Data.DataView dataView)

Выполняет слияние почты из DataView в документ с областями слияния.

Этот метод полезен, если вы извлекаете данные вDataTable но затем необходимо применить фильтр или сортировку перед слиянием почты.

В документе должна быть определена область слияния с именем, совпадающимDataView.Table.TableName.

Если в документе определены другие области слияния, они остаются нетронутыми. Это позволяет выполнять несколько операций слияния почты.

Параметры:

ПараметрТипОписание
dataViewDataViewИсточник данных для операции слияния почты. Исходная таблицаDataView должен иметь свойTableName набор свойств.

executeWithRegions(System.Data.IDataReader dataReader, String tableName)

public void executeWithRegions(System.Data.IDataReader dataReader, String tableName)

Выполняет слияние почты из IDataReader в документ с областями слияния.

Вы можете пройтиSqlDataReader или жеOleDbDataReader объект в этот метод в качестве параметра, потому что они оба реализовалиIDataReader интерфейс.

Параметры:

ПараметрТипОписание
dataReaderIDataReaderИсточник записей данных для слияния, например OleDbDataReader или SqlDataReader.
tableNamejava.lang.StringИмя области слияния в документе для заполнения.

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getCleanupOptions()

public int getCleanupOptions()

Получает набор флагов, указывающих, какие элементы следует удалить во время слияния.

Возвращает: int — набор флагов, указывающих, какие элементы следует удалить во время слияния. Возвращаемое значение представляет собой побитовую комбинациюMailMergeCleanupOptions константы.

getCleanupParagraphsWithPunctuationMarks()

public boolean getCleanupParagraphsWithPunctuationMarks()

Получает значение, указывающее, считаются ли абзацы со знаками препинания пустыми и должны ли они быть удалены, еслиMailMergeCleanupOptions.REMOVE_EMPTY_PARAGRAPHSопция указана. Значение по умолчанию верно . Вот полный список очищаемых знаков препинания:

  • !
  • ,
  • .
  • :
  • ;
  • ?

Возвращает: логическое значение — значение, указывающее, считаются ли абзацы со знаками препинания пустыми и должны ли они быть удалены, еслиMailMergeCleanupOptions.REMOVE_EMPTY_PARAGRAPHS опция указана.

getFieldMergingCallback()

public IFieldMergingCallback getFieldMergingCallback()

Происходит во время слияния, когда в документе встречается поле слияния.

Возвращает: IFieldMergingCallback - соответствующийIFieldMergingCallback ценность.

getFieldNames()

public String[] getFieldNames()

Возвращает коллекцию имен полей слияния, доступных в документе.

Возвращает полные имена полей слияния, включая необязательный префикс. Не устраняет повторяющиеся имена полей.

Новая строка[] создается при каждом вызове.

Включает имена полей «усы», еслиgetUseNonMergeFields() / setUseNonMergeFields(boolean) являетсяtrue.

Возвращает: java.lang.String[]

getFieldNamesForRegion(String regionName)

public String[] getFieldNamesForRegion(String regionName)

Получить имена полей слияния из региона. Возвращает коллекцию имен полей слияния, доступных в регионе.

Возвращает полные имена полей слияния, включая необязательный префикс. Не устраняет повторяющиеся имена полей.

Если документ содержит несколько регионов с одинаковым названием, обрабатывается самый первый регион.

Новый массив строк создается при каждом вызове.

Параметры:

ПараметрТипОписание
regionNamejava.lang.StringНазвание региона (без учета регистра).

Возвращает: java.lang.String[]

getFieldNamesForRegion(String regionName, int regionIndex)

public String[] getFieldNamesForRegion(String regionName, int regionIndex)

Возвращает коллекцию имен полей слияния, доступных в регионе.

Возвращает полные имена полей слияния, включая необязательный префикс. Не устраняет повторяющиеся имена полей.

Если документ содержит несколько регионов с одинаковыми именами, обрабатывается N-й регион (начиная с нуля).

Новый массив строк создается при каждом вызове.

Параметры:

ПараметрТипОписание
regionNamejava.lang.StringНазвание региона (без учета регистра).
regionIndexintИндекс региона (с нуля).

Возвращает: java.lang.String[]

getMailMergeCallback()

public IMailMergeCallback getMailMergeCallback()

Позволяет обрабатывать определенные события во время слияния почты.

Возвращает: IMailMergeCallback - соответствующийIMailMergeCallback ценность.

getMappedDataFields()

public MappedDataFieldCollection getMappedDataFields()

Возвращает коллекцию, представляющую сопоставленные поля данных для операции слияния.

Сопоставленные поля данных позволяют автоматически сопоставлять имена полей в источнике данных и имена полей слияния в документе.

Возвращает: MappedDataFieldCollection — Коллекция, представляющая сопоставленные поля данных для операции слияния почты.

getMergeDuplicateRegions()

public boolean getMergeDuplicateRegions()

Получает значение, указывающее, следует ли объединять все области слияния документов с именем источника данных при выполнении слияния с областями для источника данных или только первую. Значение по умолчаниюfalse.

Возвращает: логическое значение — значение, указывающее, должны ли объединяться все области слияния документов с именем источника данных при выполнении слияния с областями для источника данных или только первая.

getMergeWholeDocument()

public boolean getMergeWholeDocument()

Получает значение, указывающее, обновляются ли поля во всем документе при выполнении слияния почты с областями. Значение по умолчаниюfalse.

Возвращает: логическое значение — значение, указывающее, обновляются ли поля во всем документе при выполнении слияния почты с областями.

getPreserveUnusedTags()

public boolean getPreserveUnusedTags()

Получает значение, указывающее, следует ли сохранять неиспользуемые теги «усы». Значение по умолчаниюfalse.

Возвращает: boolean — значение, указывающее, следует ли сохранять неиспользуемые теги «усы».

getRegionEndTag()

public String getRegionEndTag()

Получает конечный тег области слияния.

Возвращает: java.lang.String — конечный тег области слияния.

getRegionStartTag()

public String getRegionStartTag()

Получает начальный тег области слияния.

Возвращает: java.lang.String — начальный тег области слияния.

getRegionsByName(String regionName)

public ArrayList getRegionsByName(String regionName)

Возвращает коллекцию областей слияния с указанным именем.

Параметры:

ПараметрТипОписание
regionNamejava.lang.StringНазвание региона (без учета регистра).

Возвращает: java.util.ArrayList — Список регионов.

getRegionsHierarchy()

public MailMergeRegionInfo getRegionsHierarchy()

Возвращает полную иерархию областей (с полями), доступных в документе.

Иерархия возвращается в видеMailMergeRegionInfo учебный класс.

Возвращает: MailMergeRegionInfo - Иерархия регионов.

getRestartListsAtEachSection()

public boolean getRestartListsAtEachSection()

Получает значение, указывающее, перезапускаются ли списки в каждом разделе после выполнения слияния. Значение по умолчаниюtrue.

Возвращает: логическое значение — значение, указывающее, перезапускаются ли списки в каждом разделе после выполнения слияния.

getRetainFirstSectionStart()

public boolean getRetainFirstSectionStart()

Получает значение, указывающее, является лиPageSetup.getSectionStart() / PageSetup.setSectionStart(int) первого раздела документа и его копии для последующих строк источника данных сохраняются во время слияния или обновляются в соответствии с поведением MS Word. Значение по умолчаниюtrue.

Возвращает: boolean - значение, указывающее, является лиPageSetup.getSectionStart() / PageSetup.setSectionStart(int) первого раздела документа и его копии для последующих строк источника данных сохраняются во время слияния или обновляются в соответствии с поведением MS Word.

getTrimWhitespaces()

public boolean getTrimWhitespaces()

Получает значение, указывающее, обрезаются ли конечные и начальные пробелы из значений слияния. Значение по умолчаниюtrue.

Возвращает: boolean — значение, указывающее, обрезаются ли конечные и ведущие пробелы из значений слияния почты.

getUnconditionalMergeFieldsAndRegions()

public boolean getUnconditionalMergeFieldsAndRegions()

Получает значение, указывающее, объединяются ли поля слияния и области слияния независимо от условия родительского поля ЕСЛИ. Значение по умолчаниюfalse.

Возвращает: логическое значение — значение, указывающее, объединяются ли поля слияния и области слияния независимо от условия родительского поля IF.

getUseNonMergeFields()

public boolean getUseNonMergeFields()

Значение true указывает, что в дополнение к полям MERGEFIELD слияние выполняется с некоторыми другими типами полей, а также с “{{имя поля}}” теги.

Обычно слияние почты выполняется только в полях MERGEFIELD, но несколько клиентов построили свои отчеты с использованием других полей и таким образом создали множество документов. Для упрощения миграции (и поскольку этот подход использовался несколькими клиентами независимо друг от друга) была введена возможность слияния почты с другими полями.

КогдаUseNonMergeFields установлено значение true, Aspose.Words будет выполнять слияние почты в следующие поля:

MERGEFIELD имя поля

MACROBUTTON NOMACRO Имя поля

ЕСЛИ 0 = 0 “{имя поля}” ""

Кроме того, когдаUserNonMergeFields установлено значение true, Aspose.Words будет выполнять слияние почты в текстовые теги “{{имя поля}}”. Это не поля, а просто текстовые теги.

Возвращает: boolean - соответствующее логическое значение.

getUseWholeParagraphAsRegion()

public boolean getUseWholeParagraphAsRegion()

Получает значение, указывающее, следует ли включать в область слияния весь абзац с полем TableStart или TableEnd или определенный диапазон между полями TableStart и TableEnd. Значение по умолчаниюtrue.

Возвращает: boolean — значение, указывающее, следует ли включать в область слияния весь абзац с полем TableStart или TableEnd или определенный диапазон между полями TableStart и TableEnd.

hashCode()

public native int hashCode()

Возвращает: инт

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCleanupOptions(int value)

public void setCleanupOptions(int value)

Задает набор флагов, указывающих, какие элементы должны быть удалены во время слияния.

Параметры:

ПараметрТипОписание
valueintНабор флагов, указывающих, какие элементы должны быть удалены во время слияния. Значение должно быть побитовой комбинациейMailMergeCleanupOptions константы.

setCleanupParagraphsWithPunctuationMarks(boolean value)

public void setCleanupParagraphsWithPunctuationMarks(boolean value)

Задает значение, указывающее, считаются ли абзацы со знаками препинания пустыми и должны ли они быть удалены, еслиMailMergeCleanupOptions.REMOVE_EMPTY_PARAGRAPHSопция указана. Значение по умолчанию верно . Вот полный список очищаемых знаков препинания:

  • !
  • ,
  • .
  • :
  • ;
  • ?

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, считаются ли абзацы со знаками препинания пустыми и должны ли они быть удалены, еслиMailMergeCleanupOptions.REMOVE_EMPTY_PARAGRAPHS опция указана.

setFieldMergingCallback(IFieldMergingCallback value)

public void setFieldMergingCallback(IFieldMergingCallback value)

Происходит во время слияния, когда в документе встречается поле слияния.

Параметры:

ПараметрТипОписание
valueIFieldMergingCallbackСоответствующийIFieldMergingCallback ценность.

setMailMergeCallback(IMailMergeCallback value)

public void setMailMergeCallback(IMailMergeCallback value)

Позволяет обрабатывать определенные события во время слияния почты.

Параметры:

ПараметрТипОписание
valueIMailMergeCallbackСоответствующийIMailMergeCallback ценность.

setMergeDuplicateRegions(boolean value)

public void setMergeDuplicateRegions(boolean value)

Задает значение, указывающее, должны ли объединяться все области слияния документов с именем источника данных при выполнении слияния с областями для источника данных или только первая. Значение по умолчаниюfalse.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, следует ли объединять все регионы слияния документов с именем источника данных при выполнении слияния с регионами для источника данных или только первый.

setMergeWholeDocument(boolean value)

public void setMergeWholeDocument(boolean value)

Задает значение, указывающее, обновляются ли поля во всем документе при выполнении слияния почты с областями. Значение по умолчаниюfalse.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, обновляются ли поля во всем документе при выполнении слияния почты с областями.

setPreserveUnusedTags(boolean value)

public void setPreserveUnusedTags(boolean value)

Устанавливает значение, указывающее, следует ли сохранять неиспользуемые теги «усы». Значение по умолчаниюfalse.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, следует ли сохранять неиспользуемые теги «усы».

setRegionEndTag(String value)

public void setRegionEndTag(String value)

Устанавливает конечный тег области слияния.

Параметры:

ПараметрТипОписание
valuejava.lang.StringКонечный тег области слияния.

setRegionStartTag(String value)

public void setRegionStartTag(String value)

Задает начальный тег области слияния.

Параметры:

ПараметрТипОписание
valuejava.lang.StringНачальный тег области слияния.

setRestartListsAtEachSection(boolean value)

public void setRestartListsAtEachSection(boolean value)

Задает значение, указывающее, перезапускаются ли списки в каждом разделе после выполнения слияния. Значение по умолчаниюtrue.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, перезапускаются ли списки в каждом разделе после выполнения слияния.

setRetainFirstSectionStart(boolean value)

public void setRetainFirstSectionStart(boolean value)

Устанавливает значение, указывающее,PageSetup.getSectionStart() / PageSetup.setSectionStart(int) первого раздела документа и его копии для последующих строк источника данных сохраняются во время слияния или обновляются в соответствии с поведением MS Word. Значение по умолчаниюtrue.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, является лиPageSetup.getSectionStart() / PageSetup.setSectionStart(int) первого раздела документа и его копии для последующих строк источника данных сохраняются во время слияния или обновляются в соответствии с поведением MS Word.

setTrimWhitespaces(boolean value)

public void setTrimWhitespaces(boolean value)

Задает значение, указывающее, обрезаются ли конечные и начальные пробелы из значений слияния. Значение по умолчаниюtrue.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, обрезаются ли конечные и начальные пробелы из значений слияния.

setUnconditionalMergeFieldsAndRegions(boolean value)

public void setUnconditionalMergeFieldsAndRegions(boolean value)

Задает значение, указывающее, объединяются ли поля слияния и области слияния независимо от условия родительского поля ЕСЛИ. Значение по умолчаниюfalse.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, объединяются ли поля слияния и области слияния независимо от условия родительского поля IF.

setUseNonMergeFields(boolean value)

public void setUseNonMergeFields(boolean value)

Значение true указывает, что в дополнение к полям MERGEFIELD слияние выполняется с некоторыми другими типами полей, а также с “{{имя поля}}” теги.

Обычно слияние почты выполняется только в полях MERGEFIELD, но несколько клиентов построили свои отчеты с использованием других полей и таким образом создали множество документов. Для упрощения миграции (и поскольку этот подход использовался несколькими клиентами независимо друг от друга) была введена возможность слияния почты с другими полями.

КогдаUseNonMergeFields установлено значение true, Aspose.Words будет выполнять слияние почты в следующие поля:

MERGEFIELD имя поля

MACROBUTTON NOMACRO Имя поля

ЕСЛИ 0 = 0 “{имя поля}” ""

Кроме того, когдаUserNonMergeFields установлено значение true, Aspose.Words будет выполнять слияние почты в текстовые теги “{{имя поля}}”. Это не поля, а просто текстовые теги.

Параметры:

ПараметрТипОписание
valuebooleanСоответствующее логическое значение.

setUseWholeParagraphAsRegion(boolean value)

public void setUseWholeParagraphAsRegion(boolean value)

Задает значение, указывающее, следует ли включать в область слияния весь абзац с полем TableStart или TableEnd или определенный диапазон между полями TableStart и TableEnd. Значение по умолчаниюtrue.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, следует ли включать в область слияния весь абзац с полем TableStart или TableEnd или определенный диапазон между полями TableStart и TableEnd.

toString()

public String toString()

Возвращает: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

ПараметрТипОписание
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

ПараметрТипОписание
arg0long
arg1int