CTMailMerge (docx4j-openxml-objects 8.3.4 API)

java.lang.Object
- org.docx4j.wml.CTMailMerge

All Implemented Interfaces:: Child

public class CTMailMerge
extends Object
implements Child

Java class for CT_MailMerge complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CT_MailMerge">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="mainDocumentType" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_MailMergeDocType"/>
         <element name="linkToQuery" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
         <element name="dataType" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_MailMergeDataType"/>
         <element name="connectString" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="query" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="dataSource" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_Rel" minOccurs="0"/>
         <element name="headerSource" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_Rel" minOccurs="0"/>
         <element name="doNotSuppressBlankLines" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
         <element name="destination" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_MailMergeDest" minOccurs="0"/>
         <element name="addressFieldName" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="mailSubject" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="mailAsAttachment" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
         <element name="viewMergedData" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
         <element name="activeRecord" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="val" use="required">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}integer">
                     </restriction>
                   </simpleType>
                 </attribute>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="checkErrors" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="val" use="required">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}integer">
                     </restriction>
                   </simpleType>
                 </attribute>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="odso" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_Odso" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CTMailMerge.ActiveRecord` Java class for anonymous complex type.
`static class`	`CTMailMerge.AddressFieldName` Java class for anonymous complex type.
`static class`	`CTMailMerge.CheckErrors` Java class for anonymous complex type.
`static class`	`CTMailMerge.ConnectString` Java class for anonymous complex type.
`static class`	`CTMailMerge.MailSubject` Java class for anonymous complex type.
`static class`	`CTMailMerge.Query` Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected CTMailMerge.ActiveRecord`	`activeRecord`
`protected CTMailMerge.AddressFieldName`	`addressFieldName`
`protected CTMailMerge.CheckErrors`	`checkErrors`
`protected CTMailMerge.ConnectString`	`connectString`
`protected CTRel`	`dataSource`
`protected CTMailMergeDataType`	`dataType`
`protected CTMailMergeDest`	`destination`
`protected BooleanDefaultTrue`	`doNotSuppressBlankLines`
`protected CTRel`	`headerSource`
`protected BooleanDefaultTrue`	`linkToQuery`
`protected BooleanDefaultTrue`	`mailAsAttachment`
`protected CTMailMerge.MailSubject`	`mailSubject`
`protected CTMailMergeDocType`	`mainDocumentType`
`protected CTOdso`	`odso`
`protected CTMailMerge.Query`	`query`
`protected BooleanDefaultTrue`	`viewMergedData`

Constructor Summary

Constructors
Constructor and Description

CTMailMerge()

Constructors
Constructor and Description
`CTMailMerge()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`CTMailMerge.ActiveRecord`	`getActiveRecord()` Gets the value of the activeRecord property.
`CTMailMerge.AddressFieldName`	`getAddressFieldName()` Gets the value of the addressFieldName property.
`CTMailMerge.CheckErrors`	`getCheckErrors()` Gets the value of the checkErrors property.
`CTMailMerge.ConnectString`	`getConnectString()` Gets the value of the connectString property.
`CTRel`	`getDataSource()` Gets the value of the dataSource property.
`CTMailMergeDataType`	`getDataType()` Gets the value of the dataType property.
`CTMailMergeDest`	`getDestination()` Gets the value of the destination property.
`BooleanDefaultTrue`	`getDoNotSuppressBlankLines()` Gets the value of the doNotSuppressBlankLines property.
`CTRel`	`getHeaderSource()` Gets the value of the headerSource property.
`BooleanDefaultTrue`	`getLinkToQuery()` Gets the value of the linkToQuery property.
`BooleanDefaultTrue`	`getMailAsAttachment()` Gets the value of the mailAsAttachment property.
`CTMailMerge.MailSubject`	`getMailSubject()` Gets the value of the mailSubject property.
`CTMailMergeDocType`	`getMainDocumentType()` Gets the value of the mainDocumentType property.
`CTOdso`	`getOdso()` Gets the value of the odso property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`CTMailMerge.Query`	`getQuery()` Gets the value of the query property.
`BooleanDefaultTrue`	`getViewMergedData()` Gets the value of the viewMergedData property.
`void`	`setActiveRecord(CTMailMerge.ActiveRecord value)` Sets the value of the activeRecord property.
`void`	`setAddressFieldName(CTMailMerge.AddressFieldName value)` Sets the value of the addressFieldName property.
`void`	`setCheckErrors(CTMailMerge.CheckErrors value)` Sets the value of the checkErrors property.
`void`	`setConnectString(CTMailMerge.ConnectString value)` Sets the value of the connectString property.
`void`	`setDataSource(CTRel value)` Sets the value of the dataSource property.
`void`	`setDataType(CTMailMergeDataType value)` Sets the value of the dataType property.
`void`	`setDestination(CTMailMergeDest value)` Sets the value of the destination property.
`void`	`setDoNotSuppressBlankLines(BooleanDefaultTrue value)` Sets the value of the doNotSuppressBlankLines property.
`void`	`setHeaderSource(CTRel value)` Sets the value of the headerSource property.
`void`	`setLinkToQuery(BooleanDefaultTrue value)` Sets the value of the linkToQuery property.
`void`	`setMailAsAttachment(BooleanDefaultTrue value)` Sets the value of the mailAsAttachment property.
`void`	`setMailSubject(CTMailMerge.MailSubject value)` Sets the value of the mailSubject property.
`void`	`setMainDocumentType(CTMailMergeDocType value)` Sets the value of the mainDocumentType property.
`void`	`setOdso(CTOdso value)` Sets the value of the odso property.
`void`	`setParent(Object parent)`
`void`	`setQuery(CTMailMerge.Query value)` Sets the value of the query property.
`void`	`setViewMergedData(BooleanDefaultTrue value)` Sets the value of the viewMergedData property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mainDocumentType
```
protected CTMailMergeDocType mainDocumentType
```
  - linkToQuery
