Asposecpplib
System::Xml::XmlAttributeCollection Class Referencefinal

Represents a collection of attributes that can be accessed by name or index. More...

Inherits System::Xml::XmlNamedNodeMap.

Public Types

using Ptr = SharedPtr< XmlAttributeCollection >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Xml::XmlNamedNodeMap
using Ptr = SharedPtr< XmlNamedNodeMap >
 An alias for shared pointer to an instance of this class. More...
 
using iterator = SmallXmlNodeList::Iterator
 Iterator type. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >
typedef IEnumerator< SharedPtr< System::Xml::XmlNode > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = SharedPtr< System::Xml::XmlNode >
 
using iterator = System::Details::VirtualizedIterator< SharedPtr< System::Xml::XmlNode > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< SharedPtr< System::Xml::XmlNode > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< SharedPtr< System::Xml::XmlNode > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = SharedPtr< System::Xml::XmlNode >
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

SharedPtr< XmlAttributeidx_get (int32_t i)
 Returns the attribute with the specified index. More...
 
SharedPtr< XmlAttributeidx_get (const String &name)
 Returns the attribute with the specified name. More...
 
SharedPtr< XmlAttributeidx_get (const String &localName, const String &namespaceURI)
 Returns the attribute with the specified local name and namespace Uniform Resource Identifier (URI). More...
 
SharedPtr< XmlNodeSetNamedItem (SharedPtr< XmlNode > node) override
 Adds an XmlNode using its XmlNode::get_Name result. More...
 
SharedPtr< XmlAttributePrepend (const SharedPtr< XmlAttribute > &node)
 Inserts the specified attribute as the first node in the collection. More...
 
SharedPtr< XmlAttributeAppend (const SharedPtr< XmlAttribute > &node)
 Inserts the specified attribute as the last node in the collection. More...
 
SharedPtr< XmlAttributeInsertBefore (const SharedPtr< XmlAttribute > &newNode, const SharedPtr< XmlAttribute > &refNode)
 Inserts the specified attribute immediately before the specified reference attribute. More...
 
SharedPtr< XmlAttributeInsertAfter (const SharedPtr< XmlAttribute > &newNode, const SharedPtr< XmlAttribute > &refNode)
 Inserts the specified attribute immediately after the specified reference attribute. More...
 
SharedPtr< XmlAttributeRemove (const SharedPtr< XmlAttribute > &node)
 Removes the specified attribute from the collection. More...
 
SharedPtr< XmlAttributeRemoveAt (int32_t i)
 Removes the attribute corresponding to the specified index from the collection. More...
 
void RemoveAll ()
 Removes all attributes from the collection. More...
 
void CopyTo (const ArrayPtr< SharedPtr< XmlAttribute >> &array, int32_t index)
 Copies all the XmlAttribute objects from this collection into the given array. More...
 
- Public Member Functions inherited from System::Xml::XmlNamedNodeMap
virtual int32_t get_Count ()
 Returns the number of nodes in the XmlNamedNodeMap. More...
 
virtual SharedPtr< XmlNodeGetNamedItem (String name)
 Retrieves an XmlNode specified by name. More...
 
virtual SharedPtr< XmlNodeRemoveNamedItem (String name)
 Removes the node from the XmlNamedNodeMap. More...
 
virtual SharedPtr< XmlNodeItem (int32_t index)
 Retrieves the node at the specified index in the XmlNamedNodeMap. More...
 
virtual SharedPtr< XmlNodeGetNamedItem (String localName, String namespaceURI)
 Retrieves a node with the matching XmlNode::get_LocalName and XmlNode::get_NamespaceURI values. More...
 
virtual SharedPtr< XmlNodeRemoveNamedItem (String localName, String namespaceURI)
 Removes a node with the matching XmlNode::get_LocalName and XmlNode::get_NamespaceURI values. More...
 
SharedPtr< Collections::Generic::IEnumerator< SharedPtr< XmlNode > > > GetEnumerator () override
 Provides support for iteration over the collection of nodes in the XmlNamedNodeMap. More...
 
iterator begin () const noexcept
 Gets iterator to the first element of collection. More...
 
iterator end () const noexcept
 Gets iterator for a non-existent element behind the last element of the collection. More...
 
iterator cbegin () const noexcept
 Gets iterator to the first element of collection. More...
 
iterator cend () const noexcept
 Gets iterator for a non-existent element behind the last element of the collection. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >
