Represents a reader that provides fast, non-cached, forward-only access to XML data. More...

#include <xml_text_reader.h>

Inherits System::Xml::XmlReader, System::Xml::IXmlLineInfo, and System::Xml::IXmlNamespaceResolver.

Public Types
using	Ptr = SharedPtr< XmlTextReader >
	An alias for shared pointer to an instance of this class. More...

Public Types inherited from System::Xml::XmlReader
using	Ptr = SharedPtr< XmlReader >
	An alias for shared pointer to an instance of this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Member Functions
XmlNodeType	get_NodeType () override
	Returns the type of the current node. More...

String	get_Name () override
	Returns the qualified name of the current node. More...

String	get_LocalName () override
	Returns the local name of the current node. More...

String	get_NamespaceURI () override
	Returns the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned. More...

String	get_Prefix () override
	Returns the namespace prefix associated with the current node. More...

bool	get_HasValue () override
	Returns a value indicating whether the current node can have a XmlTextReader::get_Value other than String::Empty. More...

String	get_Value () override
	Returns the text value of the current node. More...

int32_t	get_Depth () override
	Returns the depth of the current node in the XML document. More...

String	get_BaseURI () override
	Returns the base URI of the current node. More...

bool	get_IsEmptyElement () override
	Returns a value indicating whether the current node is an empty element (for example, `<MyElement/>`). More...

bool	get_IsDefault () override
	Returns a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema. More...

char16_t	get_QuoteChar () override
	Returns the quotation mark character used to enclose the value of an attribute node. More...

System::Xml::XmlSpace	get_XmlSpace () override
	Returns the current `xml:space` scope. More...

String	get_XmlLang () override
	Returns the current `xml:lang` scope. More...

int32_t	get_AttributeCount () override
	Returns the number of attributes on the current node. More...

bool	get_EOF () override
	Returns a value indicating whether the reader is positioned at the end of the stream. More...

System::Xml::ReadState	get_ReadState () override
	Returns the state of the reader. More...

SharedPtr< XmlNameTable >	get_NameTable () override
	Returns the XmlNameTable associated with this implementation. More...

bool	get_CanResolveEntity () override
	Returns a value indicating whether this reader can parse and resolve entities. More...

bool	get_CanReadBinaryContent () override
	Returns a value indicating whether the XmlTextReader implements the binary content read methods. More...

bool	get_CanReadValueChunk () override
	Returns a value indicating whether the XmlTextReader implements the XmlReader::ReadValueChunk method. More...

int32_t	get_LineNumber () override
	Returns the current line number. More...

int32_t	get_LinePosition () override
	Returns the current line position. More...

bool	get_Namespaces ()
	Returns a value indicating whether to do namespace support. More...

void	set_Namespaces (bool value)
	Sets a value indicating whether to do namespace support. More...

bool	get_Normalization ()
	Returns a value indicating whether to normalize white space and attribute values. More...

void	set_Normalization (bool value)
	Sets a value indicating whether to normalize white space and attribute values. More...

SharedPtr< System::Text::Encoding >	get_Encoding ()
	Returns the encoding of the document. More...

System::Xml::WhitespaceHandling	get_WhitespaceHandling ()
	Returns a value that specifies how white space is handled. More...

void	set_WhitespaceHandling (System::Xml::WhitespaceHandling value)
	Sets a value that specifies how white space is handled. More...

bool	get_ProhibitDtd ()
	Returns a value indicating whether to allow DTD processing. More...

void	set_ProhibitDtd (bool value)
	Sets a value indicating whether to allow DTD processing. More...

System::Xml::DtdProcessing	get_DtdProcessing ()
	Returns the DtdProcessing enumeration. More...

void	set_DtdProcessing (System::Xml::DtdProcessing value)
	Sets the DtdProcessing enumeration. More...

System::Xml::EntityHandling	get_EntityHandling ()
	Returns a value that specifies how the reader handles entities. More...

void	set_EntityHandling (System::Xml::EntityHandling value)
	Sets a value that specifies how the reader handles entities. More...

void	set_XmlResolver (const SharedPtr< System::Xml::XmlResolver > &value)
	Sets the XmlResolver used for resolving DTD references. More...

	XmlTextReader (const SharedPtr< IO::Stream > &input)
	Initializes a new instance of the XmlTextReader class with the specified stream. More...

	XmlTextReader (const String &url, const SharedPtr< IO::Stream > &input)
	Initializes a new instance of the XmlTextReader class with the specified URL and stream. More...

	XmlTextReader (const SharedPtr< IO::Stream > &input, const SharedPtr< XmlNameTable > &nt)
	Initializes a new instance of the XmlTextReader class with the specified stream and XmlNameTable. More...

	XmlTextReader (const String &url, const SharedPtr< IO::Stream > &input, const SharedPtr< XmlNameTable > &nt)
	Initializes a new instance of the XmlTextReader class with the specified URL, stream and XmlNameTable. More...

	XmlTextReader (const SharedPtr< IO::TextReader > &input)
	Initializes a new instance of the XmlTextReader class with the specified TextReader. More...

	XmlTextReader (const String &url, const SharedPtr< IO::TextReader > &input)
	Initializes a new instance of the XmlTextReader class with the specified URL and TextReader. More...

	XmlTextReader (const SharedPtr< IO::TextReader > &input, const SharedPtr< XmlNameTable > &nt)
	Initializes a new instance of the XmlTextReader class with the specified TextReader and XmlNameTable. More...

	XmlTextReader (const String &url, const SharedPtr< IO::TextReader > &input, const SharedPtr< XmlNameTable > &nt)
	Initializes a new instance of the XmlTextReader class with the specified URL, TextReader and XmlNameTable. More...

	XmlTextReader (const SharedPtr< IO::Stream > &xmlFragment, XmlNodeType fragType, const SharedPtr< XmlParserContext > &context)
	Initializes a new instance of the XmlTextReader class with the specified stream, XmlNodeType, and XmlParserContext. More...

	XmlTextReader (const String &xmlFragment, XmlNodeType fragType, const SharedPtr< XmlParserContext > &context)
	Initializes a new instance of the XmlTextReader class with the specified string, XmlNodeType, and XmlParserContext. More...

	XmlTextReader (const String &url)
	Initializes a new instance of the XmlTextReader class with the specified file. More...

	XmlTextReader (const String &url, const SharedPtr< XmlNameTable > &nt)
	Initializes a new instance of the XmlTextReader class with the specified file and XmlNameTable. More...

String	GetAttribute (String name) override
	Returns the value of the attribute with the specified name. More...

String	GetAttribute (String localName, String namespaceURI) override
	Returns the value of the attribute with the specified local name and namespace URI. More...

String	GetAttribute (int32_t i) override
	Returns the value of the attribute with the specified index. More...

bool	MoveToAttribute (String name) override
	Moves to the attribute with the specified name. More...

bool	MoveToAttribute (String localName, String namespaceURI) override
	Moves to the attribute with the specified local name and namespace URI. More...

void	MoveToAttribute (int32_t i) override
	Moves to the attribute with the specified index. More...

bool	MoveToFirstAttribute () override
	Moves to the first attribute. More...

bool	MoveToNextAttribute () override
	Moves to the next attribute. More...

bool	MoveToElement () override
	Moves to the element that contains the current attribute node. More...

bool	ReadAttributeValue () override
	Parses the attribute value into one or more `Text`, `EntityReference`, or `EndEntity` nodes. More...

bool	Read () override
	Reads the next node from the stream. More...

void	Close () override
	Changes the XmlReader::get_ReadState to `Closed`. More...

