XmlValidatingReader Class

Definition

Caution

Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead. https://go.microsoft.com/fwlink/?linkid=14202

Caution

XmlValidatingReader has been deprecated. Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead.

Caution

Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead. http://go.microsoft.com/fwlink/?linkid=14202

Represents a reader that provides document type definition (DTD), XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) validation.

This class is obsolete. Starting with the .NET Framework 2.0, we recommend that you use the XmlReaderSettings class and the Create method to create a validating XML reader.

[System.Obsolete("Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead. https://go.microsoft.com/fwlink/?linkid=14202")]
public class XmlValidatingReader : System.Xml.XmlReader, System.Xml.IXmlLineInfo, System.Xml.IXmlNamespaceResolver
[System.Obsolete("XmlValidatingReader has been deprecated. Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead.")]
public class XmlValidatingReader : System.Xml.XmlReader, System.Xml.IXmlLineInfo, System.Xml.IXmlNamespaceResolver
[System.Obsolete("Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead. http://go.microsoft.com/fwlink/?linkid=14202")]
public class XmlValidatingReader : System.Xml.XmlReader, System.Xml.IXmlLineInfo, System.Xml.IXmlNamespaceResolver
public class XmlValidatingReader : System.Xml.XmlReader, System.Xml.IXmlLineInfo
Inheritance
XmlValidatingReader
Attributes
Implements

Remarks

XmlValidatingReader implements the XmlReader class and provides support for data validation. Use the Schemas property to have the reader validate by using schema files that are cached in an XmlSchemaCollection. The ValidationType property specifies what type of validation the reader should perform. Setting the property to ValidationType.None creates a non-validating reader.

XmlValidatingReader throws an XmlException on XML parse errors. After an exception is thrown the state of the reader is not predictable. For example, the reported node type may be different than the actual node type of the current node. Use the ReadState property to check whether a reader is in error state.

Note

The XmlValidatingReader class is obsolete in .NET Framework 2.0. You can create a validating XmlReader instance by using the XmlReaderSettings class and the Create method. For more information, see the Remarks section of the XmlReader reference page.

Notes to Inheritors

This class has an inheritance demand. Full trust is required to inherit from XmlValidatingReader.

Constructors

XmlValidatingReader(Stream, XmlNodeType, XmlParserContext)

Initializes a new instance of the XmlValidatingReader class with the specified values.

XmlValidatingReader(String, XmlNodeType, XmlParserContext)

Initializes a new instance of the XmlValidatingReader class with the specified values.

XmlValidatingReader(XmlReader)

Initializes a new instance of the XmlValidatingReader class that validates the content returned from the given XmlReader.

Properties

AttributeCount

Gets the number of attributes on the current node.

BaseURI

Gets the base URI of the current node.

CanReadBinaryContent

Gets a value indicating whether the XmlValidatingReader implements the binary content read methods.

CanReadBinaryContent

Gets a value indicating whether the XmlReader implements the binary content read methods.

(Inherited from XmlReader)
CanReadValueChunk

Gets a value indicating whether the XmlReader implements the ReadValueChunk(Char[], Int32, Int32) method.

(Inherited from XmlReader)
CanResolveEntity

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

Depth

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

Encoding

Gets the encoding attribute for the document.

EntityHandling

Gets or sets a value that specifies how the reader handles entities.

EOF

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

HasAttributes

Gets a value indicating whether the current node has any attributes.

(Inherited from XmlReader)
HasValue

Gets a value indicating whether the current node can have a Value other than String.Empty.

IsDefault

Gets a value indicating whether the current node is an attribute that was generated from the default value defined in the document type definition (DTD) or schema.

IsEmptyElement

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

Item[Int32]

Gets the value of the attribute with the specified index.

Item[Int32]

When overridden in a derived class, gets the value of the attribute with the specified index.

(Inherited from XmlReader)
Item[String, String]

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

Item[String, String]

When overridden in a derived class, gets the value of the attribute with the specified LocalName and NamespaceURI.

(Inherited from XmlReader)
Item[String]

Gets the value of the attribute with the specified name.

Item[String]

When overridden in a derived class, gets the value of the attribute with the specified Name.

(Inherited from XmlReader)
LineNumber

Gets the current line number.

LinePosition

Gets the current line position.

LocalName

Gets the local name of the current node.

Name

Gets the qualified name of the current node.

Namespaces

Gets or sets a value indicating whether to do namespace support.

NamespaceURI

