Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: text ::
service MailMerge
Description Gives access to mail merge functionality. Since version OpenOffice.org 1.1.1

Included Services
::com::sun::star::sdb::DataAccessDescriptor | Description allows to specify the data which the mail merge should be based on. This service describe the interaction between all data access related properties, namely DataSourceName , Command , CommandType , Connection , Selection , ResultSet , Filter and EscapeProcessing

Exported Interfaces
::com::sun::star::task::XJob | Description interface to execute the mail merge action. The ::com::sun::star::task::XJob::execute method of the interface accepts exactly the same properties as provided by this service in its argument sequence. 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.
::com::sun::star::beans::XPropertySet | Description interface to access the services properties.
XMailMergeBroadcaster | [ OPTIONAL ] Description interface to notify mail merge listeners.

Properties' Summary
DataSourceName | contains the name of the data source that is to be used for merging.
CommandType | determines the type of the database command as described in ::com::sun::star::sdb::CommandType
Command | contains the database command.
ResultSet | provides access to a ::com::sun::star::sdbc::XResultSet of a ::com::sun::star::sdbc::ResultSet service.
ActiveConnection | contains the connection to the database.
Selection | contains a selection that refers to bookmarks of the ResultSet.
EscapeProcessing | returns if escape processing is on or off.
Filter | contains a filter expression for an SQL statement.
DocumentURL | contains the URL of a text document that is to be processed.
Model | provides access to the model of the document to be processed.
OutputType | determines the destination of the mail merge action.
SinglePrintJobs | determines whether single print jobs will be generated per output document.
OutputURL | contains the path where generated files are created.
FileNameFromColumn | determines whether file names of created files are generated using the content of a database column.
FileNamePrefix | contains the name of the column to generate the output file names.

Properties' Details
DataSourceName
string DataSourceName; Description contains the name of the data source that is to be used for merging. For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.
CommandType
long CommandType; Description determines the type of the database command as described in ::com::sun::star::sdb::CommandType For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.
Command
string Command; Description contains the database command. For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.
ResultSet
::com::sun::star::sdbc::XResultSet ResultSet; Description provides access to a ::com::sun::star::sdbc::XResultSet of a ::com::sun::star::sdbc::ResultSet service. Note that any superservices of ::com::sun::star::sdbc::ResultSet are also allowed. Especially, this member can denote an instance of the ::com::sun::star::sdb::RowSet , or an instance obtained by calling ::com::sun::star::sdb::XResultSetAccess::createResultSet on such a ::com::sun::star::sdb::RowSet . This becomes important in conjunction with the Selection property. For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.
ActiveConnection
::com::sun::star::sdbc::XConnection ActiveConnection; Description contains the connection to the database. For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.
Selection
sequence< any > Selection; Description contains a selection that refers to bookmarks of the ResultSet. This property is relevant in conjunction with the ResultSet only. A single element of this array describes a bookmark relative to the result set. Note that this implies that the ResultSet needs to support the ::com::sun::star::sdbcx::XRowLocate interface. If this array is empty, the whole result set, as described by ResultSet respectively the triple ( DataSourceName , DataCommandType , DataCommand ). For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.
EscapeProcessing
boolean EscapeProcessing; Description returns if escape processing is on or off. For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.
Filter
string Filter; Description contains a filter expression for an SQL statement. For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.
DocumentURL
string DocumentURL; Description contains the URL of a text document that is to be processed. If this property is not set an empty document is created.
Model
[ readonly ] ::com::sun::star::frame::XModel Model; Description provides access to the model of the document to be processed. This property will automatically be set to the documents model if a document URL was set.
OutputType
short OutputType; Description determines the destination of the mail merge action. See also MailMergeType
SinglePrintJobs
boolean SinglePrintJobs; Description determines whether single print jobs will be generated per output document. This property is only evaluated for printer output.
OutputURL
string OutputURL; Description contains the path where generated files are created. If "OutputURL" or "FileNamePrefix" are empty the missing value is generated from the location or title of the source documents. This property is only evaluated for file output.
FileNameFromColumn
boolean FileNameFromColumn; Description determines whether file names of created files are generated using the content of a database column. This property is only evaluated for file output.
FileNamePrefix
string FileNamePrefix; Description contains the name of the column to generate the output file names. If FileNameFromColumn is true the content of the related column is added to the OutputURL. If "OutputURL" or "FileNamePrefix" are empty the missing value is generated from the location or title of the source documents. This property is only evaluated for file output.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.