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

NameTypeAccessDescription
columnDelimitercharRead/WriteSpecifies the character which shall be interpreted as the column delimiter used to separate columns within external data sources.
firstRowContainsColumnNamesbooleanRead/WriteSpecifies 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.
dataSourceStringRead/WriteSpecifies the location of the external data source to be connected to a document to perform the mail merge.
tableNameStringRead/WriteSpecifies the particular set of data that a source shall be connected to within an external data source.
dataSourceTypeintRead/WriteSpecifies the type of the external data source to be connected to as part of the ODSO connection information for this mail merge.
udlConnectStringStringRead/WriteSpecifies the Universal Data Link (UDL) connection string used to connect to an external data source.
fieldMapDatasOdsoFieldMapDataCollectionRead/WriteGets 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.
recipientDatasOdsoRecipientDataCollectionRead/WriteGets or sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge.

Methods

SignatureDescription
deepClone() → OdsoReturns a deep clone of this object.
getColumnDelimiter() → charSpecifies 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() → booleanSpecifies 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() → StringSpecifies 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() → StringSpecifies 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() → intSpecifies 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() → StringSpecifies 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() → OdsoFieldMapDataCollectionGets 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() → OdsoRecipientDataCollectionGets 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.

See Also