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

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

#include "Aspose.Words.Cpp/Model/Settings/Odso.h"

Inherits System::Object.

Public Member Functions

char16_t get_ColumnDelimiter () const
 
void set_ColumnDelimiter (char16_t value)
 
bool get_FirstRowContainsColumnNames () const
 
void set_FirstRowContainsColumnNames (bool value)
 
System::String get_DataSource () const
 
void set_DataSource (System::String value)
 
System::String get_TableName () const
 
void set_TableName (System::String value)
 
Aspose::Words::Settings::OdsoDataSourceType get_DataSourceType () const
 
void set_DataSourceType (Aspose::Words::Settings::OdsoDataSourceType value)
 
System::String get_UdlConnectString () const
 
void set_UdlConnectString (System::String value)
 
System::SharedPtr< Aspose::Words::Settings::OdsoFieldMapDataCollectionget_FieldMapDatas () const
 
void set_FieldMapDatas (System::SharedPtr< Aspose::Words::Settings::OdsoFieldMapDataCollection > value)
 
System::SharedPtr< Aspose::Words::Settings::OdsoRecipientDataCollectionget_RecipientDatas () const
 
void set_RecipientDatas (System::SharedPtr< Aspose::Words::Settings::OdsoRecipientDataCollection > value)
 
System::SharedPtr< Aspose::Words::Settings::OdsoClone ()
 
 Odso ()
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 

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 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 & Destructor Documentation

◆ Odso()

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

Member Function Documentation

◆ Clone()

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

◆ get_ColumnDelimiter()

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

◆ get_DataSource()

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

◆ get_DataSourceType()

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

◆ get_FieldMapDatas()

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

◆ get_FirstRowContainsColumnNames()

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

◆ get_RecipientDatas()

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

◆ get_TableName()

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

◆ get_UdlConnectString()

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

◆ set_ColumnDelimiter()

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

◆ set_DataSource()

void Aspose::Words::Settings::Odso::set_DataSource ( System::String  value)

◆ 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)

◆ 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)

◆ set_TableName()

void Aspose::Words::Settings::Odso::set_TableName ( System::String  value)

◆ set_UdlConnectString()

void Aspose::Words::Settings::Odso::set_UdlConnectString ( System::String  value)