Aspose::Words::VariableCollection Class Reference

A collection of document variables. More...

#include "Aspose.Words.Cpp/Model/Document/VariableCollection.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 name)
 Gets or a sets a document variable by the case-insensitive name. null values are not allowed as a right hand side of the assignment and will be replaced by empty string. More...
 
void idx_set (System::String name, System::String value)
 Gets or a sets a document variable by the case-insensitive name. null values are not allowed as a right hand side of the assignment and will be replaced by empty string. More...
 
System::String idx_get (int32_t index)
 Gets or sets a document variable at the specified index. null values are not allowed as a right hand side of the assignment and will be replaced by empty string. More...
 
void idx_set (int32_t index, System::String value)
 Gets or sets a document variable at the specified index. null values are not allowed as a right hand side of the assignment and will be replaced by empty string. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::Collections::Generic::KeyValuePair< System::String, System::String > > > GetEnumerator ()
 Returns an enumerator object that can be used to iterate over all variable in the collection. More...
 
void Add (System::String name, System::String value)
 Adds a document variable to the collection. More...
 
bool Contains (System::String name)
 Determines whether the collection contains a document variable with the given name. More...
 
int32_t IndexOfKey (System::String name)
 Returns the zero-based index of the specified document variable in the collection. More...
 
void Remove (System::String name)
 Removes a document variable with the specified name from the collection. More...
 
void RemoveAt (int32_t index)
 Removes a document variable at the specified index. 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...
 

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)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

A collection of document variables.

Variable names and values are strings.

Variable names are case-insensitive.

Member Function Documentation

◆ Add()

void Aspose::Words::VariableCollection::Add ( System::String  name,
System::String  value 
)

Adds a document variable to the collection.

Parameters
nameThe case-insensitive name of the variable to add.
valueThe value of the variable. The value cannot be null, if value is null empty string will be used instead.

◆ Clear()

void Aspose::Words::VariableCollection::Clear ( )

Removes all elements from the collection.

◆ Contains()

bool Aspose::Words::VariableCollection::Contains ( System::String  name)

Determines whether the collection contains a document variable with the given name.

Parameters
nameCase-insensitive name of the document variable to locate.
Returns
True if item is found in the collection; otherwise, false.

◆ get_Count()

int32_t Aspose::Words::VariableCollection::get_Count ( )

Gets the number of elements contained in the collection.

◆ GetEnumerator()

Returns an enumerator object that can be used to iterate over all variable in the collection.

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

◆ idx_get() [1/2]

System::String Aspose::Words::VariableCollection::idx_get ( int32_t  index)

Gets or sets a document variable at the specified index. null values are not allowed as a right hand side of the assignment and will be replaced by empty string.

Parameters
indexZero-based index of the document variable.

◆ idx_get() [2/2]

System::String Aspose::Words::VariableCollection::idx_get ( System::String  name)

Gets or a sets a document variable by the case-insensitive name. null values are not allowed as a right hand side of the assignment and will be replaced by empty string.

◆ idx_set() [1/2]

void Aspose::Words::VariableCollection::idx_set ( int32_t  index,
System::String  value 
)

Gets or sets a document variable at the specified index. null values are not allowed as a right hand side of the assignment and will be replaced by empty string.

Parameters
indexZero-based index of the document variable.

◆ idx_set() [2/2]

void Aspose::Words::VariableCollection::idx_set ( System::String  name,
System::String  value 
)

Gets or a sets a document variable by the case-insensitive name. null values are not allowed as a right hand side of the assignment and will be replaced by empty string.

◆ IndexOfKey()

int32_t Aspose::Words::VariableCollection::IndexOfKey ( System::String  name)

Returns the zero-based index of the specified document variable in the collection.

Parameters
nameThe case-insensitive name of the variable.
Returns
The zero based index. Negative value if not found.

◆ Remove()

void Aspose::Words::VariableCollection::Remove ( System::String  name)

Removes a document variable with the specified name from the collection.

Parameters
nameThe case-insensitive name of the variable.

◆ RemoveAt()

void Aspose::Words::VariableCollection::RemoveAt ( int32_t  index)

Removes a document variable at the specified index.

Parameters
indexThe zero based index.