Gets the namespace Uniform Resource Identifier (URI) (as defined in the World Wide Web Consortium (W3C) Namespace specification) of the node on which the reader is positioned.

NameTable

Gets the XmlNameTable associated with this implementation.

NodeType

Gets the type of the current node.

Prefix

Gets the namespace prefix associated with the current node.

QuoteChar

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

Reader

Gets the XmlReader used to construct this XmlValidatingReader.

ReadState

Gets the state of the reader.

SchemaInfo

Gets the schema information that has been assigned to the current node as a result of schema validation.

(Inherited from XmlReader)
Schemas

Gets a XmlSchemaCollection to use for validation.

SchemaType

Gets a schema type object.

Settings

Gets the XmlReaderSettings object that was used to create this XmlValidatingReader instance.

Settings

Gets the XmlReaderSettings object used to create this XmlReader instance.

(Inherited from XmlReader)
ValidationType

Gets or sets a value indicating the type of validation to perform.

Value

Gets the text value of the current node.

ValueType

Gets The Common Language Runtime (CLR) type for the current node.

(Inherited from XmlReader)
XmlLang

Gets the current xml:lang scope.

XmlResolver

Sets the XmlResolver used for resolving external document type definition (DTD) and schema location references. The XmlResolver is also used to handle any import or include elements found in XML Schema definition language (XSD) schemas.

XmlSpace

Gets the current xml:space scope.

Methods

Close()

Changes the ReadState to Closed.

Dispose()

Releases all resources used by the current instance of the XmlReader class.

(Inherited from XmlReader)
Dispose(Boolean)

Releases the unmanaged resources used by the XmlReader and optionally releases the managed resources.

(Inherited from XmlReader)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetAttribute(Int32)

Gets the value of the attribute with the specified index.

GetAttribute(String, String)

Gets the value of the attribute with the specified local name and namespace Uniform Resource Identifier (URI).

GetAttribute(String)

Gets the value of the attribute with the specified name.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetValueAsync()

Asynchronously gets the value of the current node.

(Inherited from XmlReader)
HasLineInfo()

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

IsStartElement()

Calls MoveToContent() and tests if the current content node is a start tag or empty element tag.

(Inherited from XmlReader)
IsStartElement(String, String)

Calls MoveToContent() and tests if the current content node is a start tag or empty element tag and if the LocalName and NamespaceURI properties of the element found match the given strings.

(Inherited from XmlReader)
IsStartElement(String)

Calls MoveToContent() and tests if the current content node is a start tag or empty element tag and if the Name property of the element found matches the given argument.

(Inherited from XmlReader)
LookupNamespace(String)

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

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MoveToAttribute(Int32)

Moves to the attribute with the specified index.

MoveToAttribute(String, String)

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

MoveToAttribute(String)

Moves to the attribute with the specified name.

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.

(Inherited from XmlReader)
MoveToContentAsync()

Asynchronously checks whether the current node is a content node. If the node is not a content node, the reader skips ahead to the next content node or end of file.

(Inherited from XmlReader)
MoveToElement()

Moves to the element that contains the current attribute node.

MoveToFirstAttribute()

Moves to the first attribute.

MoveToNextAttribute()

Moves to the next attribute.

Read()

Reads the next node from the stream.

ReadAsync()

Asynchronously reads the next node from the stream.

(Inherited from XmlReader)
ReadAttributeValue()

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

ReadContentAs(Type, IXmlNamespaceResolver)

Reads the content as an object of the type specified.

(Inherited from XmlReader)
ReadContentAsAsync(Type, IXmlNamespaceResolver)

Asynchronously reads the content as an object of the type specified.

(Inherited from XmlReader)
ReadContentAsBase64(Byte[], Int32, Int32)

Reads the content and returns the Base64 decoded binary bytes.

ReadContentAsBase64(Byte[], Int32, Int32)

Reads the content and returns the Base64 decoded binary bytes.

(Inherited from XmlReader)
ReadContentAsBase64Async(Byte[], Int32, Int32)

Asynchronously reads the content and returns the Base64 decoded binary bytes.

(Inherited from XmlReader)
ReadContentAsBinHex(Byte[], Int32, Int32)

Reads the content and returns the BinHex decoded binary bytes.

ReadContentAsBinHex(Byte[], Int32, Int32)

Reads the content and returns the BinHex decoded binary bytes.

(Inherited from XmlReader)
ReadContentAsBinHexAsync(Byte[], Int32, Int32)

Asynchronously reads the content and returns the BinHex decoded binary bytes.