SharedPtr< System::Xml::XmlNodeLINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_First ()
 Returns the first element of a sequence. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_First (const Func< SharedPtr< System::Xml::XmlNode >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_FirstOrDefault (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_Last ()
 Returns the last element of a sequence. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< SharedPtr< System::Xml::XmlNode > > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< SharedPtr< System::Xml::XmlNode >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< SharedPtr< System::Xml::XmlNode > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_Where (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (SharedPtr< System::Xml::XmlNode > value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_OrderBy (const Func< SharedPtr< System::Xml::XmlNode >, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_OrderByDescending (const Func< SharedPtr< System::Xml::XmlNode >, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< SharedPtr< System::Xml::XmlNode >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< SharedPtr< System::Xml::XmlNode >, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_Concat (SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, SharedPtr< System::Xml::XmlNode > > > > > LINQ_GroupBy (System::Func< SharedPtr< System::Xml::XmlNode >, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< SharedPtr< System::Xml::XmlNode >, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. 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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

virtual ~XmlAttributeCollection ()
 
- Protected Member Functions inherited from System::Xml::XmlNamedNodeMap
virtual ~XmlNamedNodeMap ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 

Additional Inherited Members

- 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 ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Represents a collection of attributes that can be accessed by name or index.

Attention
Objects of this class should only be allocated using System::MakeObject() function. Never create instances of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ Ptr

An alias for shared pointer to an instance of this class.

Constructor & Destructor Documentation

◆ ~XmlAttributeCollection()

virtual System::Xml::XmlAttributeCollection::~XmlAttributeCollection ( )
protectedvirtual

Member Function Documentation

◆ Append()

SharedPtr<XmlAttribute> System::Xml::XmlAttributeCollection::Append ( const SharedPtr< XmlAttribute > &  node)

Inserts the specified attribute as the last node in the collection.

Parameters
nodeThe attribute to insert.
Returns
The XmlAttribute to append to the collection.
Exceptions
ArgumentExceptionnode was created from a document different from the one that created this collection.

◆ CopyTo()

void System::Xml::XmlAttributeCollection::CopyTo ( const ArrayPtr< SharedPtr< XmlAttribute >> &  array,
int32_t  index 
)

Copies all the XmlAttribute objects from this collection into the given array.

Parameters
arrayThe array that is the destination of the objects copied from this collection.
indexThe index in the array where copying begins.

◆ idx_get() [1/3]

SharedPtr<XmlAttribute> System::Xml::XmlAttributeCollection::idx_get ( const String localName,
const String namespaceURI 
)

Returns the attribute with the specified local name and namespace Uniform Resource Identifier (URI).

Parameters
localNameThe local name of the attribute.
namespaceURIThe namespace URI of the attribute.
Returns
The attribute with the specified local name and namespace URI. If the attribute does not exist, this method returns nullptr.

◆ idx_get() [2/3]

SharedPtr<XmlAttribute> System::Xml::XmlAttributeCollection::idx_get ( const String name)

Returns the attribute with the specified name.

Parameters
nameThe qualified name of the attribute.
Returns
The attribute with the specified name. If the attribute does not exist, this method returns nullptr.

◆ idx_get() [3/3]

SharedPtr<XmlAttribute> System::Xml::XmlAttributeCollection::idx_get ( int32_t  i)

Returns the attribute with the specified index.

Parameters
iThe index of the attribute.
Returns
The attribute at the specified index.
Exceptions
IndexOutOfRangeExceptionThe index being passed in is out of range.

◆ InsertAfter()

SharedPtr<XmlAttribute> System::Xml::XmlAttributeCollection::InsertAfter ( const SharedPtr< XmlAttribute > &  newNode,
const SharedPtr< XmlAttribute > &  refNode 
)

Inserts the specified attribute immediately after the specified reference attribute.

Parameters
newNodeThe attribute to insert.
refNodeThe reference attribute. newNode is placed after the refNode.
Returns
The XmlAttribute to insert into the collection.
Exceptions
ArgumentExceptionThe newNode was created from a document different from the one that created this collection. Or the refNode is not a member of this collection.

◆ InsertBefore()

SharedPtr<XmlAttribute> System::Xml::XmlAttributeCollection::InsertBefore ( const SharedPtr< XmlAttribute > &  newNode,
const SharedPtr< XmlAttribute > &  refNode 
)

Inserts the specified attribute immediately before the specified reference attribute.

Parameters
newNodeThe attribute to insert.
refNodeThe reference attribute. newNode is placed before the refNode.
Returns
The XmlAttribute to insert into the collection.
Exceptions
ArgumentExceptionThe newNode was created from a document different from the one that created this collection. Or the refNode is not a member of this collection.

◆ Prepend()

SharedPtr<XmlAttribute> System::Xml::XmlAttributeCollection::Prepend ( const SharedPtr< XmlAttribute > &  node)

Inserts the specified attribute as the first node in the collection.

Parameters
nodeThe attribute to insert.
Returns
The XmlAttribute added to the collection.

◆ Remove()

SharedPtr<XmlAttribute> System::Xml::XmlAttributeCollection::Remove ( const SharedPtr< XmlAttribute > &  node)

Removes the specified attribute from the collection.

Parameters
nodeThe attribute to remove.
Returns
The node removed or nullptr if it is not found in the collection.

◆ RemoveAll()

void System::Xml::XmlAttributeCollection::RemoveAll ( )

Removes all attributes from the collection.

◆ RemoveAt()

SharedPtr<XmlAttribute> System::Xml::XmlAttributeCollection::RemoveAt ( int32_t  i)

Removes the attribute corresponding to the specified index from the collection.

Parameters
iThe index of the node to remove. The first node has index 0.
Returns
Returns nullptr if there is no attribute at the specified index.

◆ SetNamedItem()

SharedPtr<XmlNode> System::Xml::XmlAttributeCollection::SetNamedItem ( SharedPtr< XmlNode node)
overridevirtual

Adds an XmlNode using its XmlNode::get_Name result.

Parameters
nodeAn attribute node to store in this collection. The node will later be accessible using the name of the node. If a node with that name is already present in the collection, it is replaced by the new one; otherwise, the node is appended to the end of the collection.
Returns
If the node replaces an existing node with the same name, the old node is returned; otherwise, the added node is returned.
Exceptions
ArgumentExceptionnode was created from a different XmlDocument than the one that created this collection. This XmlAttributeCollection is read-only.
InvalidOperationExceptionnode is an XmlAttribute that is already an attribute of another XmlElement object. To re-use attributes in other elements, you must clone the XmlAttribute objects you want to re-use.

Reimplemented from System::Xml::XmlNamedNodeMap.