MailMergeSettings

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

Все реализованные интерфейсы: java.lang.Cloneable

public class MailMergeSettings implements Cloneable

Указывает всю информацию о слиянии для документа.

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

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

Обычно вам не нужно создавать объекты этого класса напрямую, потому что настройки слияния документов всегда доступны черезDocument.getMailMergeSettings() / Document.setMailMergeSettings(com.aspose.words.MailMergeSettings) имущество.

Чтобы определить, является ли этот документ основным документом слияния, проверьте значениеgetMainDocumentType() / setMainDocumentType(int) имущество.

Чтобы удалить настройки слияния и информацию об источнике данных из документа, вы можете использоватьclear() метод. Aspose.Words не будет записывать настройки слияния в документ, еслиgetMainDocumentType() / setMainDocumentType(int) свойство установлено наMailMergeMainDocumentType.NOT_A_MERGE_DOCUMENT илиgetDataType() / setDataType(int) свойство установлено наMailMergeDataType.NONE.

Лучший способ научиться использовать свойства этого объекта — создать документ с нужным источником данных вручную в Microsoft Word, а затем открыть этот документ с помощью Aspose.Words и изучить свойства объекта.Document.getMailMergeSettings() / Document.setMailMergeSettings(com.aspose.words.MailMergeSettings) а такжеgetOdso() / setOdso(com.aspose.words.Odso)объекты. Это хороший подход, если вы хотите научиться, например, программно настраивать источник данных.

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

Методы