(Inherited from XmlReader)
ReadContentAsBoolean()

Reads the text content at the current position as a Boolean.

(Inherited from XmlReader)
ReadContentAsDateTime()

Reads the text content at the current position as a DateTime object.

(Inherited from XmlReader)
ReadContentAsDateTimeOffset()

Reads the text content at the current position as a DateTimeOffset object.

(Inherited from XmlReader)
ReadContentAsDecimal()

Reads the text content at the current position as a Decimal object.

(Inherited from XmlReader)
ReadContentAsDouble()

Reads the text content at the current position as a double-precision floating-point number.

(Inherited from XmlReader)
ReadContentAsFloat()

Reads the text content at the current position as a single-precision floating point number.

(Inherited from XmlReader)
ReadContentAsInt()

Reads the text content at the current position as a 32-bit signed integer.

(Inherited from XmlReader)
ReadContentAsLong()

Reads the text content at the current position as a 64-bit signed integer.

(Inherited from XmlReader)
ReadContentAsObject()

Reads the text content at the current position as an Object.

(Inherited from XmlReader)
ReadContentAsObjectAsync()

Asynchronously reads the text content at the current position as an Object.

(Inherited from XmlReader)
ReadContentAsString()

Reads the text content at the current position as a String object.

(Inherited from XmlReader)
ReadContentAsStringAsync()

Asynchronously reads the text content at the current position as a String object.

(Inherited from XmlReader)
ReadElementContentAs(Type, IXmlNamespaceResolver, String, String)

Checks that the specified local name and namespace URI matches that of the current element, then reads the element content as the requested type.

(Inherited from XmlReader)
ReadElementContentAs(Type, IXmlNamespaceResolver)

Reads the element content as the requested type.

(Inherited from XmlReader)
ReadElementContentAsAsync(Type, IXmlNamespaceResolver)

Asynchronously reads the element content as the requested type.

(Inherited from XmlReader)
ReadElementContentAsBase64(Byte[], Int32, Int32)

Reads the element and decodes the Base64 content.

ReadElementContentAsBase64(Byte[], Int32, Int32)

Reads the element and decodes the Base64 content.

(Inherited from XmlReader)
ReadElementContentAsBase64Async(Byte[], Int32, Int32)

Asynchronously reads the element and decodes the Base64 content.

(Inherited from XmlReader)
ReadElementContentAsBinHex(Byte[], Int32, Int32)

Reads the element and decodes the BinHex content.

ReadElementContentAsBinHex(Byte[], Int32, Int32)

Reads the element and decodes the BinHex content.

(Inherited from XmlReader)
ReadElementContentAsBinHexAsync(Byte[], Int32, Int32)

Asynchronously reads the element and decodes the BinHex content.

(Inherited from XmlReader)
ReadElementContentAsBoolean()

Reads the current element and returns the contents as a Boolean object.

(Inherited from XmlReader)
ReadElementContentAsBoolean(String, String)

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.

(Inherited from XmlReader)
ReadElementContentAsDateTime()

Reads the current element and returns the contents as a DateTime object.

(Inherited from XmlReader)
ReadElementContentAsDateTime(String, String)

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.

(Inherited from XmlReader)
ReadElementContentAsDecimal()

Reads the current element and returns the contents as a Decimal object.

(Inherited from XmlReader)
ReadElementContentAsDecimal(String, String)

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.

(Inherited from XmlReader)
ReadElementContentAsDouble()

Reads the current element and returns the contents as a double-precision floating-point number.

(Inherited from XmlReader)
ReadElementContentAsDouble(String, String)

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.

(Inherited from XmlReader)
ReadElementContentAsFloat()

Reads the current element and returns the contents as single-precision floating-point number.

(Inherited from XmlReader)
ReadElementContentAsFloat(String, String)

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.

(Inherited from XmlReader)
ReadElementContentAsInt()

Reads the current element and returns the contents as a 32-bit signed integer.

(Inherited from XmlReader)
ReadElementContentAsInt(String, String)

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.

(Inherited from XmlReader)
ReadElementContentAsLong()

Reads the current element and returns the contents as a 64-bit signed integer.

(Inherited from XmlReader)
ReadElementContentAsLong(String, String)

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.

(Inherited from XmlReader)
ReadElementContentAsObject()

Reads the current element and returns the contents as an Object.

(Inherited from XmlReader)
ReadElementContentAsObject(String, String)

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.

(Inherited from XmlReader)
ReadElementContentAsObjectAsync()

Asynchronously reads the current element and returns the contents as an Object.