void	Skip () override
	Skips the children of the current node. More...

String	LookupNamespace (const String &prefix) override
	Resolves a namespace prefix in the current element's scope. More...

void	ResolveEntity () override
	Resolves the entity reference for `EntityReference` nodes. More...

int32_t	ReadContentAsBase64 (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count) override
	Reads the content and returns the `Base64` decoded binary bytes. More...

int32_t	ReadElementContentAsBase64 (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count) override
	Reads the element and decodes the Base64 content. More...

int32_t	ReadContentAsBinHex (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count) override
	Reads the content and returns the `BinHex` decoded binary bytes. More...

int32_t	ReadElementContentAsBinHex (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count) override
	Reads the element and decodes the `BinHex` content. More...

String	ReadString () override
	Reads the contents of an element or a text node as a string. More...

bool	HasLineInfo () override
	Returns a value indicating whether the class can return line information. More...

SharedPtr< Collections::Generic::IDictionary< String, String > >	GetNamespacesInScope (XmlNamespaceScope scope) override
	Returns a collection that contains all namespaces currently in-scope. More...

void	ResetState ()
	Resets the state of the reader to ReadState::Initial. More...

SharedPtr< IO::TextReader >	GetRemainder ()
	Returns the remainder of the buffered XML. More...

int32_t	ReadChars (const ArrayPtr< char16_t > &buffer, int32_t index, int32_t count)
	Reads the text contents of an element into a character buffer. This method is designed to read large streams of embedded text by calling it successively. More...

int32_t	ReadBase64 (const ArrayPtr< uint8_t > &array, int32_t offset, int32_t len)
	Decodes Base64 and returns the decoded binary bytes. More...

int32_t	ReadBinHex (const ArrayPtr< uint8_t > &array, int32_t offset, int32_t len)
	Decodes `BinHex` and returns the decoded binary bytes. More...

Public Member Functions inherited from System::Xml::XmlReader
virtual SharedPtr< XmlReaderSettings >	get_Settings ()
	Returns the XmlReaderSettings object used to create this XmlReader instance. More...

virtual XmlNodeType	get_NodeType ()=0
	When overridden in a derived class, gets the type of the current node. More...

virtual String	get_Name ()
	When overridden in a derived class, gets the qualified name of the current node. More...

virtual String	get_LocalName ()=0
	When overridden in a derived class, gets the local name of the current node. More...

virtual String	get_NamespaceURI ()=0
	When overridden in a derived class, gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned. More...

virtual String	get_Prefix ()=0
	When overridden in a derived class, gets the namespace prefix associated with the current node. More...

virtual bool	get_HasValue ()
	When overridden in a derived class, gets a value indicating whether the current node can have a XmlReader::get_Value value. More...

virtual String	get_Value ()=0
	When overridden in a derived class, gets the text value of the current node. More...

virtual int32_t	get_Depth ()=0
	When overridden in a derived class, gets the depth of the current node in the XML document. More...

virtual String	get_BaseURI ()=0
	When overridden in a derived class, gets the base URI of the current node. More...

virtual bool	get_IsEmptyElement ()=0
	When overridden in a derived class, gets a value indicating whether the current node is an empty element (for example, `<MyElement/>`). More...

virtual bool	get_IsDefault ()
	When overridden in a derived class, gets a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema. More...

virtual char16_t	get_QuoteChar ()
	When overridden in a derived class, gets the quotation mark character used to enclose the value of an attribute node. More...

virtual System::Xml::XmlSpace	get_XmlSpace ()
	When overridden in a derived class, gets the current `xml:space` scope. More...

virtual String	get_XmlLang ()
	When overridden in a derived class, gets the current `xml:lang` scope. More...

virtual SharedPtr< Schema::IXmlSchemaInfo >	get_SchemaInfo ()
	Returns the schema information that has been assigned to the current node as a result of schema validation. More...

virtual TypeInfo	get_ValueType ()
	Returns The type for the current node. More...

virtual int32_t	get_AttributeCount ()=0
	When overridden in a derived class, gets the number of attributes on the current node. More...

virtual bool	get_EOF ()=0
	When overridden in a derived class, gets a value indicating whether the reader is positioned at the end of the stream. More...

virtual System::Xml::ReadState	get_ReadState ()=0
	When overridden in a derived class, gets the state of the reader. More...

virtual SharedPtr< XmlNameTable >	get_NameTable ()=0
	When overridden in a derived class, gets the XmlNameTable associated with this implementation. More...

virtual bool	get_CanResolveEntity ()
	Returns a value indicating whether this reader can parse and resolve entities. More...

virtual bool	get_CanReadBinaryContent ()
	Returns a value indicating whether the XmlReader implements the binary content read methods. More...

virtual bool	get_CanReadValueChunk ()
	Returns a value indicating whether the XmlReader implements the XmlReader::ReadValueChunk method. More...

virtual bool	get_HasAttributes ()
	Returns a value indicating whether the current node has any attributes. More...

virtual SharedPtr< Object >	ReadContentAsObject ()
	Reads the text content at the current position as an Object. More...

virtual bool	ReadContentAsBoolean ()
	Reads the text content at the current position as a Boolean. More...

virtual DateTime	ReadContentAsDateTime ()
	Reads the text content at the current position as a DateTime object. More...

virtual DateTimeOffset	ReadContentAsDateTimeOffset ()
	Reads the text content at the current position as a DateTimeOffset object. More...

virtual double	ReadContentAsDouble ()
	Reads the text content at the current position as a double-precision floating-point number. More...

virtual float	ReadContentAsFloat ()
	Reads the text content at the current position as a single-precision floating point number. More...

virtual Decimal	ReadContentAsDecimal ()
	Reads the text content at the current position as a Decimal object. More...

virtual int32_t	ReadContentAsInt ()
	Reads the text content at the current position as a 32-bit signed integer. More...

virtual int64_t	ReadContentAsLong ()
	Reads the text content at the current position as a 64-bit signed integer. More...

virtual String	ReadContentAsString ()
	Reads the text content at the current position as a String object. More...

virtual SharedPtr< Object >	ReadContentAs (const TypeInfo &returnType, SharedPtr< IXmlNamespaceResolver > namespaceResolver)
	Reads the content as an object of the type specified. More...

virtual SharedPtr< Object >	ReadElementContentAsObject ()
	Reads the current element and returns the contents as an Object. More...

