Odso
Overview
Odso is a class in Aspose.Words FOSS for Java.
Inherits from: Cloneable.
Specifies the Office Data Source Object (ODSO) settings for a mail merge data source.
Edition status of its 25 listed members (a property and its accessor methods are listed separately, overloads once): 25 not yet exercised by a verified example.
This class declares 17 methods for Odso objects in Java programs.
Available methods include: deepClone, getColumnDelimiter, getDataSource, getDataSourceType, getFieldMapDatas, getFirstRowContainsColumnNames, getRecipientDatas, getTableName, getUdlConnectString, setColumnDelimiter, setDataSource, setDataSourceType, and 5 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: columnDelimiter, dataSource, dataSourceType, fieldMapDatas, firstRowContainsColumnNames, recipientDatas, and 2 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
columnDelimiter | char | Read/Write | Specifies the character which shall be interpreted as the column delimiter used to separate columns within external data sources. |
firstRowContainsColumnNames | boolean | Read/Write | 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. |
dataSource | String | Read/Write | Specifies the location of the external data source to be connected to a document to perform the mail merge. |
tableName | String | Read/Write | Specifies the particular set of data that a source shall be connected to within an external data source. |
dataSourceType | int | Read/Write | Specifies the type of the external data source to be connected to as part of the ODSO connection information for this mail merge. |
udlConnectString | String | Read/Write | Specifies the Universal Data Link (UDL) connection string used to connect to an external data source. |
fieldMapDatas | OdsoFieldMapDataCollection | Read/Write | 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. |
recipientDatas | OdsoRecipientDataCollection | Read/Write | Gets or sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. |
Methods
| Signature | Description |
|---|---|
deepClone() → Odso | Returns a deep clone of this object. |
getColumnDelimiter() → char | Specifies the character which shall be interpreted as the column delimiter used to separate columns within external data sources. |
setColumnDelimiter(value: char) | Sets the column delimiter value. |
getFirstRowContainsColumnNames() → boolean | 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. |
setFirstRowContainsColumnNames(value: boolean) | Sets the first row contains column names value. |
getDataSource() → String | Specifies the location of the external data source to be connected to a document to perform the mail merge. |
setDataSource(value: String) | Sets the data source value. |
getTableName() → String | Specifies the particular set of data that a source shall be connected to within an external data source. |
setTableName(value: String) | Sets the table name value. |
getDataSourceType() → int | Specifies the type of the external data source to be connected to as part of the ODSO connection information for this mail merge. |
setDataSourceType(value: int) | Sets the data source type value. |
getUdlConnectString() → String | Specifies the Universal Data Link (UDL) connection string used to connect to an external data source. |
setUdlConnectString(value: String) | Sets the udl connect string value. |
getFieldMapDatas() → OdsoFieldMapDataCollection | 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. |
setFieldMapDatas(value: OdsoFieldMapDataCollection) | Sets the field map datas value. |
getRecipientDatas() → OdsoRecipientDataCollection | Gets or sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. |
setRecipientDatas(value: OdsoRecipientDataCollection) | Sets the recipient datas value. |