System::Xml::XmlTextReader class

XmlTextReader class

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

class XmlTextReader : public System::Xml::XmlReader,
                      public System::Xml::IXmlLineInfo,
                      public System::Xml::IXmlNamespaceResolver

Methods

MethodDescription
Close() overrideChanges the XmlReader::get_ReadState to Closed.
get_AttributeCount() overrideReturns the number of attributes on the current node.
get_BaseURI() overrideReturns the base URI of the current node.
get_CanReadBinaryContent() overrideReturns a value indicating whether the XmlTextReader implements the binary content read methods.
get_CanReadValueChunk() overrideReturns a value indicating whether the XmlTextReader implements the XmlReader::ReadValueChunk method.
get_CanResolveEntity() overrideReturns a value indicating whether this reader can parse and resolve entities.
get_Depth() overrideReturns the depth of the current node in the XML document.
get_DtdProcessing()Returns the DtdProcessing enumeration.
get_Encoding()Returns the encoding of the document.
get_EntityHandling()Returns a value that specifies how the reader handles entities.
get_EOF() overrideReturns a value indicating whether the reader is positioned at the end of the stream.
get_HasValue() overrideReturns a value indicating whether the current node can have a XmlTextReader::get_Value other than String::Empty.
get_IsDefault() overrideReturns a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema.
get_IsEmptyElement() overrideReturns a value indicating whether the current node is an empty element (for example, ).
get_LineNumber() overrideReturns the current line number.
get_LinePosition() overrideReturns the current line position.
get_LocalName() overrideReturns the local name of the current node.
get_Name() overrideReturns the qualified name of the current node.
get_Namespaces()Returns a value indicating whether to do namespace support.
get_NamespaceURI() overrideReturns the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.
get_NameTable() overrideReturns the XmlNameTable associated with this implementation.
get_NodeType() overrideReturns the type of the current node.
get_Normalization()Returns a value indicating whether to normalize white space and attribute values.
get_Prefix() overrideReturns the namespace prefix associated with the current node.
get_ProhibitDtd()Returns a value indicating whether to allow DTD processing.
get_QuoteChar() overrideReturns the quotation mark character used to enclose the value of an attribute node.
get_ReadState() overrideReturns the state of the reader.
get_Value() overrideReturns the text value of the current node.
get_WhitespaceHandling()Returns a value that specifies how white space is handled.
get_XmlLang() overrideReturns the current xml:lang scope.
get_XmlSpace() overrideReturns the current xml:space scope.
GetAttribute(String) overrideReturns the value of the attribute with the specified name.
GetAttribute(String, String) overrideReturns the value of the attribute with the specified local name and namespace URI.
GetAttribute(int32_t) overrideReturns the value of the attribute with the specified index.
GetNamespacesInScope(XmlNamespaceScope) overrideReturns a collection that contains all namespaces currently in-scope.
GetRemainder()Returns the remainder of the buffered XML.
HasLineInfo() overrideReturns a value indicating whether the class can return line information.
LookupNamespace(const String&) overrideResolves a namespace prefix in the current element’s scope.
MoveToAttribute(String) overrideMoves to the attribute with the specified name.
MoveToAttribute(String, String) overrideMoves to the attribute with the specified local name and namespace URI.
MoveToAttribute(int32_t) overrideMoves to the attribute with the specified index.
MoveToElement() overrideMoves to the element that contains the current attribute node.
MoveToFirstAttribute() overrideMoves to the first attribute.
MoveToNextAttribute() overrideMoves to the next attribute.
Read() overrideReads the next node from the stream.
ReadAttributeValue() overrideParses the attribute value into one or more Text, EntityReference, or EndEntity nodes.
ReadBase64(const ArrayPtr<uint8_t>&, int32_t, int32_t)Decodes Base64 and returns the decoded binary bytes.
ReadBinHex(const ArrayPtr<uint8_t>&, int32_t, int32_t)Decodes BinHex and returns the decoded binary bytes.
ReadChars(const ArrayPtr<char16_t>&, int32_t, int32_t)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.
ReadContentAsBase64(ArrayPtr<uint8_t>, int32_t, int32_t) overrideReads the content and returns the Base64 decoded binary bytes.
ReadContentAsBinHex(ArrayPtr<uint8_t>, int32_t, int32_t) overrideReads the content and returns the BinHex decoded binary bytes.
ReadElementContentAsBase64(ArrayPtr<uint8_t>, int32_t, int32_t) overrideReads the element and decodes the Base64 content.
ReadElementContentAsBinHex(ArrayPtr<uint8_t>, int32_t, int32_t) overrideReads the element and decodes the BinHex content.
ReadString() overrideReads the contents of an element or a text node as a string.
ResetState()Resets the state of the reader to ReadState::Initial.
ResolveEntity() overrideResolves the entity reference for EntityReference nodes.
set_DtdProcessing(System::Xml::DtdProcessing)Sets the DtdProcessing enumeration.
set_EntityHandling(System::Xml::EntityHandling)Sets a value that specifies how the reader handles entities.
set_Namespaces(bool)Sets a value indicating whether to do namespace support.
set_Normalization(bool)Sets a value indicating whether to normalize white space and attribute values.
set_ProhibitDtd(bool)Sets a value indicating whether to allow DTD processing.
set_WhitespaceHandling(System::Xml::WhitespaceHandling)Sets a value that specifies how white space is handled.
set_XmlResolver(const SharedPtr<System::Xml::XmlResolver>&)Sets the XmlResolver used for resolving DTD references.
Skip() overrideSkips the children of the current node.
XmlTextReader(const SharedPtr<IO::Stream>&)Initializes a new instance of the XmlTextReader class with the specified stream.
XmlTextReader(const String&, const SharedPtr<IO::Stream>&)Initializes a new instance of the XmlTextReader class with the specified URL and stream.
XmlTextReader(const SharedPtr<IO::Stream>&, const SharedPtr<XmlNameTable>&)Initializes a new instance of the XmlTextReader class with the specified stream and XmlNameTable.
XmlTextReader(const String&, const SharedPtr<IO::Stream>&, const SharedPtr<XmlNameTable>&)Initializes a new instance of the XmlTextReader class with the specified URL, stream and XmlNameTable.
XmlTextReader(const SharedPtr<IO::TextReader>&)Initializes a new instance of the XmlTextReader class with the specified TextReader.
XmlTextReader(const String&, const SharedPtr<IO::TextReader>&)Initializes a new instance of the XmlTextReader class with the specified URL and TextReader.
XmlTextReader(const SharedPtr<IO::TextReader>&, const SharedPtr<XmlNameTable>&)Initializes a new instance of the XmlTextReader class with the specified TextReader and XmlNameTable.
XmlTextReader(const String&, const SharedPtr<IO::TextReader>&, const SharedPtr<XmlNameTable>&)Initializes a new instance of the XmlTextReader class with the specified URL, TextReader and XmlNameTable.
XmlTextReader(const SharedPtr<IO::Stream>&, XmlNodeType, const SharedPtr<XmlParserContext>&)Initializes a new instance of the XmlTextReader class with the specified stream, XmlNodeType, and XmlParserContext.
XmlTextReader(const String&, XmlNodeType, const SharedPtr<XmlParserContext>&)Initializes a new instance of the XmlTextReader class with the specified string, XmlNodeType, and XmlParserContext.
XmlTextReader(const String&)Initializes a new instance of the XmlTextReader class with the specified file.
XmlTextReader(const String&, const SharedPtr<XmlNameTable>&)Initializes a new instance of the XmlTextReader class with the specified file and XmlNameTable.

Typedefs

TypedefDescription
PtrAn alias for shared pointer to an instance of this class.

Remarks

It is recommended to use the XmlReader class instead.

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.

See Also