virtual SharedPtr< Object >	ReadElementContentAsObject (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as an Object. More...

virtual bool	ReadElementContentAsBoolean ()
	Reads the current element and returns the contents as a Boolean object. More...

virtual bool	ReadElementContentAsBoolean (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a Boolean object. More...

virtual DateTime	ReadElementContentAsDateTime ()
	Reads the current element and returns the contents as a DateTime object. More...

virtual DateTime	ReadElementContentAsDateTime (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a DateTime object. More...

virtual double	ReadElementContentAsDouble ()
	Reads the current element and returns the contents as a double-precision floating-point number. More...

virtual double	ReadElementContentAsDouble (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a double-precision floating-point number. More...

virtual float	ReadElementContentAsFloat ()
	Reads the current element and returns the contents as single-precision floating-point number. More...

virtual float	ReadElementContentAsFloat (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a single-precision floating-point number. More...

virtual Decimal	ReadElementContentAsDecimal ()
	Reads the current element and returns the contents as a Decimal object. More...

virtual Decimal	ReadElementContentAsDecimal (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a Decimal object. More...

virtual int32_t	ReadElementContentAsInt ()
	Reads the current element and returns the contents as a 32-bit signed integer. More...

virtual int32_t	ReadElementContentAsInt (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 32-bit signed integer. More...

virtual int64_t	ReadElementContentAsLong ()
	Reads the current element and returns the contents as a 64-bit signed integer. More...

virtual int64_t	ReadElementContentAsLong (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 64-bit signed integer. More...

virtual String	ReadElementContentAsString ()
	Reads the current element and returns the contents as a String object. More...

virtual String	ReadElementContentAsString (String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a String object. More...

virtual SharedPtr< Object >	ReadElementContentAs (const TypeInfo &returnType, SharedPtr< IXmlNamespaceResolver > namespaceResolver)
	Reads the element content as the requested type. More...

virtual SharedPtr< Object >	ReadElementContentAs (const TypeInfo &returnType, SharedPtr< IXmlNamespaceResolver > namespaceResolver, String localName, String namespaceURI)
	Checks that the specified local name and namespace URI matches that of the current element, then reads the element content as the requested type. More...

virtual String	GetAttribute (String name)=0
	When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_Name value. More...

virtual String	GetAttribute (String name, String namespaceURI)=0
	When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_LocalName and XmlReader::get_NamespaceURI values. More...

virtual String	GetAttribute (int32_t i)=0
	When overridden in a derived class, gets the value of the attribute with the specified index. More...

virtual String	idx_get (int32_t i)
	When overridden in a derived class, gets the value of the attribute with the specified index. More...

virtual String	idx_get (String name)
	When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_Name value. More...

virtual String	idx_get (String name, String namespaceURI)
	When overridden in a derived class, gets the value of the attribute with the specified XmlReader::get_LocalName and XmlReader::get_NamespaceURI values. More...

virtual bool	MoveToAttribute (String name)=0
	When overridden in a derived class, moves to the attribute with the specified XmlReader::get_Name value. More...

virtual bool	MoveToAttribute (String name, String ns)=0
	When overridden in a derived class, moves to the attribute with the specified XmlReader::get_LocalName and XmlReader::get_NamespaceURI values. More...

virtual void	MoveToAttribute (int32_t i)
	When overridden in a derived class, moves to the attribute with the specified index. More...

virtual bool	MoveToFirstAttribute ()=0
	When overridden in a derived class, moves to the first attribute. More...

virtual bool	MoveToNextAttribute ()=0
	When overridden in a derived class, moves to the next attribute. More...

virtual bool	MoveToElement ()=0
	When overridden in a derived class, moves to the element that contains the current attribute node. More...

virtual bool	ReadAttributeValue ()=0
	When overridden in a derived class, parses the attribute value into one or more `Text`, `EntityReference`, or `EndEntity` nodes. More...

virtual bool	Read ()=0
	When overridden in a derived class, reads the next node from the stream. More...

virtual void	Close ()
	When overridden in a derived class, changes the XmlReader::get_ReadState to ReadState::Closed. More...

virtual void	Skip ()
	Skips the children of the current node. More...

virtual String	LookupNamespace (const String &prefix)=0
	When overridden in a derived class, resolves a namespace prefix in the current element's scope. More...

virtual void	ResolveEntity ()=0
	When overridden in a derived class, resolves the entity reference for `EntityReference` nodes. More...

virtual int32_t	ReadContentAsBase64 (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)
	Reads the content and returns the Base64 decoded binary bytes. More...

virtual int32_t	ReadElementContentAsBase64 (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)
	Reads the element and decodes the `Base64` content. More...

virtual int32_t	ReadContentAsBinHex (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)
	Reads the content and returns the `BinHex` decoded binary bytes. More...

virtual int32_t	ReadElementContentAsBinHex (ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)
	Reads the element and decodes the `BinHex` content. More...

virtual int32_t	ReadValueChunk (ArrayPtr< char16_t > buffer, int32_t index, int32_t count)
	Reads large streams of text embedded in an XML document. More...

virtual String	ReadString ()
	When overridden in a derived class, reads the contents of an element or text node as a string. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation. More...

virtual XmlNodeType	MoveToContent ()
	Checks whether the current node is a content (non-white space text, `CDATA`, `Element`, `EndElement`, `EntityReference`, or `EndEntity`) node. If the node is not a content node, the reader skips ahead to the next content node or end of file. It skips over nodes of the following type: `ProcessingInstruction`, `DocumentType`, `Comment`, `Whitespace`, or `SignificantWhitespace`. More...

virtual void	ReadStartElement ()
	Checks that the current node is an element and advances the reader to the next node. More...

virtual void	ReadStartElement (String name)
	Checks that the current content node is an element with the given XmlReader::get_Name value and advances the reader to the next node. More...

virtual void	ReadStartElement (String localname, String ns)
	Checks that the current content node is an element with the given XmlReader::get_LocalName and XmlReader::get_NamespaceURI values and advances the reader to the next node. More...

virtual String	ReadElementString ()
	Reads a text-only element. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation. More...

virtual String	ReadElementString (String name)
	Checks that the XmlReader::get_Name value of the element found matches the given string before reading a text-only element. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation. More...

virtual String	ReadElementString (String localname, String ns)
	Checks that the XmlReader::get_LocalName and XmlReader::get_NamespaceURI values of the element found matches the given strings before reading a text-only element. However, it is recommended to use the XmlReader::ReadElementContentAsString method instead, because it provides a more straightforward way to handle this operation. More...

virtual void	ReadEndElement ()
	Checks that the current content node is an end tag and advances the reader to the next node. More...

virtual bool	IsStartElement ()
	Calls XmlReader::MoveToContent and tests if the current content node is a start tag or empty element tag. More...

virtual bool	IsStartElement (String name)
	Calls XmlReader::MoveToContent and tests if the current content node is a start tag or empty element tag and if the XmlReader::get_Name value of the element found matches the given argument. More...

virtual bool	IsStartElement (String localname, String ns)
	Calls XmlReader::MoveToContent and tests if the current content node is a start tag or empty element tag and if the XmlReader::get_LocalName and XmlReader::get_NamespaceURI values of the element found match the given strings. More...

virtual bool	ReadToFollowing (String name)
	Reads until an element with the specified qualified name is found. More...

virtual bool	ReadToFollowing (String localName, String namespaceURI)
	Reads until an element with the specified local name and namespace URI is found. More...

virtual bool	ReadToDescendant (String name)
	Advances the XmlReader to the next descendant element with the specified qualified name. More...

virtual bool	ReadToDescendant (String localName, String namespaceURI)
	Advances the XmlReader to the next descendant element with the specified local name and namespace URI. More...

virtual bool	ReadToNextSibling (String name)
	Advances the XmlReader to the next sibling element with the specified qualified name. More...

virtual bool	ReadToNextSibling (String localName, String namespaceURI)
	Advances the XmlReader to the next sibling element with the specified local name and namespace URI. More...

virtual String	ReadInnerXml ()
	When overridden in a derived class, reads all the content, including markup, as a string. More...

virtual String	ReadOuterXml ()
	When overridden in a derived class, reads the content, including markup, representing this node and all its children. More...

virtual SharedPtr< XmlReader >	ReadSubtree ()
	Returns a new XmlReader instance that can be used to read the current node, and all its descendants. More...

void	Dispose () override
	Releases all resources used by the current instance of the XmlReader class. More...

virtual void	Dispose ()
	Does nothing. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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...

virtual int32_t	get_LineNumber ()=0
	Returns the current line number. More...

virtual int32_t	get_LinePosition ()=0
	Returns the current line position. More...

virtual bool	HasLineInfo ()=0
	Returns a value indicating whether the class can return line information. More...

virtual SharedPtr< Collections::Generic::IDictionary< String, String > >	GetNamespacesInScope (XmlNamespaceScope scope)=0
	Returns a collection of defined prefix-namespace mappings that are currently in scope. More...

virtual String	LookupNamespace (const String &prefix)=0
	Returns the namespace URI mapped to the specified prefix. More...

virtual String	LookupPrefix (const String &namespaceName)=0
	Returns the prefix that is mapped to the specified namespace URI. More...

Protected Member Functions
	XmlTextReader ()
	Initializes a new instance of the XmlTextReader. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XmlTextReader, CODEPORTING_ARGS())

	XmlTextReader (const SharedPtr< XmlNameTable > &nt)
	Initializes a new instance of the XmlTextReader class with the specified XmlNameTable. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XmlTextReader, CODEPORTING_ARGS(SharedPtr< XmlNameTable > nt))

virtual	~XmlTextReader ()

Protected Member Functions inherited from System::Xml::XmlReader
virtual void	Dispose (bool disposing)
	Optionally releases all resources used by the current instance of the XmlReader class. More...

virtual	~XmlReader ()

Additional Inherited Members
Static Public Member Functions inherited from System::Xml::XmlReader
static bool	IsName (const String &str)
	Returns a value indicating whether the string argument is a valid XML name. More...

static bool	IsNameToken (const String &str)
	Returns a value indicating whether or not the string argument is a valid XML name token. More...

static SharedPtr< XmlReader >	Create (const String &inputUri)
	Creates a new XmlReader instance with specified URI. More...

static SharedPtr< XmlReader >	Create (const String &inputUri, const SharedPtr< XmlReaderSettings > &settings)
	Creates a new XmlReader instance by using the specified URI and settings. More...

static SharedPtr< XmlReader >	Create (const String &inputUri, SharedPtr< XmlReaderSettings > settings, const SharedPtr< XmlParserContext > &inputContext)
	Creates a new XmlReader instance by using the specified URI, settings, and context information for parsing. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::Stream > &input)
	Creates a new XmlReader instance using the specified stream with default settings. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::Stream > &input, const SharedPtr< XmlReaderSettings > &settings)
	Creates a new XmlReader instance with the specified stream and settings. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::Stream > &input, SharedPtr< XmlReaderSettings > settings, const String &baseUri)
	Creates a new XmlReader instance using the specified stream, base URI, and settings. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::Stream > &input, SharedPtr< XmlReaderSettings > settings, const SharedPtr< XmlParserContext > &inputContext)
	Creates a new XmlReader instance using the specified stream, settings, and context information for parsing. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::TextReader > &input)
	Creates a new XmlReader instance by using the specified text reader. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::TextReader > &input, const SharedPtr< XmlReaderSettings > &settings)
	Creates a new XmlReader instance by using the specified text reader and settings. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::TextReader > &input, SharedPtr< XmlReaderSettings > settings, const String &baseUri)
	Creates a new XmlReader instance by using the specified text reader, settings, and base URI. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< IO::TextReader > &input, SharedPtr< XmlReaderSettings > settings, const SharedPtr< XmlParserContext > &inputContext)
	Creates a new XmlReader instance by using the specified text reader, settings, and context information for parsing. More...

