com.aspose.words

com.aspose.words

Class MailMergeSettings

  • java.lang.Object
    • com.aspose.words.MailMergeSettings
  • All Implemented Interfaces:
    java.lang.Cloneable
    public class MailMergeSettings 
    extends java.lang.Object

Specifies all of the mail merge information for a document.

You can use this object to specify a mail merge data source for a document and this information (along with the available data fields) will appear in Microsoft Word when the user opens this document. Or you can use this object to query mail merge settings that the user has specified in Microsoft Word for this document.

You do not normally need to create objects of this class directly because Mail merge settings of a document are always available via the Document.MailMergeSettings property.

To detect whether this document is a mail merge main document, check the value of the MainDocumentType property.

To remove mail merge settings and data source information from a document you can use the clear() method. Aspose.Words will not write mail merge settings to a document if the MainDocumentType property is set to MailMergeMainDocumentType.NOT_A_MERGE_DOCUMENT or the DataType property is set to MailMergeDataType.NONE.

The best way to learn how to use the properties of this object is to create a document with a desired data source manually in Microsoft Word and then open that document using Aspose.Words and examine the properties of the Document.MailMergeSettings and Odso objects. This is a good approach to take if you want to learn how to programmatically configure a data source, for example.

Aspose.Words preserves mail merge information when loading, saving and converting documents between different formats, but does not use this information when performing its own mail merge using the MailMerge object.

See Also:
Document.MailMergeSettings

Constructor Summary
MailMergeSettings()
 
Property Getters/Setters Summary
intgetActiveRecord()
void
setActiveRecord(intvalue)
           Specifies the one-based index of the record from the data source which shall be displayed in Microsoft Word. The default value is 1.
java.lang.StringgetAddressFieldName()
void
setAddressFieldName(java.lang.Stringvalue)
           Specifies the column within the data source that contains e-mail addresses. The default value is an empty string.
intgetCheckErrors()
void
setCheckErrors(intvalue)
           Specifies the type of error reporting which shall be conducted by Microsoft Word when performing a mail merge. The default value is MailMergeCheckErrors.DEFAULT. The value of the property is MailMergeCheckErrors integer constant.
java.lang.StringgetConnectString()
void
setConnectString(java.lang.Stringvalue)
           Specifies the connection string used to connect to an external data source. The default value is an empty string.
java.lang.StringgetDataSource()
void
setDataSource(java.lang.Stringvalue)
           Specifies the path to the mail-merge data source. The default value is an empty string.
intgetDataType()
void
setDataType(intvalue)
           Specifies the type of the mail-merge data source and the method of data access. The default value is MailMergeDataType.DEFAULT. The value of the property is MailMergeDataType integer constant.
intgetDestination()
void
setDestination(intvalue)
           Specifies how Microsoft Word will output the results of a mail merge. The default value is MailMergeDestination.DEFAULT. The value of the property is MailMergeDestination integer constant.
booleangetDoNotSupressBlankLines()
void
setDoNotSupressBlankLines(booleanvalue)
           Specifies how an application performing the mail merge shall handle blank lines in the merged documents resulting from the mail merge. The default value is false.
java.lang.StringgetHeaderSource()
void
setHeaderSource(java.lang.Stringvalue)
           Specifies the path to the mail-merge header source. The default value is an empty string.
booleangetLinkToQuery()
void
setLinkToQuery(booleanvalue)
           Not sure about this one. The Microsoft Word Automation Reference suggests that this specifies that the query is executed every time the document is opened in Microsoft Word. But the OOXML specification suggests that this specifies that the query contains a reference to an external query file which contains the actual query. The default value is false.
booleangetMailAsAttachment()
void
setMailAsAttachment(booleanvalue)
           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. The default value is false.
java.lang.StringgetMailSubject()
void
setMailSubject(java.lang.Stringvalue)
           Specifies the text which shall appear in the subject line of the e-mails or faxes produced during mail merge. The default value is an empty string.
intgetMainDocumentType()
void
setMainDocumentType(intvalue)
           Specifies the mail-merge main document type. The default value is MailMergeMainDocumentType.DEFAULT. The value of the property is MailMergeMainDocumentType integer constant.
OdsogetOdso()
void
setOdso(Odso value)
           Gets or sets the object that specifies the Office Data Source Object (ODSO) settings.