(Inherited from XmlReader)
ReadElementContentAsString()

Reads the current element and returns the contents as a String object.

(Inherited from XmlReader)
ReadElementContentAsString(String, String)

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.

(Inherited from XmlReader)
ReadElementContentAsStringAsync()

Asynchronously reads the current element and returns the contents as a String object.

(Inherited from XmlReader)
ReadElementString()

Reads a text-only element. However, we recommend that you use the ReadElementContentAsString() method instead, because it provides a more straightforward way to handle this operation.

(Inherited from XmlReader)
ReadElementString(String, String)

Checks that the LocalName and NamespaceURI properties of the element found matches the given strings before reading a text-only element. However, we recommend that you use the ReadElementContentAsString(String, String) method instead, because it provides a more straightforward way to handle this operation.

(Inherited from XmlReader)
ReadElementString(String)

Checks that the Name property of the element found matches the given string before reading a text-only element. However, we recommend that you use the ReadElementContentAsString() method instead, because it provides a more straightforward way to handle this operation.

(Inherited from XmlReader)
ReadEndElement()

Checks that the current content node is an end tag and advances the reader to the next node.

(Inherited from XmlReader)
ReadInnerXml()

When overridden in a derived class, reads all the content, including markup, as a string.

(Inherited from XmlReader)
ReadInnerXmlAsync()

Asynchronously reads all the content, including markup, as a string.

(Inherited from XmlReader)
ReadOuterXml()

When overridden in a derived class, reads the content, including markup, representing this node and all its children.

(Inherited from XmlReader)
ReadOuterXmlAsync()

Asynchronously reads the content, including markup, representing this node and all its children.

(Inherited from XmlReader)
ReadStartElement()

Checks that the current node is an element and advances the reader to the next node.

(Inherited from XmlReader)
ReadStartElement(String, String)

Checks that the current content node is an element with the given LocalName and NamespaceURI and advances the reader to the next node.

(Inherited from XmlReader)
ReadStartElement(String)

Checks that the current content node is an element with the given Name and advances the reader to the next node.

(Inherited from XmlReader)
ReadString()

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

ReadSubtree()

Returns a new XmlReader instance that can be used to read the current node, and all its descendants.

(Inherited from XmlReader)
ReadToDescendant(String, String)

Advances the XmlReader to the next descendant element with the specified local name and namespace URI.

(Inherited from XmlReader)
ReadToDescendant(String)

Advances the XmlReader to the next descendant element with the specified qualified name.

(Inherited from XmlReader)
ReadToFollowing(String, String)

Reads until an element with the specified local name and namespace URI is found.

(Inherited from XmlReader)
ReadToFollowing(String)

Reads until an element with the specified qualified name is found.

(Inherited from XmlReader)
ReadToNextSibling(String, String)

Advances the XmlReader to the next sibling element with the specified local name and namespace URI.

(Inherited from XmlReader)
ReadToNextSibling(String)

Advances the XmlReader to the next sibling element with the specified qualified name.

(Inherited from XmlReader)
ReadTypedValue()

Gets the common language runtime type for the specified XML Schema definition language (XSD) type.

ReadValueChunk(Char[], Int32, Int32)

Reads large streams of text embedded in an XML document.

(Inherited from XmlReader)
ReadValueChunkAsync(Char[], Int32, Int32)

Asynchronously reads large streams of text embedded in an XML document.

(Inherited from XmlReader)
ResolveEntity()

Resolves the entity reference for EntityReference nodes.

Skip()

Skips the children of the current node.

(Inherited from XmlReader)
SkipAsync()

Asynchronously skips the children of the current node.

(Inherited from XmlReader)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Events

ValidationEventHandler

Sets an event handler for receiving information about document type definition (DTD), XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) schema validation errors.

Explicit Interface Implementations

IDisposable.Dispose()

For a description of this member, see Dispose().

(Inherited from XmlReader)
IXmlLineInfo.HasLineInfo()

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

IXmlNamespaceResolver.GetNamespacesInScope(XmlNamespaceScope)

For a description of this member, see GetNamespacesInScope(XmlNamespaceScope).

IXmlNamespaceResolver.LookupNamespace(String)

For a description of this member, see LookupNamespace(String).

IXmlNamespaceResolver.LookupPrefix(String)

For a description of this member, see LookupPrefix(String).

Applies to

Product Versions (Obsolete)
.NET (Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9)
.NET Framework 1.1 (2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1)
.NET Standard (2.0, 2.1)

See also