Метод	Описание
clear()	Очищает настройки слияния таким образом, что при сохранении документа никакие настройки слияния не сохраняются, и он становится обычным документом.
deepClone()	Возвращает глубокий клон этого объекта.
equals(Object arg0)
getActiveRecord()	Указывает индекс записи из источника данных, который должен отображаться в Microsoft Word.
getAddressFieldName()	Указывает столбец в источнике данных, который содержит адреса электронной почты.
getCheckErrors()	Указывает тип отчетов об ошибках, которые должны создаваться Microsoft Word при выполнении слияния.
getClass()
getConnectString()	Указывает строку подключения, используемую для подключения к внешнему источнику данных.
getDataSource()	Указывает путь к источнику данных для слияния.
getDataType()	Указывает тип источника данных для слияния и метод доступа к данным.
getDestination()	Указывает, как Microsoft Word будет выводить результаты слияния.
getDoNotSupressBlankLines()	Указывает, как приложение, выполняющее слияние, должно обрабатывать пустые строки в объединенных документах, полученных в результате слияния.
getHeaderSource()	Указывает путь к источнику заголовка слияния.
getLinkToQuery()	Не уверен насчет этого.
getMailAsAttachment()	Указывает, что документы, созданные во время операции слияния, следует отправлять по электронной почте в виде вложений, а не в виде тела фактического сообщения электронной почты.
getMailSubject()	Определяет текст, который должен отображаться в строке темы сообщений электронной почты или факсов, созданных во время слияния.
getMainDocumentType()	Указывает тип основного документа для слияния.
getOdso()	Получает объект, указывающий параметры объекта источника данных Office (ODSO).
getQuery()	Содержит строку языка структурированных запросов, которая должна выполняться для указанного внешнего источника данных, чтобы вернуть набор записей, которые должны быть импортированы в документ при выполнении операции слияния.
getViewMergedData()	Указывает, что Microsoft Word должен отображать данные из указанного внешнего источника данных, в который были вставлены поля слияния (например,
hashCode()
notify()
notifyAll()
setActiveRecord(int value)	Указывает индекс записи из источника данных, который должен отображаться в Microsoft Word.
setAddressFieldName(String value)	Указывает столбец в источнике данных, который содержит адреса электронной почты.
setCheckErrors(int value)	Указывает тип отчетов об ошибках, которые должны создаваться Microsoft Word при выполнении слияния.
setConnectString(String value)	Указывает строку подключения, используемую для подключения к внешнему источнику данных.
setDataSource(String value)	Указывает путь к источнику данных для слияния.
setDataType(int value)	Указывает тип источника данных для слияния и метод доступа к данным.
setDestination(int value)	Указывает, как Microsoft Word будет выводить результаты слияния.
setDoNotSupressBlankLines(boolean value)	Указывает, как приложение, выполняющее слияние, должно обрабатывать пустые строки в объединенных документах, полученных в результате слияния.
setHeaderSource(String value)	Указывает путь к источнику заголовка слияния.
setLinkToQuery(boolean value)	Не уверен насчет этого.
setMailAsAttachment(boolean value)	Указывает, что документы, созданные во время операции слияния, следует отправлять по электронной почте в виде вложений, а не в виде тела фактического сообщения электронной почты.
setMailSubject(String value)	Определяет текст, который должен отображаться в строке темы сообщений электронной почты или факсов, созданных во время слияния.
setMainDocumentType(int value)	Указывает тип основного документа для слияния.
setOdso(Odso value)	Задает объект, указывающий параметры объекта источника данных Office (ODSO).
setQuery(String value)	Содержит строку языка структурированных запросов, которая должна выполняться для указанного внешнего источника данных, чтобы вернуть набор записей, которые должны быть импортированы в документ при выполнении операции слияния.
setViewMergedData(boolean value)	Указывает, что Microsoft Word должен отображать данные из указанного внешнего источника данных, в который были вставлены поля слияния (например,
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

clear()

public void clear()

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

deepClone()

public MailMergeSettings deepClone()

Возвращает глубокий клон этого объекта.

Возвращает: MailMergeSettings

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

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

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

getActiveRecord()

public int getActiveRecord()

Указывает индекс записи из источника данных, который должен отображаться в Microsoft Word. Значение по умолчанию — 1.

Возвращает: int - соответствующее значение int.

getAddressFieldName()

public String getAddressFieldName()

Указывает столбец в источнике данных, который содержит адреса электронной почты. Значение по умолчанию — пустая строка.

Возвращает: java.lang.String — соответствующее значение java.lang.String.

getCheckErrors()

public int getCheckErrors()

Указывает тип отчетов об ошибках, которые должны создаваться Microsoft Word при выполнении слияния. Значение по умолчаниюMailMergeCheckErrors.DEFAULT.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изMailMergeCheckErrors константы.

getClass()

public final native Class<?> getClass()

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

getConnectString()

public String getConnectString()

Указывает строку подключения, используемую для подключения к внешнему источнику данных. Значение по умолчанию — пустая строка.

Возвращает: java.lang.String — соответствующее значение java.lang.String.

getDataSource()

public String getDataSource()

Указывает путь к источнику данных для слияния. Значение по умолчанию — пустая строка.

Возвращает: java.lang.String — соответствующее значение java.lang.String.

getDataType()

public int getDataType()

Указывает тип источника данных для слияния и метод доступа к данным. Значение по умолчаниюMailMergeDataType.DEFAULT.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изMailMergeDataType константы.

getDestination()

public int getDestination()

Указывает, как Microsoft Word будет выводить результаты слияния. Значение по умолчаниюMailMergeDestination.DEFAULT.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изMailMergeDestination константы.

getDoNotSupressBlankLines()

public boolean getDoNotSupressBlankLines()

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

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

getHeaderSource()

public String getHeaderSource()

Указывает путь к источнику заголовка слияния. Значение по умолчанию — пустая строка.

Возвращает: java.lang.String — соответствующее значение java.lang.String.

getLinkToQuery()

public boolean getLinkToQuery()

Не уверен насчет этого. Справочник по автоматизации Microsoft Word предполагает, что это указывает, что запрос выполняется каждый раз, когда документ открывается в Microsoft Word. Но спецификация OOXML предполагает, что это указывает на то, что запрос содержит ссылку на внешний файл запроса, который содержит фактический запрос. Значение по умолчанию неверно .

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

getMailAsAttachment()

public boolean getMailAsAttachment()

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

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

getMailSubject()

public String getMailSubject()

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

Возвращает: java.lang.String — соответствующее значение java.lang.String.

getMainDocumentType()

public int getMainDocumentType()

Указывает тип основного документа для слияния. Значение по умолчаниюMailMergeMainDocumentType.DEFAULT.

Основной документ — это документ, содержащий информацию, одинаковую для каждой версии объединенного документа.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изMailMergeMainDocumentType константы.

getOdso()

public Odso getOdso()

Получает объект, указывающий параметры объекта источника данных Office (ODSO).

Этот объект никогда не бывает нулевым.

Возвращает: Odso - Объект, указывающий параметры объекта источника данных Office (ODSO).

getQuery()

public String getQuery()

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

Возвращает: java.lang.String — соответствующее значение java.lang.String.

getViewMergedData()

public boolean getViewMergedData()

Указывает, что Microsoft Word должен отображать данные из указанного внешнего источника данных, в который были вставлены поля слияния (например, предварительный просмотр объединенных данных). Значение по умолчанию неверно .

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

hashCode()

public native int hashCode()

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

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setActiveRecord(int value)

public void setActiveRecord(int value)

Указывает индекс записи из источника данных, который должен отображаться в Microsoft Word. Значение по умолчанию — 1.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение.

setAddressFieldName(String value)

public void setAddressFieldName(String value)

Указывает столбец в источнике данных, который содержит адреса электронной почты. Значение по умолчанию — пустая строка.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Соответствующее значение java.lang.String.

setCheckErrors(int value)

public void setCheckErrors(int value)

Указывает тип отчетов об ошибках, которые должны создаваться Microsoft Word при выполнении слияния. Значение по умолчаниюMailMergeCheckErrors.DEFAULT.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изMailMergeCheckErrors константы.

setConnectString(String value)

public void setConnectString(String value)

Указывает строку подключения, используемую для подключения к внешнему источнику данных. Значение по умолчанию — пустая строка.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Соответствующее значение java.lang.String.

setDataSource(String value)

public void setDataSource(String value)

Указывает путь к источнику данных для слияния. Значение по умолчанию — пустая строка.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Соответствующее значение java.lang.String.

setDataType(int value)

public void setDataType(int value)

Указывает тип источника данных для слияния и метод доступа к данным. Значение по умолчаниюMailMergeDataType.DEFAULT.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изMailMergeDataType константы.

setDestination(int value)

public void setDestination(int value)

Указывает, как Microsoft Word будет выводить результаты слияния. Значение по умолчаниюMailMergeDestination.DEFAULT.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изMailMergeDestination константы.

setDoNotSupressBlankLines(boolean value)

public void setDoNotSupressBlankLines(boolean value)

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

Параметры:

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

setHeaderSource(String value)

public void setHeaderSource(String value)

Указывает путь к источнику заголовка слияния. Значение по умолчанию — пустая строка.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Соответствующее значение java.lang.String.

setLinkToQuery(boolean value)

public void setLinkToQuery(boolean value)

Не уверен насчет этого. Справочник по автоматизации Microsoft Word предполагает, что это указывает, что запрос выполняется каждый раз, когда документ открывается в Microsoft Word. Но спецификация OOXML предполагает, что это указывает на то, что запрос содержит ссылку на внешний файл запроса, который содержит фактический запрос. Значение по умолчанию неверно .

Параметры:

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

setMailAsAttachment(boolean value)

public void setMailAsAttachment(boolean value)

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

Параметры:

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

setMailSubject(String value)

public void setMailSubject(String value)

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

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Соответствующее значение java.lang.String.

setMainDocumentType(int value)

public void setMainDocumentType(int value)

Указывает тип основного документа для слияния. Значение по умолчаниюMailMergeMainDocumentType.DEFAULT.

Основной документ — это документ, содержащий информацию, одинаковую для каждой версии объединенного документа.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изMailMergeMainDocumentType константы.

setOdso(Odso value)

public void setOdso(Odso value)

Задает объект, указывающий параметры объекта источника данных Office (ODSO).

Этот объект никогда не бывает нулевым.

Параметры:

Параметр	Тип	Описание
value	Odso	Объект, указывающий параметры объекта источника данных Office (ODSO).

setQuery(String value)

public void setQuery(String value)

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

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Соответствующее значение java.lang.String.

setViewMergedData(boolean value)

public void setViewMergedData(boolean value)

Указывает, что Microsoft Word должен отображать данные из указанного внешнего источника данных, в который были вставлены поля слияния (например, предварительный просмотр объединенных данных). Значение по умолчанию неверно .

Параметры:

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

toString()

public String toString()

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

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

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

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

Параметр	Тип	Описание
arg0	long
arg1	int