java.lang.StringgetQuery()
void
setQuery(java.lang.Stringvalue)
           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. The default value is an empty string.
booleangetViewMergedData()
void
setViewMergedData(booleanvalue)
           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). The default value is false.
 
Method Summary
voidclear()
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.
MailMergeSettingsdeepClone()
Returns a deep clone of this object.
 

    • Constructor Detail

      • MailMergeSettings

        public MailMergeSettings()

    • Property Getters/Setters Detail

      • getActiveRecord/setActiveRecord

        public int getActiveRecord() / public void setActiveRecord(int value)
        Specifies the one-based index of the record from the data source which shall be displayed in Microsoft Word. The default value is 1.

      • getAddressFieldName/setAddressFieldName

        public java.lang.String getAddressFieldName() / public void setAddressFieldName(java.lang.String value)
        Specifies the column within the data source that contains e-mail addresses. The default value is an empty string.

      • getCheckErrors/setCheckErrors

        public int getCheckErrors() / public void setCheckErrors(int value)
        Specifies the type of error reporting which shall be conducted by Microsoft Word when performing a mail merge. The default value is MailMergeCheckErrors.DEFAULT. The value of the property is MailMergeCheckErrors integer constant.

      • getConnectString/setConnectString

        public java.lang.String getConnectString() / public void setConnectString(java.lang.String value)
        Specifies the connection string used to connect to an external data source. The default value is an empty string.

      • getDataSource/setDataSource

        public java.lang.String getDataSource() / public void setDataSource(java.lang.String value)
        Specifies the path to the mail-merge data source. The default value is an empty string.

      • getDataType/setDataType

        public int getDataType() / public void setDataType(int value)
        Specifies the type of the mail-merge data source and the method of data access. The default value is MailMergeDataType.DEFAULT. The value of the property is MailMergeDataType integer constant.

      • getDestination/setDestination

        public int getDestination() / public void setDestination(int value)
        Specifies how Microsoft Word will output the results of a mail merge. The default value is MailMergeDestination.DEFAULT. The value of the property is MailMergeDestination integer constant.

      • getDoNotSupressBlankLines/setDoNotSupressBlankLines

        public boolean getDoNotSupressBlankLines() / public void setDoNotSupressBlankLines(boolean value)
        Specifies how an application performing the mail merge shall handle blank lines in the merged documents resulting from the mail merge. The default value is false.

      • getHeaderSource/setHeaderSource

        public java.lang.String getHeaderSource() / public void setHeaderSource(java.lang.String value)
        Specifies the path to the mail-merge header source. The default value is an empty string.

      • getLinkToQuery/setLinkToQuery

        public boolean getLinkToQuery() / public void setLinkToQuery(boolean value)
        Not sure about this one. The Microsoft Word Automation Reference suggests that this specifies that the query is executed every time the document is opened in Microsoft Word. But the OOXML specification suggests that this specifies that the query contains a reference to an external query file which contains the actual query. The default value is false.

      • getMailAsAttachment/setMailAsAttachment

        public boolean getMailAsAttachment() / public void setMailAsAttachment(boolean value)
        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. The default value is false.

      • getMailSubject/setMailSubject

        public java.lang.String getMailSubject() / public void setMailSubject(java.lang.String value)
        Specifies the text which shall appear in the subject line of the e-mails or faxes produced during mail merge. The default value is an empty string.

      • getMainDocumentType/setMainDocumentType

        public int getMainDocumentType() / public void setMainDocumentType(int value)
        Specifies the mail-merge main document type. The default value is MailMergeMainDocumentType.DEFAULT. The value of the property is MailMergeMainDocumentType integer constant.

        The main document is the document that contains information that is the same for each version of the merged document.

      • getOdso/setOdso

        public Odso getOdso() / public void setOdso(Odso value)
        Gets or sets the object that specifies the Office Data Source Object (ODSO) settings.

        This object is never null.

      • getQuery/setQuery

        public java.lang.String getQuery() / public void setQuery(java.lang.String value)
        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. The default value is an empty string.

      • getViewMergedData/setViewMergedData

        public boolean getViewMergedData() / public void setViewMergedData(boolean value)
        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). The default value is false.

    • Method Detail

      • clear

        public void 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.