```
protected BooleanDefaultTrue linkToQuery
```
  - dataType
```
protected CTMailMergeDataType dataType
```
  - connectString
```
protected CTMailMerge.ConnectString connectString
```
  - query
```
protected CTMailMerge.Query query
```
  - dataSource
```
protected CTRel dataSource
```
  - headerSource
```
protected CTRel headerSource
```
  - doNotSuppressBlankLines
```
protected BooleanDefaultTrue doNotSuppressBlankLines
```
  - destination
```
protected CTMailMergeDest destination
```
  - addressFieldName
```
protected CTMailMerge.AddressFieldName addressFieldName
```
  - mailSubject
```
protected CTMailMerge.MailSubject mailSubject
```
  - mailAsAttachment
```
protected BooleanDefaultTrue mailAsAttachment
```
  - viewMergedData
```
protected BooleanDefaultTrue viewMergedData
```
  - activeRecord
```
protected CTMailMerge.ActiveRecord activeRecord
```
  - checkErrors
```
protected CTMailMerge.CheckErrors checkErrors
```
  - odso
```
protected CTOdso odso
```
- Constructor Detail
  - CTMailMerge
```
public CTMailMerge()
```
- Method Detail
  - getMainDocumentType
```
public CTMailMergeDocType getMainDocumentType()
```
    Gets the value of the mainDocumentType property.
    
    Returns:
    
    possible object is CTMailMergeDocType
  - setMainDocumentType
```
public void setMainDocumentType(CTMailMergeDocType value)
```
    Sets the value of the mainDocumentType property.
    
    Parameters:
    
    value - allowed object is CTMailMergeDocType
  - getLinkToQuery
```
public BooleanDefaultTrue getLinkToQuery()
```
    Gets the value of the linkToQuery property.
    
    Returns:
    
    possible object is BooleanDefaultTrue
  - setLinkToQuery
```
public void setLinkToQuery(BooleanDefaultTrue value)
```
    Sets the value of the linkToQuery property.
    
    Parameters:
    
    value - allowed object is BooleanDefaultTrue
  - getDataType
```
public CTMailMergeDataType getDataType()
```
    Gets the value of the dataType property.
    
    Returns:
    
    possible object is CTMailMergeDataType
  - setDataType
```
public void setDataType(CTMailMergeDataType value)
```
    Sets the value of the dataType property.
    
    Parameters:
    
    value - allowed object is CTMailMergeDataType
  - getConnectString
```
public CTMailMerge.ConnectString getConnectString()
```
    Gets the value of the connectString property.
    
    Returns:
    
    possible object is CTMailMerge.ConnectString
  - setConnectString
```
public void setConnectString(CTMailMerge.ConnectString value)
```
    Sets the value of the connectString property.
    
    Parameters:
    
    value - allowed object is CTMailMerge.ConnectString
  - getQuery
```
public CTMailMerge.Query getQuery()
```
    Gets the value of the query property.
    
    Returns:
    
    possible object is CTMailMerge.Query
  - setQuery
```
public void setQuery(CTMailMerge.Query value)
```
    Sets the value of the query property.
    
    Parameters:
    
    value - allowed object is CTMailMerge.Query
  - getDataSource
```
public CTRel getDataSource()
```
    Gets the value of the dataSource property.
    
    Returns:
    
    possible object is CTRel
  - setDataSource
```
public void setDataSource(CTRel value)
```
    Sets the value of the dataSource property.
    
    Parameters:
    
    value - allowed object is CTRel
  - getHeaderSource
```
public CTRel getHeaderSource()
```
    Gets the value of the headerSource property.
    
    Returns:
    
    possible object is CTRel
  - setHeaderSource
```
public void setHeaderSource(CTRel value)
```
    Sets the value of the headerSource property.
    
    Parameters:
    
    value - allowed object is CTRel
  - getDoNotSuppressBlankLines
```
public BooleanDefaultTrue getDoNotSuppressBlankLines()
```
    Gets the value of the doNotSuppressBlankLines property.
    
    Returns:
    
    possible object is BooleanDefaultTrue
  - setDoNotSuppressBlankLines
