Aspose::Words::Markup::CustomXmlPartCollection Class Reference

Represents a collection of Custom XML Parts. The items are Aspose::Words::Markup::CustomXmlPart objects. More...

#include "Aspose.Words.Cpp/Model/Markup/CustomXmlPartCollection.h"

Inherits System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Markup::CustomXmlPart > >.

Public Member Functions

int32_t get_Count ()
 Gets the number of elements contained in the collection. More...
 
System::SharedPtr< Aspose::Words::Markup::CustomXmlPartidx_get (int32_t index)
 Gets or sets an item at the specified index. More...
 
void idx_set (int32_t index, System::SharedPtr< Aspose::Words::Markup::CustomXmlPart > value)
 Gets or sets an item at the specified index. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Markup::CustomXmlPart > > > GetEnumerator ()
 Returns an enumerator object that can be used to iterate over all items in the collection. More...
 
void Add (System::SharedPtr< Aspose::Words::Markup::CustomXmlPart > part)
 Adds an item to the collection. More...
 
System::SharedPtr< Aspose::Words::Markup::CustomXmlPartAdd (System::String id, System::String xml)
 Creates a new XML part with the specified XML and adds it to the collection. More...
 
void RemoveAt (int32_t index)
 Removes an item at the specified index. More...
 
void Clear ()
 Removes all elements from the collection. More...
 
System::SharedPtr< Aspose::Words::Markup::CustomXmlPartGetById (System::String id)
 Finds and returns a custom XML part by its identifier. More...
 
System::SharedPtr< Aspose::Words::Markup::CustomXmlPartCollectionClone ()
 Makes a deep copy of this collection and its items. More...
 
 CustomXmlPartCollection ()
 
- 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::SharedPtr< Aspose::Words::Markup::CustomXmlPart > >
typedef IEnumerator< System::SharedPtr< Aspose::Words::Markup::CustomXmlPart > > 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

Represents a collection of Custom XML Parts. The items are Aspose::Words::Markup::CustomXmlPart objects.

You do not normally need to create instances of this class. You can access custom XML data stored in a document via the Aspose::Words::Document::get_CustomXmlParts property.

See also
Aspose::Words::Markup::CustomXmlPart, Aspose::Words::Document::get_CustomXmlParts

Constructor & Destructor Documentation

◆ CustomXmlPartCollection()

Aspose::Words::Markup::CustomXmlPartCollection::CustomXmlPartCollection ( )

Member Function Documentation

◆ Add() [1/2]

void Aspose::Words::Markup::CustomXmlPartCollection::Add ( System::SharedPtr< Aspose::Words::Markup::CustomXmlPart part)

Adds an item to the collection.

Parameters
partThe custom XML part to add.

◆ Add() [2/2]

System::SharedPtr<Aspose::Words::Markup::CustomXmlPart> Aspose::Words::Markup::CustomXmlPartCollection::Add ( System::String  id,
System::String  xml 
)

Creates a new XML part with the specified XML and adds it to the collection.

Parameters
idIdentifier of a new custom XML part.
xmlXML data of the part.
Returns
Created custom XML part.

◆ Clear()

void Aspose::Words::Markup::CustomXmlPartCollection::Clear ( )

Removes all elements from the collection.

◆ Clone()

System::SharedPtr<Aspose::Words::Markup::CustomXmlPartCollection> Aspose::Words::Markup::CustomXmlPartCollection::Clone ( )

Makes a deep copy of this collection and its items.

◆ get_Count()

int32_t Aspose::Words::Markup::CustomXmlPartCollection::get_Count ( )

Gets the number of elements contained in the collection.

◆ GetById()

System::SharedPtr<Aspose::Words::Markup::CustomXmlPart> Aspose::Words::Markup::CustomXmlPartCollection::GetById ( System::String  id)

Finds and returns a custom XML part by its identifier.

Parameters
idCase-sensitive string that identifies the custom XML part.
Returns
Returns null if a custom XML part with the specified identifier is not found.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Aspose::Words::Markup::CustomXmlPart> > > Aspose::Words::Markup::CustomXmlPartCollection::GetEnumerator ( )
virtual

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

Implements System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Markup::CustomXmlPart > >.

◆ idx_get()

System::SharedPtr<Aspose::Words::Markup::CustomXmlPart> Aspose::Words::Markup::CustomXmlPartCollection::idx_get ( int32_t  index)

Gets or sets an item at the specified index.

Parameters
indexZero-based index of the item.

◆ idx_set()

void Aspose::Words::Markup::CustomXmlPartCollection::idx_set ( int32_t  index,
System::SharedPtr< Aspose::Words::Markup::CustomXmlPart value 
)

Gets or sets an item at the specified index.

Parameters
indexZero-based index of the item.

◆ RemoveAt()

void Aspose::Words::Markup::CustomXmlPartCollection::RemoveAt ( int32_t  index)

Removes an item at the specified index.

Parameters
indexThe zero based index.