public class Odso
extends java.lang.Object
implements java.lang.Cloneable
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.
| 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.
|
public Odso deepClone()
public char getColumnDelimiter()
Remarks:
RK I have never seen this in use.
char value.public void setColumnDelimiter(char value)
Remarks:
RK I have never seen this in use.
value - The corresponding char value.public boolean getFirstRowContainsColumnNames()
false.
Remarks:
RK I have never seen this in use.
boolean value.public void setFirstRowContainsColumnNames(boolean value)
false.
Remarks:
RK I have never seen this in use.
value - The corresponding boolean value.public java.lang.String getDataSource()
String value.public void setDataSource(java.lang.String value)
value - The corresponding String value.public java.lang.String getTableName()
String value.public void setTableName(java.lang.String value)
value - The corresponding String value.public int getDataSourceType()
OdsoDataSourceType.DEFAULT.
Remarks:
This setting is purely a suggestion of the data source type that is being used for this mail merge.
int value. The returned value is one of OdsoDataSourceType constants.public void setDataSourceType(int value)
OdsoDataSourceType.DEFAULT.
Remarks:
This setting is purely a suggestion of the data source type that is being used for this mail merge.
value - The corresponding int value. The value must be one of OdsoDataSourceType constants.public java.lang.String getUdlConnectString()
String value.public void setUdlConnectString(java.lang.String value)
value - The corresponding String value.public OdsoFieldMapDataCollection getFieldMapDatas()
null.public void setFieldMapDatas(OdsoFieldMapDataCollection value)
null.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.public OdsoRecipientDataCollection getRecipientDatas()
null.public void setRecipientDatas(OdsoRecipientDataCollection value)
null.value - A collection of objects that specify inclusion/exclusion of individual records in the mail merge.protected java.lang.Object memberwiseClone()