```
public void setDoNotSuppressBlankLines(BooleanDefaultTrue value)
```
    Sets the value of the doNotSuppressBlankLines property.
    
    Parameters:
    
    value - allowed object is BooleanDefaultTrue
  - getDestination
```
public CTMailMergeDest getDestination()
```
    Gets the value of the destination property.
    
    Returns:
    
    possible object is CTMailMergeDest
  - setDestination
```
public void setDestination(CTMailMergeDest value)
```
    Sets the value of the destination property.
    
    Parameters:
    
    value - allowed object is CTMailMergeDest
  - getAddressFieldName
```
public CTMailMerge.AddressFieldName getAddressFieldName()
```
    Gets the value of the addressFieldName property.
    
    Returns:
    
    possible object is CTMailMerge.AddressFieldName
  - setAddressFieldName
```
public void setAddressFieldName(CTMailMerge.AddressFieldName value)
```
    Sets the value of the addressFieldName property.
    
    Parameters:
    
    value - allowed object is CTMailMerge.AddressFieldName
  - getMailSubject
```
public CTMailMerge.MailSubject getMailSubject()
```
    Gets the value of the mailSubject property.
    
    Returns:
    
    possible object is CTMailMerge.MailSubject
  - setMailSubject
```
public void setMailSubject(CTMailMerge.MailSubject value)
```
    Sets the value of the mailSubject property.
    
    Parameters:
    
    value - allowed object is CTMailMerge.MailSubject
  - getMailAsAttachment
```
public BooleanDefaultTrue getMailAsAttachment()
```
    Gets the value of the mailAsAttachment property.
    
    Returns:
    
    possible object is BooleanDefaultTrue
  - setMailAsAttachment
```
public void setMailAsAttachment(BooleanDefaultTrue value)
```
    Sets the value of the mailAsAttachment property.
    
    Parameters:
    
    value - allowed object is BooleanDefaultTrue
  - getViewMergedData
```
public BooleanDefaultTrue getViewMergedData()
```
    Gets the value of the viewMergedData property.
    
    Returns:
    
    possible object is BooleanDefaultTrue
  - setViewMergedData
```
public void setViewMergedData(BooleanDefaultTrue value)
```
    Sets the value of the viewMergedData property.
    
    Parameters:
    
    value - allowed object is BooleanDefaultTrue
  - getActiveRecord
```
public CTMailMerge.ActiveRecord getActiveRecord()
```
    Gets the value of the activeRecord property.
    
    Returns:
    
    possible object is CTMailMerge.ActiveRecord
  - setActiveRecord
```
public void setActiveRecord(CTMailMerge.ActiveRecord value)
```
    Sets the value of the activeRecord property.
    
    Parameters:
    
    value - allowed object is CTMailMerge.ActiveRecord
  - getCheckErrors
```
public CTMailMerge.CheckErrors getCheckErrors()
```
    Gets the value of the checkErrors property.
    
    Returns:
    
    possible object is CTMailMerge.CheckErrors
  - setCheckErrors
```
public void setCheckErrors(CTMailMerge.CheckErrors value)
```
    Sets the value of the checkErrors property.
    
    Parameters:
    
    value - allowed object is CTMailMerge.CheckErrors
  - getOdso
```
public CTOdso getOdso()
```
    Gets the value of the odso property.
    
    Returns:
    
    possible object is CTOdso
  - setOdso
```
public void setOdso(CTOdso value)
```
    Sets the value of the odso property.
    
    Parameters:
    
    value - allowed object is CTOdso
  - getParent
```
public Object getParent()
```
    Gets the parent object in the object tree representing the unmarshalled xml document.
    
    Specified by:
    
    getParent in interface Child
    
    Returns:
    
    The parent object.
  - setParent
```
public void setParent(Object parent)
```
    Specified by:
    
    setParent in interface Child
  - afterUnmarshal
```
public void afterUnmarshal(Unmarshaller unmarshaller,
                           Object parent)
```
    This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
    
    Parameters:
    
    parent - The parent object in the object tree.
    
    unmarshaller - The unmarshaller that generated the instance.

Class CTMailMerge

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mainDocumentType

linkToQuery

dataType

connectString

query

dataSource

headerSource

doNotSuppressBlankLines

destination

addressFieldName

mailSubject

mailAsAttachment

viewMergedData

activeRecord

checkErrors

odso

Constructor Detail

CTMailMerge

Method Detail

getMainDocumentType

setMainDocumentType

getLinkToQuery

setLinkToQuery

getDataType

setDataType

getConnectString

setConnectString

getQuery

setQuery

getDataSource

setDataSource

getHeaderSource

setHeaderSource

getDoNotSuppressBlankLines

setDoNotSuppressBlankLines

getDestination

setDestination

getAddressFieldName

setAddressFieldName

getMailSubject

setMailSubject

getMailAsAttachment

setMailAsAttachment

getViewMergedData

setViewMergedData

getActiveRecord

setActiveRecord

getCheckErrors

setCheckErrors

getOdso

setOdso

getParent

setParent

afterUnmarshal