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

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

#include <Aspose.Words.Cpp/Model/MailMerge/MappedDataFieldCollection.h>

+ Inheritance diagram for Aspose::Words::MailMerging::MappedDataFieldCollection:

Public Member Functions

void Add (String documentFieldName, String dataSourceFieldName)
 Adds a new field mapping. More...
 
void Clear ()
 Removes all elements from the collection. More...
 
bool ContainsKey (String documentFieldName)
 Determines whether a mapping from the specified field in the document exists in the collection. More...
 
bool ContainsValue (String dataSourceFieldName)
 Determines whether a mapping from the specified field in the data source exists in the collection. More...
 
int32_t get_Count ()
 Gets the number of elements contained in the collection. More...
 
SharedPtr< IEnumerator< KeyValuePair< String, String > > > GetEnumerator ()
 Returns a dictionary enumerator object that can be used to iterate over all items in the collection. More...
 
String idx_get (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 (String documentFieldName, String value)
 Gets or sets the name of the field in the data source associated with the specified mail merge field. More...
 
void Remove (String documentFieldName)
 Removes a field mapping. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::String > >
EnumeratorBasedIterator< T, IEnumerator< T > > begin () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > cbegin () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > cend () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > end () noexcept
 
bool LINQ_All (std::function< bool(T)> predicate)
 
bool LINQ_Any ()
 
bool LINQ_Any (std::function< bool(T)> predicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
bool LINQ_Contains (T value)
 
int LINQ_Count ()
 
LINQ_ElementAt (int index)
 
LINQ_First ()
 
LINQ_FirstOrDefault ()
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 
LINQ_Last ()
 
LINQ_LastOrDefault ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 
ArrayPtr< T > LINQ_ToArray ()
 
SharedPtr< List< T > > LINQ_ToList ()
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::String > >
typedef IEnumerator< T > IEnumeratorType
 
typedef T ValueType
 
- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

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.