static SharedPtr< XmlReader >	Create (const SharedPtr< XmlReader > &reader, SharedPtr< XmlReaderSettings > settings)
	Creates a new XmlReader instance by using the specified XML reader and settings. 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 TypeInfo &	Type ()
	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 reader that provides fast, non-cached, forward-only access to XML data.

Remarks: It is recommended to use the XmlReader class instead.

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

using System::Xml::XmlTextReader::Ptr = SharedPtr<XmlTextReader>

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

Constructor & Destructor Documentation

◆ XmlTextReader() [1/14]

System::Xml::XmlTextReader::XmlTextReader ( const SharedPtr< IO::Stream > & input )

Initializes a new instance of the XmlTextReader class with the specified stream.

Parameters

input The stream containing the XML data to read.

Exceptions

ArgumentNullException input is nullptr.

◆ XmlTextReader() [2/14]

System::Xml::XmlTextReader::XmlTextReader	(	const String &	url,
		const SharedPtr< IO::Stream > &	input
	)

Initializes a new instance of the XmlTextReader class with the specified URL and stream.

Parameters

url	The URL to use for resolving external resources. The XmlTextReader::get_BaseURI is set to this value.
input	The stream containing the XML data to read.

Exceptions

ArgumentNullException input is nullptr.

◆ XmlTextReader() [3/14]

System::Xml::XmlTextReader::XmlTextReader	(	const SharedPtr< IO::Stream > &	input,
		const SharedPtr< XmlNameTable > &	nt
	)

Initializes a new instance of the XmlTextReader class with the specified stream and XmlNameTable.

Parameters

input	The stream containing the XML data to read.
nt	The XmlNameTable to use.

Exceptions

NullReferenceException The input or nt value is nullptr.

◆ XmlTextReader() [4/14]

System::Xml::XmlTextReader::XmlTextReader	(	const String &	url,
		const SharedPtr< IO::Stream > &	input,
		const SharedPtr< XmlNameTable > &	nt
	)

Initializes a new instance of the XmlTextReader class with the specified URL, stream and XmlNameTable.

Parameters

url	The URL to use for resolving external resources. The XmlTextReader::get_BaseURI is set to this value. If `url` is `nullptr`, `BaseURI` is set to String::Empty.
input	The stream containing the XML data to read.
nt	The XmlNameTable to use.

Exceptions

NullReferenceException The input or nt value is nullptr.

◆ XmlTextReader() [5/14]

System::Xml::XmlTextReader::XmlTextReader ( const SharedPtr< IO::TextReader > & input )

Initializes a new instance of the XmlTextReader class with the specified TextReader.

Parameters

input The TextReader containing the XML data to read.

◆ XmlTextReader() [6/14]

System::Xml::XmlTextReader::XmlTextReader	(	const String &	url,
		const SharedPtr< IO::TextReader > &	input
	)

Initializes a new instance of the XmlTextReader class with the specified URL and TextReader.

Parameters

url	The URL to use for resolving external resources. The XmlTextReader::get_BaseURI is set to this value.
input	The TextReader containing the XML data to read.

◆ XmlTextReader() [7/14]

System::Xml::XmlTextReader::XmlTextReader	(	const SharedPtr< IO::TextReader > &	input,
		const SharedPtr< XmlNameTable > &	nt
	)

Initializes a new instance of the XmlTextReader class with the specified TextReader and XmlNameTable.

Parameters

input	The TextReader containing the XML data to read.
nt	The XmlNameTable to use.

Exceptions

NullReferenceException The nt value is nullptr.

◆ XmlTextReader() [8/14]

System::Xml::XmlTextReader::XmlTextReader	(	const String &	url,
		const SharedPtr< IO::TextReader > &	input,
		const SharedPtr< XmlNameTable > &	nt
	)

Initializes a new instance of the XmlTextReader class with the specified URL, TextReader and XmlNameTable.

Parameters

url	The URL to use for resolving external resources. The XmlTextReader::get_BaseURI is set to this value. If `url` is `nullptr`, `BaseURI` is set to String::Empty.
input	The TextReader containing the XML data to read.
nt	The XmlNameTable to use.

Exceptions

ArgumentNullException The nt value is nullptr.

◆ XmlTextReader() [9/14]

