Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 6796

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Service MailMerge</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="MailMerge-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#ServicesSummary" class="navisub">Services' Summary</a></td>
<td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td>
<td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td>
<td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td>
<td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td>
<td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">text</a> :: </p>
</td>
</tr>
<tr>
<td class="title">service MailMerge</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Gives access to mail merge functionality.

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 1.1.2</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Included Services - Summary</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a></td>
<td class="imsum_right"><p>allows to specify the data which the mail merge should be based on.

 (<a href="#DataAccessDescriptor">details</a>)</p>
</td>
</tr>
</table>
<a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Summary</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XJob.html">XJob</a></td>
<td class="imsum_right"><p>interface to execute the mail merge action.
 
 (<a href="#XJob">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td>
<td class="imsum_right"><p>interface to access the services properties.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XMailMergeBroadcaster.html">XMailMergeBroadcaster</a></td>
<td class="imsum_right"><p>interface to notify mail merge listeners.
 (<a href="#XMailMergeBroadcaster">details</a>)</p>
</td>
</tr>
</table>
<a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Properties' Summary</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#DataSourceName">DataSourceName</a></td>
<td class="imsum_right">contains the name of the data source that is to be used for merging. 

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#CommandType">CommandType</a></td>
<td class="imsum_right">determines the type of the database command as 
 described in ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/CommandType.html">CommandType</a>
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#Command">Command</a></td>
<td class="imsum_right">contains the database command.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSet.html">XResultSet</a><br>
<a href="#ResultSet">ResultSet</a></td>
<td class="imsum_right">provides access to a 
 ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSet.html">XResultSet</a> of 
 a ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/ResultSet.html">ResultSet</a> service.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XConnection.html">XConnection</a><br>
<a href="#ActiveConnection">ActiveConnection</a></td>
<td class="imsum_right">contains the connection to the database. 

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">sequence&lt; any &gt;<br>
<a href="#Selection">Selection</a></td>
<td class="imsum_right">contains a selection that refers to bookmarks of the ResultSet.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#EscapeProcessing">EscapeProcessing</a></td>
<td class="imsum_right">returns if escape processing is on or off.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#Filter">Filter</a></td>
<td class="imsum_right">contains a filter expression for an SQL statement.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#DocumentURL">DocumentURL</a></td>
<td class="imsum_right">contains the URL of a text document that is to be processed. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">[ readonly ] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a><br>
<a href="#Model">Model</a></td>
<td class="imsum_right">provides access to the model of the document to be processed.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#OutputType">OutputType</a></td>
<td class="imsum_right">determines the destination of the mail merge action. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#SinglePrintJobs">SinglePrintJobs</a></td>
<td class="imsum_right">determines whether single print jobs will be generated per output document.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#OutputURL">OutputURL</a></td>
<td class="imsum_right">contains the path where generated files are created. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#FileNameFromColumn">FileNameFromColumn</a></td>
<td class="imsum_right">determines whether file names of created files are generated using 
 the content of a database column.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#FileNamePrefix">FileNamePrefix</a></td>
<td class="imsum_right">contains the name of the column to generate the output file names. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#OutServerPassword">OutServerPassword</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Contains the password of the outgoing mail server. It is necessary to set this 
 if the password is not already stored in the configuration for security reasons.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#InServerPassword">InServerPassword</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Contains the password of the incoming mail server. It is necessary to set this 
 if the mail server configuration is set to 'SMTP after POP' authentication and 
 the password is not already stored in the configuration for security reasons.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#Subject">Subject</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the subject of the e-Mail message. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#AddressFromColumn">AddressFromColumn</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the name of the data base column that contains the e-Mail address 
 to the e-Mail to.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#SendAsHTML">SendAsHTML</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>determines that the created mail merge document is sent as body in HTML format. 
 This property is only valid if the propery "SendAsAttachment" is set to <b>false</b>.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#SendAsAttachment">SendAsAttachment</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>determines that the created mail merge document is sent as attachment. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#MailBody">MailBody</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the text of the mail body. 
 This property is only valid if the property "SendAsAttachment" is set to <b>true</b> 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#AttachmentName">AttachmentName</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the name of the attachment. 
 This property is only valid if "SendAsAttachment" is set to <b>true</b>.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#AttachmentFilter">AttachmentFilter</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the name of the document filter to save the attached mail merge document. 
 This property is only valid if "SendAsAttachment" is set to <b>true</b>.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">sequence&lt; string &gt;<br>
<a href="#CopiesTo">CopiesTo</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains a list of e-Mail addresses to 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">sequence&lt; string &gt;<br>
<a href="#BlindCopiesTo">BlindCopiesTo</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>&nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#SaveAsSingleFile">SaveAsSingleFile</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>determines that the output of the mail merge is save in one single file. 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#SaveFilter">SaveFilter</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the name of the document filter to save the output file(s).
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;<br>
<a href="#PrintOptions">PrintOptions</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the properties that are defined in <com::sun::star::view::PrintOptions>. 
 
 &nbsp;</td>
</tr>
</table>
<a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Included Services - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="DataAccessDescriptor" class="membertitle">::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>allows to specify the data which the mail merge should be based on.

 </dd>
<dd><p>This service describe the interaction between all data access related properties,
 namely <a href="MailMerge.html#DataSourceName">DataSourceName</a>, <a href="MailMerge.html#Command">Command</a>, <a href="MailMerge.html#CommandType">CommandType</a>,
 <a href="MailMerge.html#Connection">Connection</a>, <a href="MailMerge.html#Selection">Selection</a>, <a href="MailMerge.html#ResultSet">ResultSet</a>,
 <a href="MailMerge.html#Filter">Filter</a> and <a href="MailMerge.html#EscapeProcessing">EscapeProcessing</a>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XJob" class="membertitle">::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XJob.html">XJob</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>interface to execute the mail merge action.
 
 </dd>
<dd><p>The ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XJob.html">XJob</a>::<a href="../task/XJob.html#execute">execute</a>
 method of the interface accepts exactly the same properties
 as provided by this service in its argument sequence.</p>
 
 <p>The default values for the properties to be used in the method
 call are those given by this service. If a property is also listed 
 in the argument sequence that value will be used for the call.
 The value of the property in this service will remain unchanged 
 by that.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>interface to access the services properties.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XMailMergeBroadcaster" class="membertitle"><a href="XMailMergeBroadcaster.html">XMailMergeBroadcaster</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>interface to notify mail merge listeners.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Properties' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="DataSourceName" class="membertitle">DataSourceName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>DataSourceName</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains the name of the data source that is to be used for merging. 

 </dd>
<dd><p>For the interaction of this property with other data access relevant properties, see
 the ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a> service.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="CommandType" class="membertitle">CommandType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>CommandType</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines the type of the database command as 
 described in ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/CommandType.html">CommandType</a>
 
 </dd>
<dd><p>For the interaction of this property with other data access relevant properties, see
 the ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a> service.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Command" class="membertitle">Command</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>Command</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains the database command.
 
 </dd>
<dd><p>For the interaction of this property with other data access relevant properties, see
 the ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a> service.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ResultSet" class="membertitle">ResultSet</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSet.html">XResultSet</a> <b>ResultSet</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides access to a 
 ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSet.html">XResultSet</a> of 
 a ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/ResultSet.html">ResultSet</a> service.

 </dd>
<dd><p>Note that any superservices of ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/ResultSet.html">ResultSet</a>
 are also allowed. Especially, this member can denote an instance of the
 ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/RowSet.html">RowSet</a>, or an instance obtained
 by calling ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/XResultSetAccess.html">XResultSetAccess</a>::<a href="../sdb/XResultSetAccess.html#createResultSet">createResultSet</a>
 on such a ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/RowSet.html">RowSet</a>. This becomes important in
 conjunction with the <a href="#Selection">Selection</a> property.</p>

 <p>For the interaction of this property with other data access relevant properties, see
 the ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a> service.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ActiveConnection" class="membertitle">ActiveConnection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XConnection.html">XConnection</a> <b>ActiveConnection</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains the connection to the database. 

 </dd>
<dd><p>For the interaction of this property with other data access relevant properties, see
 the ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a> service.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Selection" class="membertitle">Selection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>sequence&lt; any &gt; <b>Selection</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains a selection that refers to bookmarks of the ResultSet.

 </dd>
<dd><p>This property is relevant in conjunction with the <a href="#ResultSet">ResultSet</a>
 only. A single element of this array describes a bookmark relative to the result set.<br/>
 Note that this implies that the <a href="#ResultSet">ResultSet</a> needs to support the
 ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/XRowLocate.html">XRowLocate</a> interface.</p>

 <p>If this array is empty, the whole result set, as described by <a href="#ResultSet">ResultSet</a>
 respectively the triple (<a href="#DataSourceName">DataSourceName</a>, <a href="#DataCommandType">DataCommandType</a>,
 <a href="#DataCommand">DataCommand</a>).</p>

 <p>For the interaction of this property with other data access relevant properties, see
 the ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a> service.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="EscapeProcessing" class="membertitle">EscapeProcessing</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>EscapeProcessing</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns if escape processing is on or off.
 
 </dd>
<dd><p>For the interaction of this property with other data access relevant properties, see
 the ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a> service.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Filter" class="membertitle">Filter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>Filter</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains a filter expression for an SQL statement.
 
 </dd>
<dd><p>For the interaction of this property with other data access relevant properties, see
 the ::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/DataAccessDescriptor.html">DataAccessDescriptor</a> service.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="DocumentURL" class="membertitle">DocumentURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>DocumentURL</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains the URL of a text document that is to be processed. 
 
 </dd>
<dd><p>If this property is not set an empty document is created.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Model" class="membertitle">Model</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>[ readonly ] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a> <b>Model</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides access to the model of the document to be processed.
 
 </dd>
<dd><p>This property will automatically be set to the documents model
 if a document URL was set.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="OutputType" class="membertitle">OutputType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>OutputType</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines the destination of the mail merge action. 
 
 </dd>
<dt><b>See also</b></dt>
<dd><a href="MailMergeType.html">MailMergeType</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SinglePrintJobs" class="membertitle">SinglePrintJobs</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>SinglePrintJobs</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines whether single print jobs will be generated per output document.
 
 </dd>
<dd><p>This property is only evaluated for printer output.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="OutputURL" class="membertitle">OutputURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>OutputURL</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains the path where generated files are created. 
 
 </dd>
<dd><p>If "OutputURL" or "FileNamePrefix" are empty the missing value is
 generated from the location or title of the source documents.</p>
 
 <p>This property is only evaluated for file output.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FileNameFromColumn" class="membertitle">FileNameFromColumn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>FileNameFromColumn</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines whether file names of created files are generated using 
 the content of a database column.
 
 </dd>
<dd><p>This property is only evaluated for file output.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FileNamePrefix" class="membertitle">FileNamePrefix</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>FileNamePrefix</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains the name of the column to generate the output file names. 
 
 </dd>
<dd><p>If FileNameFromColumn is true the content of the related column 
 is added to the OutputURL.</p>
 <p>If "OutputURL" or "FileNamePrefix" are empty the missing value is
 generated from the location or title of the source documents.</p>
 
 <p>This property is only evaluated for file output.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="OutServerPassword" class="membertitle">OutServerPassword</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>OutServerPassword</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Contains the password of the outgoing mail server. It is necessary to set this 
 if the password is not already stored in the configuration for security reasons.

 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="InServerPassword" class="membertitle">InServerPassword</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>InServerPassword</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Contains the password of the incoming mail server. It is necessary to set this 
 if the mail server configuration is set to 'SMTP after POP' authentication and 
 the password is not already stored in the configuration for security reasons.

 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Subject" class="membertitle">Subject</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>Subject</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the subject of the e-Mail message. 
 
 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>
 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AddressFromColumn" class="membertitle">AddressFromColumn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>AddressFromColumn</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the name of the data base column that contains the e-Mail address 
 to the e-Mail to.
 
 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SendAsHTML" class="membertitle">SendAsHTML</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>SendAsHTML</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>determines that the created mail merge document is sent as body in HTML format. 
 This property is only valid if the propery "SendAsAttachment" is set to <b>false</b>.
 
 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SendAsAttachment" class="membertitle">SendAsAttachment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>SendAsAttachment</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>determines that the created mail merge document is sent as attachment. 
 
 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="MailBody" class="membertitle">MailBody</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>MailBody</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the text of the mail body. 
 This property is only valid if the property "SendAsAttachment" is set to <b>true</b> 
 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AttachmentName" class="membertitle">AttachmentName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>AttachmentName</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the name of the attachment. 
 This property is only valid if "SendAsAttachment" is set to <b>true</b>.
 
 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AttachmentFilter" class="membertitle">AttachmentFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>AttachmentFilter</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the name of the document filter to save the attached mail merge document. 
 This property is only valid if "SendAsAttachment" is set to <b>true</b>.

 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="CopiesTo" class="membertitle">CopiesTo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>sequence&lt; string &gt; <b>CopiesTo</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains a list of e-Mail addresses to 
 </dd>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="BlindCopiesTo" class="membertitle">BlindCopiesTo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>sequence&lt; string &gt; <b>BlindCopiesTo</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd><p>This property is only evaluated for e-Mail output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SaveAsSingleFile" class="membertitle">SaveAsSingleFile</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>SaveAsSingleFile</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>determines that the output of the mail merge is save in one single file. 
 </dd>
<dd><p>This property is only evaluated for file output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SaveFilter" class="membertitle">SaveFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>SaveFilter</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the name of the document filter to save the output file(s).
 </dd>
<dd><p>This property is only evaluated for file output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="PrintOptions" class="membertitle">PrintOptions</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt; <b>PrintOptions</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the properties that are defined in <com::sun::star::view::PrintOptions>. 
 
 </dd>
<dd><p>This property is only evaluated for printer output.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>