System::Xml::XmlNamedNodeMap Class Reference

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

Inherits System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >.

Inherited by System::Xml::XmlAttributeCollection.

Public Types

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

virtual ASPOSECPP_SHARED_API int32_t get_Count ()
 Returns the number of nodes in the XmlNamedNodeMap. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeGetNamedItem (String name)
 Retrieves an XmlNode specified by name. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeSetNamedItem (SharedPtr< XmlNode > node)
 Adds an XmlNode using its XmlNode::get_Name value. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeRemoveNamedItem (String name)
 Removes the node from the XmlNamedNodeMap. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeItem (int32_t index)
 Retrieves the node at the specified index in the XmlNamedNodeMap. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeGetNamedItem (String localName, String namespaceURI)
 Retrieves a node with the matching XmlNode::get_LocalName and XmlNode::get_NamespaceURI values. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeRemoveNamedItem (String localName, String namespaceURI)
 Removes a node with the matching XmlNode::get_LocalName and XmlNode::get_NamespaceURI values. More...
 
ASPOSECPP_SHARED_API SharedPtr< Collections::Generic::IEnumerator< SharedPtr< XmlNode > > > GetEnumerator () override
 Provides support for iteration over the collection of nodes in the XmlNamedNodeMap. More...
 
ASPOSECPP_SHARED_API iterator begin () const noexcept
 Gets iterator to the first element of collection. More...
 
ASPOSECPP_SHARED_API iterator end () const noexcept
 Gets iterator for a non-existent element behind the last element of the collection. More...
 
ASPOSECPP_SHARED_API iterator cbegin () const noexcept
 Gets iterator to the first element of collection. More...
 
ASPOSECPP_SHARED_API 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 ()
 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
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end ()
 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
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const
 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
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 
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 ASPOSECPP_SHARED_API ~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...
 

Detailed Description

Represents a collection of nodes 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

◆ iterator

using System::Xml::XmlNamedNodeMap::iterator = SmallXmlNodeList::Iterator

Iterator type.

◆ Ptr

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

Constructor & Destructor Documentation

◆ ~XmlNamedNodeMap()

virtual ASPOSECPP_SHARED_API System::Xml::XmlNamedNodeMap::~XmlNamedNodeMap ( )
protectedvirtual

Member Function Documentation

◆ begin()

ASPOSECPP_SHARED_API iterator System::Xml::XmlNamedNodeMap::begin ( ) const
noexcept

Gets iterator to the first element of collection.

Returns
An iterator pointing to the first element in the collection.

◆ cbegin()

ASPOSECPP_SHARED_API iterator System::Xml::XmlNamedNodeMap::cbegin ( ) const
noexcept

Gets iterator to the first element of collection.

Returns
An iterator pointing to the first element in the collection.

◆ cend()

ASPOSECPP_SHARED_API iterator System::Xml::XmlNamedNodeMap::cend ( ) const
noexcept

Gets iterator for a non-existent element behind the last element of the collection.

Returns
An iterator pointing to the element behind the last element of the collection.

◆ end()

ASPOSECPP_SHARED_API iterator System::Xml::XmlNamedNodeMap::end ( ) const
noexcept

Gets iterator for a non-existent element behind the last element of the collection.

Returns
An iterator pointing to the element behind the last element of the collection.

◆ get_Count()

virtual ASPOSECPP_SHARED_API int32_t System::Xml::XmlNamedNodeMap::get_Count ( )
virtual

Returns the number of nodes in the XmlNamedNodeMap.

Returns
The number of nodes.

◆ GetEnumerator()

ASPOSECPP_SHARED_API SharedPtr<Collections::Generic::IEnumerator<SharedPtr<XmlNode> > > System::Xml::XmlNamedNodeMap::GetEnumerator ( )
overridevirtual

Provides support for iteration over the collection of nodes in the XmlNamedNodeMap.

Returns
An enumerator object.

Implements System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >.

◆ GetNamedItem() [1/2]

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNamedNodeMap::GetNamedItem ( String  name)
virtual

Retrieves an XmlNode specified by name.

Parameters
nameThe qualified name of the node to retrieve. It is matched against the XmlNode::get_Name value of the matching node.
Returns
An XmlNode with the specified name or nullptr if a matching node is not found.

◆ GetNamedItem() [2/2]

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNamedNodeMap::GetNamedItem ( String  localName,
String  namespaceURI 
)
virtual

Retrieves a node with the matching XmlNode::get_LocalName and XmlNode::get_NamespaceURI values.

Parameters
localNameThe local name of the node to retrieve.
namespaceURIThe namespace Uniform Resource Identifier (URI) of the node to retrieve.
Returns
An XmlNode with the matching local name and namespace URI or nullptr if a matching node was not found.

◆ Item()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNamedNodeMap::Item ( int32_t  index)
virtual

Retrieves the node at the specified index in the XmlNamedNodeMap.

Parameters
indexThe index position of the node to retrieve from the XmlNamedNodeMap. The index is zero-based; therefore, the index of the first node is 0 and the index of the last node is XmlNamedNodeMap::get_Count - 1.
Returns
The XmlNode at the specified index. If index is less than 0 or greater than or equal to the XmlNamedNodeMap::get_Count value, nullptr is returned.

◆ RemoveNamedItem() [1/2]

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNamedNodeMap::RemoveNamedItem ( String  name)
virtual

Removes the node from the XmlNamedNodeMap.

Parameters
nameThe qualified name of the node to remove. The name is matched against the XmlNode::get_Name value of the matching node.
Returns
The XmlNode removed from this XmlNamedNodeMap or nullptr if a matching node was not found.

◆ RemoveNamedItem() [2/2]

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNamedNodeMap::RemoveNamedItem ( String  localName,
String  namespaceURI 
)
virtual

Removes a node with the matching XmlNode::get_LocalName and XmlNode::get_NamespaceURI values.

Parameters
localNameThe local name of the node to remove.
namespaceURIThe namespace URI of the node to remove.
Returns
The XmlNode removed or nullptr if a matching node was not found.

◆ SetNamedItem()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNamedNodeMap::SetNamedItem ( SharedPtr< XmlNode node)
virtual

Adds an XmlNode using its XmlNode::get_Name value.

Parameters
nodeAn XmlNode to store in the XmlNamedNodeMap. If a node with that name is already present in the map, it is replaced by the new one.
Returns
If the node replaces an existing node with the same name, the old node is returned; otherwise, nullptr is returned.
Exceptions
ArgumentExceptionThe node was created from a different XmlDocument than the one that created the XmlNamedNodeMap; or the XmlNamedNodeMap is read-only.

Reimplemented in System::Xml::XmlAttributeCollection.