public class Odso
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 properies 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
You do not normally need to create objects of this class directly because ODSO settings
are always available via the
| Constructor Summary |
|---|
Odso()
|
| Property Getters/Setters Summary | ||
|---|---|---|
char | getColumnDelimiter() | |
void | setColumnDelimiter(charvalue) | |
| 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. | ||
java.lang.String | getDataSource() | |
void | setDataSource(java.lang.Stringvalue) | |
| 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. | ||
int | getDataSourceType() | |
void | setDataSourceType(intvalue) | |
|
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 |
||
OdsoFieldMapDataCollection | getFieldMapDatas() | |
void | ||
| Gets or 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. | ||
boolean | getFirstRowContainsColumnNames() | |
void | setFirstRowContainsColumnNames(booleanvalue) | |
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.
|
||
OdsoRecipientDataCollection | getRecipientDatas() | |
void | ||
| Gets or sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. This object is never null. | ||
java.lang.String | getTableName() | |
void | setTableName(java.lang.Stringvalue) | |
| 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. | ||
java.lang.String | getUdlConnectString() | |
void | setUdlConnectString(java.lang.Stringvalue) | |
| Specifies the Universal Data Link (UDL) connection string used to connect to an external data source. The default value is an empty string. | ||
| Method Summary | ||
|---|---|---|
Odso | deepClone() | |
Returns a deep clone of this object.
|
||
public char getColumnDelimiter() / public void setColumnDelimiter(char value)
RK I have never seen this in use.
public java.lang.String getDataSource() / public void setDataSource(java.lang.String value)
public int getDataSourceType() / public void setDataSourceType(int value)
This setting is purely a suggestion of the data source type that is being used for this mail merge.
public OdsoFieldMapDataCollection getFieldMapDatas() / public void setFieldMapDatas(OdsoFieldMapDataCollection value)
public boolean getFirstRowContainsColumnNames() / public void setFirstRowContainsColumnNames(boolean value)
false.
RK I have never seen this in use.
public OdsoRecipientDataCollection getRecipientDatas() / public void setRecipientDatas(OdsoRecipientDataCollection value)
public java.lang.String getTableName() / public void setTableName(java.lang.String value)
public java.lang.String getUdlConnectString() / public void setUdlConnectString(java.lang.String value)
public Odso deepClone()