System::Xml::XmlTextReader::XmlTextReader	(	const SharedPtr< IO::Stream > &	xmlFragment,
		XmlNodeType	fragType,
		const SharedPtr< XmlParserContext > &	context
	)

Initializes a new instance of the XmlTextReader class with the specified stream, XmlNodeType, and XmlParserContext.

Parameters

xmlFragment	The stream containing the XML fragment to parse.
fragType	The XmlNodeType of the XML fragment. This also determines what the fragment can contain.
context	The XmlParserContext in which the `xmlFragment` is to be parsed. This includes the XmlNameTable to use, encoding, namespace scope, the current `xml:lang`, and the `xml:space` scope.

Exceptions

XmlException	`fragType` is not an Element, Attribute, or Document XmlNodeType::
ArgumentNullException	`xmlFragment` is `nullptr`.

◆ XmlTextReader() [10/14]

System::Xml::XmlTextReader::XmlTextReader	(	const String &	xmlFragment,
		XmlNodeType	fragType,
		const SharedPtr< XmlParserContext > &	context
	)

Initializes a new instance of the XmlTextReader class with the specified string, XmlNodeType, and XmlParserContext.

Parameters

xmlFragment	The string containing the XML fragment to parse.
fragType	The XmlNodeType of the XML fragment. This also determines what the fragment string can contain.
context	The XmlParserContext in which the `xmlFragment` is to be parsed. This includes the XmlNameTable to use, encoding, namespace scope, the current `xml:lang`, and the `xml:space` scope.

Exceptions

XmlException	`fragType` is not an `Element`, `Attribute`, or `DocumentXmlNodeType`.
ArgumentNullException	`xmlFragment` is `nullptr`.

◆ XmlTextReader() [11/14]

System::Xml::XmlTextReader::XmlTextReader ( const String & url )

Initializes a new instance of the XmlTextReader class with the specified file.

Parameters

url	The URL for the file containing the XML data. The XmlTextReader::get_BaseURI is set to this value.

Exceptions

FileNotFoundException	The specified file cannot be found.
DirectoryNotFoundException	Part of the filename or directory cannot be found.
InvalidOperationException	`url` is an empty string.
WebException	The remote filename cannot be resolved. An error occurred while processing the request.
UriFormatException	`url` is not a valid URI.

◆ XmlTextReader() [12/14]

System::Xml::XmlTextReader::XmlTextReader	(	const String &	url,
		const SharedPtr< XmlNameTable > &	nt
	)

Initializes a new instance of the XmlTextReader class with the specified file and XmlNameTable.

Parameters

url	The URL for the file containing the XML data to read.
nt	The XmlNameTable to use.

Exceptions

NullReferenceException	The `nt` value is `nullptr`.
FileNotFoundException	The specified file cannot be found.
DirectoryNotFoundException	Part of the filename or directory cannot be found.
InvalidOperationException	`url` is an empty string.
WebException	The remote filename cannot be resolved. An error occurred while processing the request.
UriFormatException	`url` is not a valid URI.

◆ XmlTextReader() [13/14]

System::Xml::XmlTextReader::XmlTextReader ( )

protected

Initializes a new instance of the XmlTextReader.

◆ XmlTextReader() [14/14]

System::Xml::XmlTextReader::XmlTextReader ( const SharedPtr< XmlNameTable > & nt )

protected

Initializes a new instance of the XmlTextReader class with the specified XmlNameTable.

Parameters

nt	The XmlNameTable to use.

◆ ~XmlTextReader()

virtual System::Xml::XmlTextReader::~XmlTextReader ( )

protectedvirtual

Member Function Documentation

◆ Close()

void System::Xml::XmlTextReader::Close ( )

overridevirtual

Changes the XmlReader::get_ReadState to Closed.

Reimplemented from System::Xml::XmlReader.

◆ get_AttributeCount()

int32_t System::Xml::XmlTextReader::get_AttributeCount ( )

overridevirtual

Returns the number of attributes on the current node.

Returns: The number of attributes on the current node.

Implements System::Xml::XmlReader.

◆ get_BaseURI()

String System::Xml::XmlTextReader::get_BaseURI ( )

overridevirtual

Returns the base URI of the current node.

Returns: The base URI of the current node.

Implements System::Xml::XmlReader.

◆ get_CanReadBinaryContent()

bool System::Xml::XmlTextReader::get_CanReadBinaryContent ( )

overridevirtual

Returns a value indicating whether the XmlTextReader implements the binary content read methods.

Returns: true if the binary content read methods are implemented; otherwise false. The XmlTextReader class always returns true.

Reimplemented from System::Xml::XmlReader.

◆ get_CanReadValueChunk()

bool System::Xml::XmlTextReader::get_CanReadValueChunk ( )

overridevirtual

Returns a value indicating whether the XmlTextReader implements the XmlReader::ReadValueChunk method.

Returns: true if the XmlTextReader implements the XmlReader::ReadValueChunk method; otherwise false. The XmlTextReader class always returns false.

Reimplemented from System::Xml::XmlReader.

◆ get_CanResolveEntity()

bool System::Xml::XmlTextReader::get_CanResolveEntity ( )

overridevirtual

Returns a value indicating whether this reader can parse and resolve entities.

Returns: true if the reader can parse and resolve entities; otherwise, false. The XmlTextReader class always returns true.

Reimplemented from System::Xml::XmlReader.

◆ get_Depth()

int32_t System::Xml::XmlTextReader::get_Depth ( )

overridevirtual

Returns the depth of the current node in the XML document.

Returns: The depth of the current node in the XML document.

Implements System::Xml::XmlReader.

◆ get_DtdProcessing()

System::Xml::DtdProcessing System::Xml::XmlTextReader::get_DtdProcessing ( )

Returns the DtdProcessing enumeration.

Returns: The DtdProcessing enumeration.

◆ get_Encoding()

SharedPtr< System::Text::Encoding > System::Xml::XmlTextReader::get_Encoding ( )

Returns the encoding of the document.

Returns: The encoding value. If no encoding attribute exists, and there is no byte-order mark, this defaults to UTF-8.

◆ get_EntityHandling()

System::Xml::EntityHandling System::Xml::XmlTextReader::get_EntityHandling ( )

Returns a value that specifies how the reader handles entities.

Returns: One of the EntityHandling values. If no EntityHandling is specified, it defaults to EntityHandling::ExpandCharEntities.

◆ get_EOF()

bool System::Xml::XmlTextReader::get_EOF ( )

overridevirtual

Returns a value indicating whether the reader is positioned at the end of the stream.

Returns: true if the reader is positioned at the end of the stream; otherwise, false.

Implements System::Xml::XmlReader.

◆ get_HasValue()

bool System::Xml::XmlTextReader::get_HasValue ( )

overridevirtual

Returns a value indicating whether the current node can have a XmlTextReader::get_Value other than String::Empty.

Returns: true if the node on which the reader is currently positioned can have a Value; otherwise, false.

Reimplemented from System::Xml::XmlReader.

◆ get_IsDefault()

bool System::Xml::XmlTextReader::get_IsDefault ( )

overridevirtual

Returns a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema.

Returns: This method always returns false. (XmlTextReader does not expand default attributes.)

Reimplemented from System::Xml::XmlReader.

◆ get_IsEmptyElement()

bool System::Xml::XmlTextReader::get_IsEmptyElement ( )

overridevirtual

Returns a value indicating whether the current node is an empty element (for example, <MyElement/>).

Returns: true if the current node is an element (XmlTextReader::get_NodeType value equals XmlNodeType::Element) that ends with />; otherwise, false.

Implements System::Xml::XmlReader.

◆ get_LineNumber()

