MailMergeSettings
Overview
MailMergeSettings is a class in Aspose.Words FOSS for Java.
Inherits from: Cloneable.
Specifies all of the mail merge information for a document.
Edition status of its 50 listed members (a property and its accessor methods are listed separately, overloads once): 50 not yet exercised by a verified example.
This class declares 34 methods for MailMergeSettings objects in Java programs.
Available methods include: clear, deepClone, getActiveRecord, getAddressFieldName, getCheckErrors, getConnectString, getDataSource, getDataType, getDestination, getDoNotSupressBlankLines, getHeaderSource, getLinkToQuery, and 22 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: activeRecord, addressFieldName, checkErrors, connectString, dataSource, dataType, and 10 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
activeRecord | int | Read/Write | Specifies the one-based index of the record from the data source which shall be displayed in Microsoft Word. |
addressFieldName | String | Read/Write | Specifies the column within the data source that contains e-mail addresses. |
checkErrors | int | Read/Write | Specifies the type of error reporting which shall be conducted by Microsoft Word when performing a mail merge. |
connectString | String | Read/Write | Specifies the connection string used to connect to an external data source. |
dataSource | String | Read/Write | Specifies the path to the mail-merge data source. |
dataType | int | Read/Write | Specifies the type of the mail-merge data source and the method of data access. |
destination | int | Read/Write | Specifies how Microsoft Word will output the results of a mail merge. |
doNotSupressBlankLines | boolean | Read/Write | Specifies how an application performing the mail merge shall handle blank lines in the merged documents resulting from the mail merge. |
headerSource | String | Read/Write | Specifies the path to the mail-merge header source. |
linkToQuery | boolean | Read/Write | Not sure about this one. |
mailAsAttachment | boolean | Read/Write | Specifies that the documents produced during a mail merge operation should be emailed as an attachment rather than the body of the actual e-mail. |
mailSubject | String | Read/Write | Specifies the text which shall appear in the subject line of the e-mails or faxes produced during mail merge. |
mainDocumentType | int | Read/Write | Specifies the mail-merge main document type. |
odso | Odso | Read/Write | Gets or sets the object that specifies the Office Data Source Object (ODSO) settings. |
query | String | Read/Write | Contains the Structured Query Language string that shall be run against the specified external data source to return the set of records which shall be imported into the document when the mail merge operation is performed. |
viewMergedData | boolean | Read/Write | Specifies that Microsoft Word shall display the data from the specified external data source where merge fields have been inserted (e.g. preview merged data). |
Methods
| Signature | Description |
|---|---|
clear() | Clears the mail merge settings in such a way that when the document is saved, no mail merge settings will be saved and it will become a normal document. |
deepClone() → MailMergeSettings | Returns a deep clone of this object. |
getActiveRecord() → int | Specifies the one-based index of the record from the data source which shall be displayed in Microsoft Word. |
setActiveRecord(value: int) | Sets the active record value. |
getAddressFieldName() → String | Specifies the column within the data source that contains e-mail addresses. |
setAddressFieldName(value: String) | Sets the address field name value. |
getCheckErrors() → int | Specifies the type of error reporting which shall be conducted by Microsoft Word when performing a mail merge. |
setCheckErrors(value: int) | Sets the check errors value. |
getConnectString() → String | Specifies the connection string used to connect to an external data source. |
setConnectString(value: String) | Sets the connect string value. |
getDataSource() → String | Specifies the path to the mail-merge data source. |
setDataSource(value: String) | Sets the data source value. |
getDataType() → int | Specifies the type of the mail-merge data source and the method of data access. |
setDataType(value: int) | Sets the data type value. |
getDestination() → int | Specifies how Microsoft Word will output the results of a mail merge. |
setDestination(value: int) | Sets the destination value. |
getDoNotSupressBlankLines() → boolean | Specifies how an application performing the mail merge shall handle blank lines in the merged documents resulting from the mail merge. |
setDoNotSupressBlankLines(value: boolean) | Sets the do not supress blank lines value. |
getHeaderSource() → String | Specifies the path to the mail-merge header source. |
setHeaderSource(value: String) | Sets the header source value. |
getLinkToQuery() → boolean | Not sure about this one. |
setLinkToQuery(value: boolean) | Sets the link to query value. |
getMailAsAttachment() → boolean | Specifies that the documents produced during a mail merge operation should be emailed as an attachment rather than the body of the actual e-mail. |
setMailAsAttachment(value: boolean) | Sets the mail as attachment value. |
getMailSubject() → String | Specifies the text which shall appear in the subject line of the e-mails or faxes produced during mail merge. |
setMailSubject(value: String) | Sets the mail subject value. |
getMainDocumentType() → int | Specifies the mail-merge main document type. |
setMainDocumentType(value: int) | Sets the main document type value. |
getOdso() → Odso | Gets or sets the object that specifies the Office Data Source Object (ODSO) settings. |
setOdso(value: Odso) | Sets the odso value. |
getQuery() → String | Contains the Structured Query Language string that shall be run against the specified external data source to return the set of records which shall be imported into the document when the mail merge operation is performed. |
setQuery(value: String) | Sets the query value. |
getViewMergedData() → boolean | Specifies that Microsoft Word shall display the data from the specified external data source where merge fields have been inserted (e.g. preview merged data). |
setViewMergedData(value: boolean) | Sets the view merged data value. |