com.aspose.words

Class Odso

java.lang.Object

com.aspose.words.Odso

All Implemented Interfaces:

java.lang.Cloneable

public class Odso
extends java.lang.Object
implements java.lang.Cloneable

Specifies the Office Data Source Object (ODSO) settings for a mail merge data source.

To learn more, visit the Mail Merge and Reporting documentation article.

Remarks:

ODSO seems to be the "new" way the newer Microsoft Word versions prefer to use when specifying certain types of data sources for a mail merge document. ODSO probably first appeared in Microsoft Word 2000.

The use of ODSO is poorly documented and 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.getMailMergeSettings() / Document.setMailMergeSettings(com.aspose.words.MailMergeSettings) and MailMergeSettings.getOdso() / MailMergeSettings.setOdso(com.aspose.words.Odso) objects. This is a good approach to take if you want to learn how to programmatically configure a data source, for example.

You do not normally need to create objects of this class directly because ODSO settings are always available via the MailMergeSettings.getOdso() / MailMergeSettings.setOdso(com.aspose.words.Odso) property.

See Also:

MailMergeSettings.getOdso(), MailMergeSettings.setOdso(com.aspose.words.Odso)

Method Summary

Modifier and Type	Method and Description
Odso	deepClone() Returns a deep clone of this object.
char	getColumnDelimiter() Specifies the character which shall be interpreted as the column delimiter used to separate columns within external data sources.
java.lang.String	getDataSource() Specifies the location of the external data source to be connected to a document to perform the mail merge.
int	getDataSourceType() Specifies the type of the external data source to be connected to as part of the ODSO connection information for this mail merge.
OdsoFieldMapDataCollection	getFieldMapDatas() Gets a collection of objects that specify how columns from the external data source are mapped to the predefined merge field names in the document.
boolean	getFirstRowContainsColumnNames() Specifies that a hosting application shall treat the first row of data in the specified external data source as a header row containing the names of each column in the data source.
OdsoRecipientDataCollection	getRecipientDatas() Gets a collection of objects that specify inclusion/exclusion of individual records in the mail merge.
java.lang.String	getTableName() Specifies the particular set of data that a source shall be connected to within an external data source.
java.lang.String	getUdlConnectString() Specifies the Universal Data Link (UDL) connection string used to connect to an external data source.
protected java.lang.Object	memberwiseClone()
void	setColumnDelimiter(char value) Specifies the character which shall be interpreted as the column delimiter used to separate columns within external data sources.
void	setDataSource(java.lang.String value) Specifies the location of the external data source to be connected to a document to perform the mail merge.
void	setDataSourceType(int value) Specifies the type of the external data source to be connected to as part of the ODSO connection information for this mail merge.
void	setFieldMapDatas(OdsoFieldMapDataCollection value) Sets a collection of objects that specify how columns from the external data source are mapped to the predefined merge field names in the document.
void	setFirstRowContainsColumnNames(boolean value) Specifies that a hosting application shall treat the first row of data in the specified external data source as a header row containing the names of each column in the data source.
void	setRecipientDatas(OdsoRecipientDataCollection value) Sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge.
void	setTableName(java.lang.String value) Specifies the particular set of data that a source shall be connected to within an external data source.
void	setUdlConnectString(java.lang.String value) Specifies the Universal Data Link (UDL) connection string used to connect to an external data source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

deepClone

public Odso deepClone()

Returns a deep clone of this object.

getColumnDelimiter

public char getColumnDelimiter()

Specifies the character which shall be interpreted as the column delimiter used to separate columns within external data sources. The default value is 0 which means there is no column delimiter defined.

Remarks:

RK I have never seen this in use.

Returns:

The corresponding char value.

setColumnDelimiter

public void setColumnDelimiter(char value)

Specifies the character which shall be interpreted as the column delimiter used to separate columns within external data sources. The default value is 0 which means there is no column delimiter defined.

Remarks:

RK I have never seen this in use.

Parameters:

value - The corresponding char value.

getFirstRowContainsColumnNames

public boolean getFirstRowContainsColumnNames()

Specifies that a hosting application shall treat the first row of data in the specified external data source as a header row containing the names of each column in the data source. The default value is false.

Remarks:

RK I have never seen this in use.

Returns:

The corresponding boolean value.

setFirstRowContainsColumnNames

public void setFirstRowContainsColumnNames(boolean value)

Specifies that a hosting application shall treat the first row of data in the specified external data source as a header row containing the names of each column in the data source. The default value is false.

Remarks:

RK I have never seen this in use.

Parameters:

value - The corresponding boolean value.

getDataSource

public java.lang.String getDataSource()

Specifies the location of the external data source to be connected to a document to perform the mail merge. The default value is an empty string.

Returns:

The corresponding String value.

setDataSource

public void setDataSource(java.lang.String value)

Specifies the location of the external data source to be connected to a document to perform the mail merge. The default value is an empty string.

Parameters:

value - The corresponding String value.

getTableName

public java.lang.String getTableName()

Specifies the particular set of data that a source shall be connected to within an external data source. The default value is an empty string.

Returns:

The corresponding String value.

setTableName

public void setTableName(java.lang.String value)

Specifies the particular set of data that a source shall be connected to within an external data source. The default value is an empty string.

Parameters:

value - The corresponding String value.

getDataSourceType

public int getDataSourceType()

Specifies the type of the external data source to be connected to as part of the ODSO connection information for this mail merge. The default value is OdsoDataSourceType.DEFAULT.

Remarks:

This setting is purely a suggestion of the data source type that is being used for this mail merge.

Returns:

The corresponding int value. The returned value is one of OdsoDataSourceType constants.

setDataSourceType

public void setDataSourceType(int value)

Specifies the type of the external data source to be connected to as part of the ODSO connection information for this mail merge. The default value is OdsoDataSourceType.DEFAULT.

Remarks:

This setting is purely a suggestion of the data source type that is being used for this mail merge.

Parameters:

value - The corresponding int value. The value must be one of OdsoDataSourceType constants.

getUdlConnectString

public java.lang.String getUdlConnectString()

Specifies the Universal Data Link (UDL) connection string used to connect to an external data source. The default value is an empty string.

Returns:

The corresponding String value.

setUdlConnectString

public void setUdlConnectString(java.lang.String value)

Specifies the Universal Data Link (UDL) connection string used to connect to an external data source. The default value is an empty string.

Parameters:

value - The corresponding String value.

getFieldMapDatas

public OdsoFieldMapDataCollection getFieldMapDatas()

Gets a collection of objects that specify how columns from the external data source are mapped to the predefined merge field names in the document. This object is never null.

Returns:

A collection of objects that specify how columns from the external data source are mapped to the predefined merge field names in the document.

setFieldMapDatas

public void setFieldMapDatas(OdsoFieldMapDataCollection value)

Sets a collection of objects that specify how columns from the external data source are mapped to the predefined merge field names in the document. This object is never null.

Parameters:

value - A collection of objects that specify how columns from the external data source are mapped to the predefined merge field names in the document.

getRecipientDatas

public OdsoRecipientDataCollection getRecipientDatas()

Gets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. This object is never null.

Returns:

A collection of objects that specify inclusion/exclusion of individual records in the mail merge.

setRecipientDatas

public void setRecipientDatas(OdsoRecipientDataCollection value)

Sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. This object is never null.

Parameters:

value - A collection of objects that specify inclusion/exclusion of individual records in the mail merge.

memberwiseClone

protected java.lang.Object memberwiseClone()