int32_t System::Xml::XmlTextReader::get_LineNumber ( )

overridevirtual

Returns the current line number.

Returns: The current line number.

Implements System::Xml::IXmlLineInfo.

◆ get_LinePosition()

int32_t System::Xml::XmlTextReader::get_LinePosition ( )

overridevirtual

Returns the current line position.

Returns: The current line position.

Implements System::Xml::IXmlLineInfo.

◆ get_LocalName()

String System::Xml::XmlTextReader::get_LocalName ( )

overridevirtual

Returns the local name of the current node.

Returns: The name of the current node with the prefix removed. For example, LocalName is book for the element <bk:book>. For node types that do not have a name (like Text, Comment, and so on), this method returns String::Empty.

Implements System::Xml::XmlReader.

◆ get_Name()

String System::Xml::XmlTextReader::get_Name ( )

overridevirtual

Returns the qualified name of the current node.

Returns: The qualified name of the current node. For example, Name is bk:book for the element <bk:book>.

The name returned is dependent on the XmlTextReader::get_NodeType value of the node. The following node types return the listed values. All other node types return an empty string.

Node Type	Name
Attribute	The name of the attribute.
DocumentType	The document type name.
Element	The tag name.
EntityReference	The name of the entity referenced.
ProcessingInstruction	The target of the processing instruction.
XmlDeclaration	The literal string `xml`.

Reimplemented from System::Xml::XmlReader.

◆ get_Namespaces()

bool System::Xml::XmlTextReader::get_Namespaces ( )

Returns a value indicating whether to do namespace support.

Returns: true to do namespace support; otherwise, false. The default is true.

◆ get_NamespaceURI()

String System::Xml::XmlTextReader::get_NamespaceURI ( )

overridevirtual

Returns the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.

Returns: The namespace URI of the current node; otherwise an empty string.

Implements System::Xml::XmlReader.

◆ get_NameTable()

SharedPtr< XmlNameTable > System::Xml::XmlTextReader::get_NameTable ( )

overridevirtual

Returns the XmlNameTable associated with this implementation.

Returns: The XmlNameTable enabling you to get the atomized version of a string within the node.

Implements System::Xml::XmlReader.

◆ get_NodeType()

XmlNodeType System::Xml::XmlTextReader::get_NodeType ( )

overridevirtual

Returns the type of the current node.

Returns: One of the XmlNodeType values representing the type of the current node.

Implements System::Xml::XmlReader.

◆ get_Normalization()

bool System::Xml::XmlTextReader::get_Normalization ( )

Returns a value indicating whether to normalize white space and attribute values.

Returns: true to normalize; otherwise, false. The default is false.

◆ get_Prefix()

String System::Xml::XmlTextReader::get_Prefix ( )

overridevirtual

Returns the namespace prefix associated with the current node.

Returns: The namespace prefix associated with the current node.

Implements System::Xml::XmlReader.

◆ get_ProhibitDtd()

bool System::Xml::XmlTextReader::get_ProhibitDtd ( )

Returns a value indicating whether to allow DTD processing.

Deprecated:: This method is obsolete. Use XmlTextReader::get_DtdProcessing instead.

Returns: true to disallow DTD processing; otherwise false. The default is false.

◆ get_QuoteChar()

char16_t System::Xml::XmlTextReader::get_QuoteChar ( )

overridevirtual

Returns the quotation mark character used to enclose the value of an attribute node.

Returns: The quotation mark character (" or ') used to enclose the value of an attribute node.

Reimplemented from System::Xml::XmlReader.

◆ get_ReadState()

System::Xml::ReadState System::Xml::XmlTextReader::get_ReadState ( )

overridevirtual

Returns the state of the reader.

Returns: One of the ReadState values.

Implements System::Xml::XmlReader.

◆ get_Value()

String System::Xml::XmlTextReader::get_Value ( )

overridevirtual

Returns the text value of the current node.

Returns: The value returned depends on the XmlTextReader::get_NodeType value of the node.

The following table lists node types that have a value to return. All other node types return String::Empty.

Node Type	Value
Attribute	The value of the attribute.
CDATA	The content of the CDATA section.
Comment	The content of the comment.
DocumentType	The internal subset.
ProcessingInstruction	The entire content, excluding the target.
SignificantWhitespace	The white space within an `xml:space='preserve'` scope.
Text	The content of the text node.
Whitespace	The white space between markup.
XmlDeclaration	The content of the declaration.

Implements System::Xml::XmlReader.

◆ get_WhitespaceHandling()

System::Xml::WhitespaceHandling System::Xml::XmlTextReader::get_WhitespaceHandling ( )

Returns a value that specifies how white space is handled.

Returns: One of the WhitespaceHandling values. The default is WhitespaceHandling.All (returns Whitespace and SignificantWhitespace nodes).

Exceptions

ArgumentOutOfRangeException Invalid value specified.

◆ get_XmlLang()

String System::Xml::XmlTextReader::get_XmlLang ( )

overridevirtual

Returns the current xml:lang scope.

Returns: The current xml:lang scope.

Reimplemented from System::Xml::XmlReader.

◆ get_XmlSpace()

System::Xml::XmlSpace System::Xml::XmlTextReader::get_XmlSpace ( )

overridevirtual

Returns the current xml:space scope.

Returns: One of the XmlSpace values. If no xml:space scope exists, this value defaults to XmlSpace::None.

Reimplemented from System::Xml::XmlReader.

◆ GetAttribute() [1/3]

String System::Xml::XmlTextReader::GetAttribute ( int32_t i )

overridevirtual

Returns the value of the attribute with the specified index.

Parameters

i	The index of the attribute. The index is zero-based. (The first attribute has index 0.)

Returns: The value of the specified attribute.

Exceptions

ArgumentOutOfRangeException The i parameter is less than 0 or greater than or equal to XmlTextReader::get_AttributeCount value.

Implements System::Xml::XmlReader.

◆ GetAttribute() [2/3]

String System::Xml::XmlTextReader::GetAttribute	(	String	localName,
		String	namespaceURI
	)

overridevirtual

Returns the value of the attribute with the specified local name and namespace URI.

Parameters

localName	The local name of the attribute.
namespaceURI	The namespace URI of the attribute.

Returns: The value of the specified attribute. If the attribute is not found, nullptr is returned. This method does not move the reader.

Implements System::Xml::XmlReader.

◆ GetAttribute() [3/3]

String System::Xml::XmlTextReader::GetAttribute ( String name )

overridevirtual

Returns the value of the attribute with the specified name.

Parameters

name	The qualified name of the attribute.

Returns: The value of the specified attribute. If the attribute is not found, nullptr is returned.

Implements System::Xml::XmlReader.

◆ GetNamespacesInScope()

SharedPtr< Collections::Generic::IDictionary< String, String > > System::Xml::XmlTextReader::GetNamespacesInScope ( XmlNamespaceScope scope )

overridevirtual

Returns a collection that contains all namespaces currently in-scope.

Parameters

scope An XmlNamespaceScope value that specifies the type of namespace nodes to return.

Returns: An IDictionary object that contains all the current in-scope namespaces. If the reader is not positioned on an element, an empty dictionary (no namespaces) is returned.

Implements System::Xml::IXmlNamespaceResolver.

◆ GetRemainder()

SharedPtr< IO::TextReader > System::Xml::XmlTextReader::GetRemainder ( )

Returns the remainder of the buffered XML.

Returns: A TextReader containing the remainder of the buffered XML.

◆ HasLineInfo()

bool System::Xml::XmlTextReader::HasLineInfo ( )

overridevirtual

Returns a value indicating whether the class can return line information.

Returns: true if the class can return line information; otherwise, false.

Implements System::Xml::IXmlLineInfo.

◆ LookupNamespace()

String System::Xml::XmlTextReader::LookupNamespace ( const String & prefix )

overridevirtual

Resolves a namespace prefix in the current element's scope.

Parameters

prefix The prefix whose namespace URI you want to resolve. To match the default namespace, pass an empty string. This string does not have to be atomized.

Returns: The namespace URI to which the prefix maps or nullptr if no matching prefix is found.

Exceptions

ArgumentNullException The XmlTextReader::get_Namespaces value is set to true and the prefix value is nullptr.

Implements System::Xml::IXmlNamespaceResolver.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/2]

