com.aspose.words

  • java.lang.Object
    • com.aspose.words.Odso
  • All Implemented Interfaces:
    java.lang.Cloneable
    public class Odso 
    extends java.lang.Object

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

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.MailMergeSettings and MailMergeSettings.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.Odso property.

See Also:
MailMergeSettings.Odso

Constructor Summary
Odso()
 
Property Getters/Setters Summary
chargetColumnDelimiter()
void
           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.StringgetDataSource()
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.
intgetDataSourceType()
void
           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. The value of the property is OdsoDataSourceType integer constant.
OdsoFieldMapDataCollectiongetFieldMapDatas()
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.
booleangetFirstRowContainsColumnNames()
void
           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.
OdsoRecipientDataCollectiongetRecipientDatas()
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.StringgetTableName()
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.StringgetUdlConnectString()
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
OdsodeepClone()
Returns a deep clone of this object.
 

    • Constructor Detail

      • Odso

        public Odso()
    • Property Getters/Setters Detail

      • getColumnDelimiter/setColumnDelimiter

        public char getColumnDelimiter() / 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.

        RK I have never seen this in use.

      • getDataSource/setDataSource

        public java.lang.String getDataSource() / 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.
      • getDataSourceType/setDataSourceType

        public int getDataSourceType() / 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. The value of the property is OdsoDataSourceType integer constant.

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

      • getFieldMapDatas/setFieldMapDatas

        public OdsoFieldMapDataCollection getFieldMapDatas() / public void setFieldMapDatas(OdsoFieldMapDataCollection value)
        
        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.
      • getFirstRowContainsColumnNames/setFirstRowContainsColumnNames

        public boolean getFirstRowContainsColumnNames() / 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.

        RK I have never seen this in use.

      • getRecipientDatas/setRecipientDatas

        public OdsoRecipientDataCollection getRecipientDatas() / public void setRecipientDatas(OdsoRecipientDataCollection value)
        
        Gets or sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. This object is never null.
      • getTableName/setTableName

        public java.lang.String getTableName() / 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.
      • getUdlConnectString/setUdlConnectString

        public java.lang.String getUdlConnectString() / 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.
    • Method Detail

      • deepClone

        public Odso deepClone()
        Returns a deep clone of this object.