Aspose::Words::Settings::Odso Class Reference

Detailed Description

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

See also
Aspose::Words::Settings::MailMergeSettings::get_Odso

#include <Aspose.Words.Cpp/Settings/Odso.h>

+ Inheritance diagram for Aspose::Words::Settings::Odso:

Public Member Functions

 Odso ()
 
SharedPtr< OdsoClone ()
 Returns a deep clone of this object. More...
 
char16_t get_ColumnDelimiter () const
 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. More...
 
String get_DataSource () const
 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. More...
 
OdsoDataSourceType get_DataSourceType () const
 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 Default. More...
 
SharedPtr< OdsoFieldMapDataCollectionget_FieldMapDatas () const
 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. This object is never null. More...
 
bool get_FirstRowContainsColumnNames () const
 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. More...
 
SharedPtr< OdsoRecipientDataCollectionget_RecipientDatas () const
 Gets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. This object is never null. More...
 
String get_TableName () const
 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. More...
 
String get_UdlConnectString () const
 Specifies the Universal Data Link (UDL) connection string used to connect to an external data source. The default value is an empty string. More...
 
virtual const TypeInfoGetType () const override
 
virtual bool Is (const TypeInfo &target) const override
 
void set_ColumnDelimiter (char16_t value)
 Setter for get_ColumnDelimiter. More...
 
void set_DataSource (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. More...
 
void set_DataSourceType (OdsoDataSourceType value)
 Setter for get_DataSourceType. More...
 
void set_FieldMapDatas (SharedPtr< 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. This object is never null. More...
 
void set_FirstRowContainsColumnNames (bool value)
 Setter for get_FirstRowContainsColumnNames. More...
 
void set_RecipientDatas (SharedPtr< OdsoRecipientDataCollection > value)
 Sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. This object is never null. More...
 
void set_TableName (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. More...
 
void set_UdlConnectString (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. More...
 

Static Public Member Functions

static const TypeInfoType ()
 

Constructor & Destructor Documentation

◆ Odso()

Aspose::Words::Settings::Odso::Odso ( )

Member Function Documentation

◆ Clone()

System::SharedPtr<Aspose::Words::Settings::Odso> Aspose::Words::Settings::Odso::Clone ( )

Returns a deep clone of this object.

◆ get_ColumnDelimiter()

char16_t Aspose::Words::Settings::Odso::get_ColumnDelimiter ( ) const

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.

◆ get_DataSource()

System::String Aspose::Words::Settings::Odso::get_DataSource ( ) const

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.

◆ get_DataSourceType()

Aspose::Words::Settings::OdsoDataSourceType Aspose::Words::Settings::Odso::get_DataSourceType ( ) const

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 Default.

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

◆ get_FieldMapDatas()

System::SharedPtr<Aspose::Words::Settings::OdsoFieldMapDataCollection> Aspose::Words::Settings::Odso::get_FieldMapDatas ( ) const

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. This object is never null.

◆ get_FirstRowContainsColumnNames()

bool Aspose::Words::Settings::Odso::get_FirstRowContainsColumnNames ( ) const

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.

◆ get_RecipientDatas()

System::SharedPtr<Aspose::Words::Settings::OdsoRecipientDataCollection> Aspose::Words::Settings::Odso::get_RecipientDatas ( ) const

Gets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. This object is never null.

◆ get_TableName()

System::String Aspose::Words::Settings::Odso::get_TableName ( ) const

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.

◆ get_UdlConnectString()

System::String Aspose::Words::Settings::Odso::get_UdlConnectString ( ) const

Specifies the Universal Data Link (UDL) connection string used to connect to an external data source. The default value is an empty string.

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Settings::Odso::GetType ( ) const
overridevirtual

Reimplemented from System::Object.

◆ Is()

virtual bool Aspose::Words::Settings::Odso::Is ( const System::TypeInfo target) const
overridevirtual

Reimplemented from System::Object.

◆ set_ColumnDelimiter()

void Aspose::Words::Settings::Odso::set_ColumnDelimiter ( char16_t  value)

◆ set_DataSource()

void Aspose::Words::Settings::Odso::set_DataSource ( System::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.

◆ set_DataSourceType()

void Aspose::Words::Settings::Odso::set_DataSourceType ( Aspose::Words::Settings::OdsoDataSourceType  value)

◆ set_FieldMapDatas()

void Aspose::Words::Settings::Odso::set_FieldMapDatas ( System::SharedPtr< Aspose::Words::Settings::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. This object is never null.

◆ set_FirstRowContainsColumnNames()

void Aspose::Words::Settings::Odso::set_FirstRowContainsColumnNames ( bool  value)

◆ set_RecipientDatas()

void Aspose::Words::Settings::Odso::set_RecipientDatas ( System::SharedPtr< Aspose::Words::Settings::OdsoRecipientDataCollection value)

Sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge. This object is never null.

◆ set_TableName()

void Aspose::Words::Settings::Odso::set_TableName ( System::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.

◆ set_UdlConnectString()

void Aspose::Words::Settings::Odso::set_UdlConnectString ( System::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.

◆ Type()

static const System::TypeInfo& Aspose::Words::Settings::Odso::Type ( )
static