System::Xml::XmlTextReader::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	XmlTextReader	,
		CODEPORTING_ARGS()
	)

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/2]

System::Xml::XmlTextReader::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	XmlTextReader	,
		CODEPORTING_ARGS(SharedPtr< XmlNameTable > nt)
	)

protected

◆ MoveToAttribute() [1/3]

void System::Xml::XmlTextReader::MoveToAttribute ( int32_t i )

overridevirtual

Moves to the attribute with the specified index.

Parameters

i	The index of the attribute.

Exceptions

ArgumentOutOfRangeException The i parameter is less than 0 or greater than or equal to XmlTextReader::get_AttributeCount value.

Reimplemented from System::Xml::XmlReader.

◆ MoveToAttribute() [2/3]

bool System::Xml::XmlTextReader::MoveToAttribute	(	String	localName,
		String	namespaceURI
	)

overridevirtual

Moves to the attribute with the specified local name and namespace URI.

Parameters

localName	The local name of the attribute.
namespaceURI	The namespace URI of the attribute.

Returns: true if the attribute is found; otherwise, false. If false, the reader's position does not change.

Implements System::Xml::XmlReader.

◆ MoveToAttribute() [3/3]

bool System::Xml::XmlTextReader::MoveToAttribute ( String name )

overridevirtual

Moves to the attribute with the specified name.

Parameters

name	The qualified name of the attribute.

Returns: true if the attribute is found; otherwise, false. If false, the reader's position does not change.

Implements System::Xml::XmlReader.

◆ MoveToElement()

bool System::Xml::XmlTextReader::MoveToElement ( )

overridevirtual

Moves to the element that contains the current attribute node.

Returns: true if the reader is positioned on an attribute (the reader moves to the element that owns the attribute); false if the reader is not positioned on an attribute (the position of the reader does not change).

Implements System::Xml::XmlReader.

◆ MoveToFirstAttribute()

bool System::Xml::XmlTextReader::MoveToFirstAttribute ( )

overridevirtual

Moves to the first attribute.

Returns: true if an attribute exists (the reader moves to the first attribute); otherwise, false (the position of the reader does not change).

Implements System::Xml::XmlReader.

◆ MoveToNextAttribute()

bool System::Xml::XmlTextReader::MoveToNextAttribute ( )

overridevirtual

Moves to the next attribute.

Returns: true if there is a next attribute; false if there are no more attributes.

Implements System::Xml::XmlReader.

◆ Read()

bool System::Xml::XmlTextReader::Read ( )

overridevirtual

Reads the next node from the stream.

Returns: true if the next node was read successfully; false if there are no more nodes to read.

Exceptions

XmlException An error occurred while parsing the XML.

Implements System::Xml::XmlReader.

◆ ReadAttributeValue()

bool System::Xml::XmlTextReader::ReadAttributeValue ( )

overridevirtual

Parses the attribute value into one or more Text, EntityReference, or EndEntity nodes.

Returns: true if there are nodes to return. false if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read. An empty attribute, such as, misc="", returns true with a single node with a value of String::Empty.

Implements System::Xml::XmlReader.

◆ ReadBase64()

int32_t System::Xml::XmlTextReader::ReadBase64	(	const ArrayPtr< uint8_t > &	array,
		int32_t	offset,
		int32_t	len
	)

Decodes Base64 and returns the decoded binary bytes.

Parameters

array	The array of characters that serves as the buffer to which the text contents are written.
offset	The zero-based index into the array specifying where the method can begin to write to the buffer.
len	The number of bytes to write into the buffer.

Returns: The number of bytes written to the buffer.

Exceptions

XmlException	The Base64 sequence is not valid.
ArgumentNullException	The value of `array` is `nullptr`.
ArgumentOutOfRangeException	`offset` < 0, or `len` < 0, or `len` > `array.get_Length` - `offset`.

◆ ReadBinHex()

int32_t System::Xml::XmlTextReader::ReadBinHex	(	const ArrayPtr< uint8_t > &	array,
		int32_t	offset,
		int32_t	len
	)

Decodes BinHex and returns the decoded binary bytes.

Parameters

array	The byte array that serves as the buffer to which the decoded binary bytes are written.
offset	The zero-based index into the array specifying where the method can begin to write to the buffer.
len	The number of bytes to write into the buffer.

Returns: The number of bytes written to your buffer.

Exceptions

XmlException	The `BinHex` sequence is not valid.
ArgumentNullException	The value of `array` is `nullptr`.
ArgumentOutOfRangeException	`offset` < 0, or `len` < 0, or `len` > `array.get_Length` - `offset`.

◆ ReadChars()

int32_t System::Xml::XmlTextReader::ReadChars	(	const ArrayPtr< char16_t > &	buffer,
		int32_t	index,
		int32_t	count
	)

Reads the text contents of an element into a character buffer. This method is designed to read large streams of embedded text by calling it successively.

Parameters

buffer	The array of characters that serves as the buffer to which the text contents are written.
index	The position within `buffer` where the method can begin writing text contents.
count	The number of characters to write into `buffer`.

Returns: The number of characters read. This can be 0 if the reader is not positioned on an element or if there is no more text content to return in the current context.

Exceptions

ArgumentException	`count` is greater than the space specified in the `buffer` (buffer size - `index`).
ArgumentNullException	The `buffer` value is `nullptr`.
ArgumentOutOfRangeException	`index` < 0 or `count` < 0.

◆ ReadContentAsBase64()

int32_t System::Xml::XmlTextReader::ReadContentAsBase64	(	ArrayPtr< uint8_t >	buffer,
		int32_t	index,
		int32_t	count
	)

overridevirtual

Reads the content and returns the Base64 decoded binary bytes.

Parameters

buffer	The buffer into which to copy the resulting text. This value cannot be `nullptr`.
index	The offset into the buffer where to start copying the result.
count	The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Returns: The number of bytes written to the buffer.

Exceptions

ArgumentNullException	The `buffer` value is `nullptr`.
InvalidOperationException	The call is not supported in the current node.
ArgumentOutOfRangeException	The index into the buffer or index + count is larger than the allocated buffer size.

Reimplemented from System::Xml::XmlReader.

◆ ReadContentAsBinHex()

int32_t System::Xml::XmlTextReader::ReadContentAsBinHex	(	ArrayPtr< uint8_t >	buffer,
		int32_t	index,
		int32_t	count
	)

overridevirtual

Reads the content and returns the BinHex decoded binary bytes.

Parameters

buffer	The buffer into which to copy the resulting text. This value cannot be `nullptr`.
index	The offset into the buffer where to start copying the result.
count	The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Returns: The number of bytes written to the buffer.

Exceptions

ArgumentNullException	The `buffer` value is `nullptr`.
InvalidOperationException	The call is not supported on the current node.
ArgumentOutOfRangeException	The index into the buffer or index + count is larger than the allocated buffer size.
NotSupportedException	The XmlTextReader implementation does not support this method.

