Aspose::Words::MailMerging::MappedDataFieldCollection Class Reference

Allows to automatically map between names of fields in your data source and names of mail merge fields in the document. More...

#include "Aspose.Words.Cpp/Model/MailMerge/MappedDataFieldCollection.h"

Inherits System::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::String > >.

Public Member Functions

int32_t get_Count ()
 Gets the number of elements contained in the collection. More...
 
System::String idx_get (System::String documentFieldName)
 Gets or sets the name of the field in the data source associated with the specified mail merge field. More...
 
void idx_set (System::String documentFieldName, System::String value)
 Gets or sets the name of the field in the data source associated with the specified mail merge field. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::Collections::Generic::KeyValuePair< System::String, System::String > > > GetEnumerator ()
 Returns a dictionary enumerator object that can be used to iterate over all items in the collection. More...
 
void Add (System::String documentFieldName, System::String dataSourceFieldName)
 Adds a new field mapping. More...
 
bool ContainsKey (System::String documentFieldName)
 Determines whether a mapping from the specified field in the document exists in the collection. More...
 
bool ContainsValue (System::String dataSourceFieldName)
 Determines whether a mapping from the specified field in the data source exists in the collection. More...
 
void Remove (System::String documentFieldName)
 Removes a field mapping. More...
 
void Clear ()
 Removes all elements from the collection. More...
 
- 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::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::String > >
typedef IEnumerator< System::Collections::Generic::KeyValuePair< System::String, System::String > > IEnumeratorType
 Enumerator type. More...
 
- 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

Allows to automatically map between names of fields in your data source and names of mail merge fields in the document.

This is implemented as a collection of string keys into string values. The keys are the names of mail merge fields in the document and the values are the names of fields in your data source.

See also
Aspose::Words::MailMerging::MailMerge, Aspose::Words::MailMerging::MailMerge::get_MappedDataFields

Member Function Documentation

◆ Add()

void Aspose::Words::MailMerging::MappedDataFieldCollection::Add ( System::String  documentFieldName,
System::String  dataSourceFieldName 
)

Adds a new field mapping.

Parameters
documentFieldNameCase-sensitive name of the mail merge field in the document.
dataSourceFieldNameCase-sensitive name of the field in the data source.

◆ Clear()

void Aspose::Words::MailMerging::MappedDataFieldCollection::Clear ( )

Removes all elements from the collection.

◆ ContainsKey()

bool Aspose::Words::MailMerging::MappedDataFieldCollection::ContainsKey ( System::String  documentFieldName)

Determines whether a mapping from the specified field in the document exists in the collection.

Parameters
documentFieldNameCase-sensitive name of the mail merge field in the document.
Returns
True if item is found in the collection; otherwise, false.

◆ ContainsValue()

bool Aspose::Words::MailMerging::MappedDataFieldCollection::ContainsValue ( System::String  dataSourceFieldName)

Determines whether a mapping from the specified field in the data source exists in the collection.

Parameters
dataSourceFieldNameCase-sensitive name of the field in the data source.
Returns
True if item is found in the collection; otherwise, false.

◆ get_Count()

int32_t Aspose::Words::MailMerging::MappedDataFieldCollection::get_Count ( )

Gets the number of elements contained in the collection.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::Collections::Generic::KeyValuePair<System::String, System::String> > > Aspose::Words::MailMerging::MappedDataFieldCollection::GetEnumerator ( )
virtual

Returns a dictionary enumerator object that can be used to iterate over all items in the collection.

Implements System::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::String > >.

◆ idx_get()

System::String Aspose::Words::MailMerging::MappedDataFieldCollection::idx_get ( System::String  documentFieldName)

Gets or sets the name of the field in the data source associated with the specified mail merge field.

◆ idx_set()

void Aspose::Words::MailMerging::MappedDataFieldCollection::idx_set ( System::String  documentFieldName,
System::String  value 
)

Gets or sets the name of the field in the data source associated with the specified mail merge field.

◆ Remove()

void Aspose::Words::MailMerging::MappedDataFieldCollection::Remove ( System::String  documentFieldName)

Removes a field mapping.

Parameters
documentFieldNameCase-sensitive name of the mail merge field in the document.