Reimplemented from System::Xml::XmlReader.

◆ ReadElementContentAsBase64()

int32_t System::Xml::XmlTextReader::ReadElementContentAsBase64	(	ArrayPtr< uint8_t >	buffer,
		int32_t	index,
		int32_t	count
	)

overridevirtual

Reads the element and decodes the Base64 content.

Parameters

buffer	The buffer into which to copy the resulting text. This value cannot be `nullptr`.
index	The offset into the buffer where to start copying the result.
count	The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Returns: The number of bytes written to the buffer.

Exceptions

ArgumentNullException	The `buffer` value is `nullptr`.
InvalidOperationException	The current node is not an element node.
ArgumentOutOfRangeException	The index into the buffer or index + count is larger than the allocated buffer size.
NotSupportedException	The XmlTextReader implementation does not support this method.
XmlException	The element contains mixed-content.
FormatException	The content cannot be converted to the requested type.

Reimplemented from System::Xml::XmlReader.

◆ ReadElementContentAsBinHex()

int32_t System::Xml::XmlTextReader::ReadElementContentAsBinHex	(	ArrayPtr< uint8_t >	buffer,
		int32_t	index,
		int32_t	count
	)

overridevirtual

Reads the element and decodes the BinHex content.

Parameters

buffer	The buffer into which to copy the resulting text. This value cannot be `nullptr`.
index	The offset into the buffer where to start copying the result.
count	The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Returns: The number of bytes written to the buffer.

Exceptions

ArgumentNullException	The `buffer` value is `nullptr`.
InvalidOperationException	The current node is not an element node.
ArgumentOutOfRangeException	The index into the buffer or index + count is larger than the allocated buffer size.
NotSupportedException	The XmlReader implementation does not support this method.
XmlException	The element contains mixed-content.
FormatException	The content cannot be converted to the requested type.

Reimplemented from System::Xml::XmlReader.

◆ ReadString()

String System::Xml::XmlTextReader::ReadString ( )

overridevirtual

Reads the contents of an element or a text node as a string.

Returns: The contents of the element or text node. This can be an empty string if the reader is positioned on something other than an element or text node, or if there is no more text content to return in the current context. Note: The text node can be either an element or an attribute text node.

Exceptions

XmlException	An error occurred while parsing the XML.
InvalidOperationException	An invalid operation was attempted.

Reimplemented from System::Xml::XmlReader.

◆ ResetState()

void System::Xml::XmlTextReader::ResetState ( )

Resets the state of the reader to ReadState::Initial.

Exceptions

InvalidOperationException	Calling `ResetState` if the reader was constructed using an XmlParserContext.
XmlException	Documents in a single stream do not share the same encoding.

◆ ResolveEntity()

void System::Xml::XmlTextReader::ResolveEntity ( )

overridevirtual

Resolves the entity reference for EntityReference nodes.

Implements System::Xml::XmlReader.

◆ set_DtdProcessing()

void System::Xml::XmlTextReader::set_DtdProcessing ( System::Xml::DtdProcessing value )

Sets the DtdProcessing enumeration.

Parameters

value The value to set.

◆ set_EntityHandling()

void System::Xml::XmlTextReader::set_EntityHandling ( System::Xml::EntityHandling value )

Sets a value that specifies how the reader handles entities.

Parameters

value The value to set.

◆ set_Namespaces()

void System::Xml::XmlTextReader::set_Namespaces ( bool value )

Sets a value indicating whether to do namespace support.

Parameters

value The value to set.

Exceptions

InvalidOperationException Setting this value after a read operation has occurred (XmlTextReader::get_ReadState is not ReadState::Initial).

◆ set_Normalization()

void System::Xml::XmlTextReader::set_Normalization ( bool value )

Sets a value indicating whether to normalize white space and attribute values.

Parameters

value The value to set.

Exceptions

InvalidOperationException Setting this value when the reader is closed (XmlTextReader::get_ReadState is ReadState::Closed).

◆ set_ProhibitDtd()

void System::Xml::XmlTextReader::set_ProhibitDtd ( bool value )

Sets a value indicating whether to allow DTD processing.

Deprecated:: This method is obsolete. Use XmlTextReader::set_DtdProcessing instead.

Parameters

value The value to set.

◆ set_WhitespaceHandling()

void System::Xml::XmlTextReader::set_WhitespaceHandling ( System::Xml::WhitespaceHandling value )

Sets a value that specifies how white space is handled.

Parameters

value The value to set.

Exceptions

ArgumentOutOfRangeException	Invalid value specified.
InvalidOperationException	Setting this value when the reader is closed (XmlTextReader::get_ReadState is ReadState::Closed).

◆ set_XmlResolver()

void System::Xml::XmlTextReader::set_XmlResolver ( const SharedPtr< System::Xml::XmlResolver > & value )

Sets the XmlResolver used for resolving DTD references.

Parameters

value The value to set.

◆ Skip()

void System::Xml::XmlTextReader::Skip ( )

overridevirtual

Skips the children of the current node.

Reimplemented from System::Xml::XmlReader.

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ XmlTextReader() [1/14]

◆ XmlTextReader() [2/14]

◆ XmlTextReader() [3/14]

◆ XmlTextReader() [4/14]

◆ XmlTextReader() [5/14]

◆ XmlTextReader() [6/14]

◆ XmlTextReader() [7/14]

◆ XmlTextReader() [8/14]

◆ XmlTextReader() [9/14]

◆ XmlTextReader() [10/14]

◆ XmlTextReader() [11/14]

◆ XmlTextReader() [12/14]

◆ XmlTextReader() [13/14]

◆ XmlTextReader() [14/14]

◆ ~XmlTextReader()

Member Function Documentation

◆ Close()

◆ get_AttributeCount()

◆ get_BaseURI()

◆ get_CanReadBinaryContent()

◆ get_CanReadValueChunk()

◆ get_CanResolveEntity()

◆ get_Depth()

◆ get_DtdProcessing()

◆ get_Encoding()

◆ get_EntityHandling()

◆ get_EOF()

◆ get_HasValue()

◆ get_IsDefault()

◆ get_IsEmptyElement()

◆ get_LineNumber()

◆ get_LinePosition()

◆ get_LocalName()

◆ get_Name()

◆ get_Namespaces()

◆ get_NamespaceURI()

◆ get_NameTable()

◆ get_NodeType()

◆ get_Normalization()

◆ get_Prefix()

◆ get_ProhibitDtd()

◆ get_QuoteChar()

◆ get_ReadState()

◆ get_Value()

◆ get_WhitespaceHandling()

◆ get_XmlLang()

◆ get_XmlSpace()

◆ GetAttribute() [1/3]

◆ GetAttribute() [2/3]

◆ GetAttribute() [3/3]

◆ GetNamespacesInScope()

◆ GetRemainder()

◆ HasLineInfo()

◆ LookupNamespace()

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/2]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/2]

◆ MoveToAttribute() [1/3]

◆ MoveToAttribute() [2/3]

◆ MoveToAttribute() [3/3]

◆ MoveToElement()

◆ MoveToFirstAttribute()

◆ MoveToNextAttribute()

◆ Read()

◆ ReadAttributeValue()

◆ ReadBase64()

◆ ReadBinHex()

◆ ReadChars()

◆ ReadContentAsBase64()

◆ ReadContentAsBinHex()

◆ ReadElementContentAsBase64()

◆ ReadElementContentAsBinHex()

◆ ReadString()