XmlTextReader 类

定义

命名空间:: System.Xml

程序集:: netstandard.dll, System.Xml.ReaderWriter.dll

程序集:: System.Xml.ReaderWriter.dll

程序集:: System.Xml.dll

程序集:: netstandard.dll

Source:: XmlTextReader.cs

Source:: XmlTextReader.cs

Source:: XmlTextReader.cs

Source:: XmlTextReader.cs

Source:: XmlTextReader.cs

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

表示提供对 XML 数据的快速、非缓存、仅向前访问的读取器。

建议改用 XmlReader 类。

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

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

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

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

type XmlTextReader = class
    inherit XmlReader
    interface IXmlLineInfo
    interface IXmlNamespaceResolver

type XmlTextReader = class
    inherit XmlReader
    interface IXmlLineInfo

Public Class XmlTextReader
Inherits XmlReader
Implements IXmlLineInfo, IXmlNamespaceResolver

Public Class XmlTextReader
Inherits XmlReader
Implements IXmlLineInfo

继承: Object

XmlReader
XmlTextReader

实现: IXmlLineInfo IXmlNamespaceResolver

注解

注释

建议您使用XmlReader方法创建XmlReader.Create实例，以利用新功能。

XmlTextReader 提供对 XML 数据流的仅进只读访问权限。当前节点是指读取器所在的节点。读取器使用任何反映当前节点值的读取方法和属性进行推进。

此类实现 XmlReader 并符合 W3C 可扩展标记语言 (XML) 1.0 建议和 XML 中的命名空间建议。 XmlTextReader 提供以下功能：

强制实施格式正确的 XML 规则。
XmlTextReader 不提供数据验证。
检查DocumentType节点是否格式完整。 XmlTextReader 检查 DTD 是否格式良好，但不使用 DTD 进行验证。
对于NodeType是XmlNodeType.EntityReference的节点，将返回一个空的EntityReference节点（即Value属性为String.Empty）。

注释

DTD 中实体的实际声明称为 Entity 节点。在数据中引用这些节点时，它们称为 EntityReference 节点。

不展开默认属性。

由于XmlTextReader不执行数据验证所需的额外检查，它提供了一个快速的格式完整性解析器。

为了验证数据，请使用验证器 XmlReader。

若要从中 XmlDocument读取 XML 数据，请使用 XmlNodeReader。

XmlTextReader 会在发生 XML 分析错误时引发 XmlException。引发异常后，读取器的状态不可预测。例如，报告的节点类型可能与当前节点的实际节点类型不同。使用 ReadState 属性检查读取器是否处于错误状态。

安全注意事项

以下是使用 XmlTextReader 类时要考虑的事项。

由 XmlTextReader 引发的异常可能会泄露您不希望暴露给应用程序的路径信息。应用程序必须捕获异常并相应地处理它们。
默认情况下，DTD 处理处于启用状态。如果您担心拒绝服务问题或您在处理不可信的源，请禁用 DTD 处理。将 DtdProcessing 属性设置为 Prohibit 禁用 DTD 处理。

如果已启用 DTD 处理，则可以用于 ThrowingResolver 限制可以访问的资源 XmlTextReader 。还可以设计应用程序，使 XML 处理受内存和时间限制。例如，在 ASP.NET 应用程序中配置超时限制。
XML 数据可以包括对外部资源的引用，例如 DTD 文件。默认情况下，外部资源是使用 XmlUrlResolver 没有用户凭据的对象解析的。可以通过执行以下任一操作来进一步增强安全性：
- 使用限制可以访问XmlTextReader的资源ThrowingResolver。
- 不允许 XmlReader 通过设置 XmlResolver 属性为 null 来打开任何外部资源。
XML 数据可以包含大量属性、命名空间声明、嵌套元素等，这些属性需要大量时间来处理。若要限制发送到XmlTextReader的输入大小，请创建一个自定义的 IStream 实现并将其应用于XmlTextReader。
该方法 ReadValueChunk 可用于处理大型数据流。此方法一次读取少量字符，而不是为整个值分配单个字符串。
默认情况下不展开常规实体。常规实体在调用 ResolveEntity 方法时展开。

构造函数

名称	说明
XmlTextReader()	初始化的新 `XmlTextReader`实例。
XmlTextReader(Stream, XmlNameTable)	使用指定的流和 XmlTextReader.. 初始化类的新实例XmlNameTable。
XmlTextReader(Stream, XmlNodeType, XmlParserContext)	使用指定的流初始化类的新实例 XmlTextReader ， XmlNodeType以及 XmlParserContext。
XmlTextReader(Stream)	使用指定的流初始化类的新实例 XmlTextReader 。
XmlTextReader(String, Stream, XmlNameTable)	使用指定的 URL、流和 XmlTextReader. 初始化类的新实例XmlNameTable。
XmlTextReader(String, Stream)	使用指定的 URL 和流初始化类的新实例 XmlTextReader 。
XmlTextReader(String, TextReader, XmlNameTable)	使用指定的 URL 初始化类的新实例 XmlTextReader ， TextReader 并使用指定的 URL 初始化 XmlNameTable。
XmlTextReader(String, TextReader)	使用指定的 URL 和 XmlTextReader. 初始化类的新实例TextReader。
XmlTextReader(String, XmlNameTable)	使用指定的文件和 XmlTextReader. 初始化类的新实例XmlNameTable。
XmlTextReader(String, XmlNodeType, XmlParserContext)	使用指定的字符串初始化类的新实例 XmlTextReader ， XmlNodeType以及 XmlParserContext。
XmlTextReader(String)	使用指定的文件初始化类的新实例 XmlTextReader 。
XmlTextReader(TextReader, XmlNameTable)	使用指定的XmlTextReader和 TextReader. 初始化类的新实例XmlNameTable。
XmlTextReader(TextReader)	用指定的XmlTextReader值初始化类的新实例TextReader。
XmlTextReader(XmlNameTable)	用指定的XmlTextReader值初始化类的新实例XmlNameTable。

属性

名称	说明
AttributeCount	获取当前节点上的属性数。
BaseURI	获取当前节点的基 URI。
CanReadBinaryContent	获取一个值， XmlTextReader 该值指示是否实现二进制内容读取方法。
CanReadValueChunk	获取一个值，该值指示是否 XmlTextReader 实现该方法 ReadValueChunk(Char[], Int32, Int32) 。
CanResolveEntity	获取一个值，该值指示此读取器是否可以分析和解析实体。
CanResolveEntity	获取一个值，该值指示此读取器是否可以分析和解析实体。 (继承自 XmlReader)
Depth	获取 XML 文档中当前节点的深度。
DtdProcessing	获取或设置 DtdProcessing 枚举。
Encoding	获取文档的编码。
EntityHandling	获取或设置一个值，该值指定读取器如何处理实体。
EOF	获取一个值，该值指示读取器是否位于流的末尾。
HasAttributes	获取一个值，该值指示当前节点是否具有任何属性。 (继承自 XmlReader)
HasValue	获取一个值，该值指示当前节点是否可以具有 Value 其他 `String.Empty`节点。
IsDefault	获取一个值，该值指示当前节点是从 DTD 或架构中定义的默认值生成的属性。
IsEmptyElement	获取一个值，该值指示当前节点是否为空元素（例如）。 `<MyElement/>`
Item[Int32]	获取具有指定索引的属性的值。
Item[Int32]	在派生类中重写时，获取具有指定索引的属性的值。 (继承自 XmlReader)
Item[String, String]	获取具有指定本地名称和命名空间 URI 的属性的值。
Item[String, String]	在派生类中重写时，获取具有指定 LocalName 属性的值和 NamespaceURI。 (继承自 XmlReader)
Item[String]	获取具有指定名称的属性的值。
Item[String]	在派生类中重写时，获取具有指定 Name属性的值。 (继承自 XmlReader)
LineNumber	获取当前行号。
LinePosition	获取当前行位置。
LocalName	获取当前节点的本地名称。
Name	获取当前节点的限定名称。
Namespaces	获取或设置一个值，该值指示是否支持命名空间。
NamespaceURI	获取命名空间 URI (，如 W3C 命名空间规范) 读取器所在的节点所定义。
NameTable	获取 XmlNameTable 与此实现关联的值。
NodeType	获取当前节点的类型。
Normalization	获取或设置一个值，该值指示是否规范化空格和属性值。
Prefix	获取与当前节点关联的命名空间前缀。
ProhibitDtd	已过时. 已过时. 获取或设置一个值，该值指示是否允许 DTD 处理。此属性已过时。改用 DtdProcessing。
QuoteChar	获取用于将属性节点的值括起来的引号字符。
ReadState	获取读取器的状态。
SchemaInfo	获取由于架构验证而分配给当前节点的架构信息。 (继承自 XmlReader)
Settings	XmlReaderSettings获取用于创建此XmlTextReader实例的对象。
Settings	XmlReaderSettings获取用于创建此XmlReader实例的对象。 (继承自 XmlReader)
Value	获取当前节点的文本值。
ValueType	获取当前节点的公共语言运行时（CLR）类型。 (继承自 XmlReader)
WhitespaceHandling	获取或设置一个值，该值指定如何处理空格。
XmlLang	获取当前 `xml:lang` 范围。
XmlResolver	XmlResolver设置用于解析 DTD 引用的项。
XmlSpace	获取当前 `xml:space` 范围。

方法

名称	说明
Close()	将 ReadState 更改为 `Closed`.
Dispose()	释放类的 XmlReader 当前实例使用的所有资源。 (继承自 XmlReader)
Dispose(Boolean)	释放由托管资源使用 XmlReader 的非托管资源，并选择性地释放托管资源。 (继承自 XmlReader)
Equals(Object)	确定指定的对象是否等于当前对象。 (继承自 Object)
GetAttribute(Int32)	获取具有指定索引的属性的值。
GetAttribute(String, String)	获取具有指定本地名称和命名空间 URI 的属性的值。
GetAttribute(String)	获取具有指定名称的属性的值。
GetHashCode()	用作默认哈希函数。 (继承自 Object)
GetNamespacesInScope(XmlNamespaceScope)	获取一个集合，该集合包含当前范围内的所有命名空间。
GetRemainder()	获取缓冲 XML 的其余部分。
GetType()	获取当前实例的 Type。 (继承自 Object)
GetValueAsync()	异步获取当前节点的值。 (继承自 XmlReader)
HasLineInfo()	获取一个值，该值指示类是否可以返回行信息。
IsStartElement()	调用 MoveToContent() 和测试当前内容节点是否为开始标记或空元素标记。 (继承自 XmlReader)
IsStartElement(String, String)	调用MoveToContent()并测试当前内容节点是否为开始标记或空元素标记，以及找到的元素的和LocalName属性是否NamespaceURI与给定字符串匹配。 (继承自 XmlReader)
IsStartElement(String)	调用 MoveToContent() 和测试当前内容节点是否为开始标记或空元素标记，以及找到的元素的属性是否 Name 与给定参数匹配。 (继承自 XmlReader)
LookupNamespace(String)	解析当前元素作用域中的命名空间前缀。
MemberwiseClone()	创建当前 Object的浅表副本。 (继承自 Object)
MoveToAttribute(Int32)	移动到具有指定索引的属性。
MoveToAttribute(String, String)	移动到具有指定本地名称和命名空间 URI 的属性。
MoveToAttribute(String)	移动到具有指定名称的属性。
MoveToContent()	检查当前节点是否为内容（非空白文本、`CDATA`、`Element`、`EndElementEntityReference`或`EndEntity`）节点。如果节点不是内容节点，读取器将跳到下一个内容节点或文件末尾。它跳过以下类型的节点：`ProcessingInstruction`、、`DocumentType`、`CommentWhitespace`或`SignificantWhitespace`。 (继承自 XmlReader)
MoveToContentAsync()	异步检查当前节点是否为内容节点。如果节点不是内容节点，读取器将跳到下一个内容节点或文件末尾。 (继承自 XmlReader)
MoveToElement()	移动到包含当前属性节点的元素。
MoveToFirstAttribute()	移动到第一个属性。
MoveToNextAttribute()	移动到下一个属性。
Read()	从流中读取下一个节点。
ReadAsync()	从流中异步读取下一个节点。 (继承自 XmlReader)
ReadAttributeValue()	将属性值分析为一个或多个`Text`或`EntityReferenceEndEntity`节点。
ReadBase64(Byte[], Int32, Int32)	解码 Base64 并返回解码的二进制字节。
ReadBinHex(Byte[], Int32, Int32)	解码 `BinHex` 并返回解码的二进制字节。
ReadChars(Char[], Int32, Int32)	将元素的文本内容读入字符缓冲区。此方法旨在通过连续调用嵌入文本来读取大量嵌入文本。
ReadContentAs(Type, IXmlNamespaceResolver)	将内容作为指定类型的对象读取。 (继承自 XmlReader)
ReadContentAsAsync(Type, IXmlNamespaceResolver)	将内容异步读取为指定类型的对象。 (继承自 XmlReader)
ReadContentAsBase64(Byte[], Int32, Int32)	读取内容并返回解码的 `Base64` 二进制字节。
ReadContentAsBase64Async(Byte[], Int32, Int32)	异步读取内容并返回 Base64 解码的二进制字节。 (继承自 XmlReader)
ReadContentAsBinHex(Byte[], Int32, Int32)	读取内容并返回解码的 `BinHex` 二进制字节。
ReadContentAsBinHexAsync(Byte[], Int32, Int32)	异步读取内容并返回解码的 `BinHex` 二进制字节。 (继承自 XmlReader)
ReadContentAsBoolean()	将当前位置的文本内容读作一个 `Boolean`。 (继承自 XmlReader)
ReadContentAsDateTime()	将当前位置的文本内容作为对象 DateTime 读取。 (继承自 XmlReader)
ReadContentAsDateTimeOffset()	将当前位置的文本内容作为对象 DateTimeOffset 读取。 (继承自 XmlReader)
ReadContentAsDecimal()	将当前位置的文本内容作为对象 Decimal 读取。 (继承自 XmlReader)
ReadContentAsDouble()	将当前位置的文本内容作为双精度浮点数读取。 (继承自 XmlReader)
ReadContentAsFloat()	将当前位置的文本内容作为单精度浮点数读取。 (继承自 XmlReader)
ReadContentAsInt()	以 32 位带符号整数的形式读取当前位置的文本内容。 (继承自 XmlReader)
ReadContentAsLong()	以 64 位带符号整数的形式读取当前位置的文本内容。 (继承自 XmlReader)
ReadContentAsObject()	将当前位置的文本内容读作一个 Object。 (继承自 XmlReader)
ReadContentAsObjectAsync()	以异步方式读取当前位置的文本内容。Object (继承自 XmlReader)
ReadContentAsString()	将当前位置的文本内容作为对象 String 读取。 (继承自 XmlReader)
ReadContentAsStringAsync()	以对象的形式 String 异步读取当前位置的文本内容。 (继承自 XmlReader)
ReadElementContentAs(Type, IXmlNamespaceResolver, String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素的本地名称和命名空间 URI 匹配，然后将元素内容作为请求的类型读取。 (继承自 XmlReader)
ReadElementContentAs(Type, IXmlNamespaceResolver)	将元素内容读取为请求的类型。 (继承自 XmlReader)
ReadElementContentAsAsync(Type, IXmlNamespaceResolver)	以异步方式读取元素内容作为请求的类型。 (继承自 XmlReader)
ReadElementContentAsBase64(Byte[], Int32, Int32)	读取元素并解码 Base64 内容。
ReadElementContentAsBase64Async(Byte[], Int32, Int32)	异步读取元素并解码 `Base64` 内容。 (继承自 XmlReader)
ReadElementContentAsBinHex(Byte[], Int32, Int32)	读取元素并解码 `BinHex` 内容。
ReadElementContentAsBinHexAsync(Byte[], Int32, Int32)	异步读取元素并解码 `BinHex` 内容。 (继承自 XmlReader)
ReadElementContentAsBoolean()	读取当前元素，并将内容作为对象 Boolean 返回。 (继承自 XmlReader)
ReadElementContentAsBoolean(String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素的本地名称和命名空间 URI 匹配，然后读取当前元素并将内容作为 Boolean 对象返回。 (继承自 XmlReader)
ReadElementContentAsDateTime()	读取当前元素，并将内容作为对象 DateTime 返回。 (继承自 XmlReader)
ReadElementContentAsDateTime(String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素的本地名称和命名空间 URI 匹配，然后读取当前元素并将内容作为 DateTime 对象返回。 (继承自 XmlReader)
ReadElementContentAsDecimal()	读取当前元素，并将内容作为对象 Decimal 返回。 (继承自 XmlReader)
ReadElementContentAsDecimal(String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素的本地名称和命名空间 URI 匹配，然后读取当前元素并将内容作为 Decimal 对象返回。 (继承自 XmlReader)
ReadElementContentAsDouble()	读取当前元素，并将内容作为双精度浮点数返回。 (继承自 XmlReader)
ReadElementContentAsDouble(String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素的 URI 匹配，然后读取当前元素，并将内容作为双精度浮点数返回。 (继承自 XmlReader)
ReadElementContentAsFloat()	读取当前元素，并将内容作为单精度浮点数返回。 (继承自 XmlReader)
ReadElementContentAsFloat(String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素匹配，然后读取当前元素，并将内容作为单精度浮点数返回。 (继承自 XmlReader)
ReadElementContentAsInt()	读取当前元素，并将内容作为 32 位带符号整数返回。 (继承自 XmlReader)
ReadElementContentAsInt(String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素的本地名称和命名空间 URI 匹配，然后读取当前元素并将内容作为 32 位带符号整数返回。 (继承自 XmlReader)
ReadElementContentAsLong()	读取当前元素，并将内容作为 64 位带符号整数返回。 (继承自 XmlReader)
ReadElementContentAsLong(String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素的 URI 匹配，然后读取当前元素，并将内容作为 64 位带符号整数返回。 (继承自 XmlReader)
ReadElementContentAsObject()	读取当前元素，并将内容返回为 .Object (继承自 XmlReader)
ReadElementContentAsObject(String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素的本地名称和命名空间 URI 匹配，然后读取当前元素并将内容作为一个 Object返回。 (继承自 XmlReader)
ReadElementContentAsObjectAsync()	以异步方式读取当前元素，并将内容作为一个 Object返回。 (继承自 XmlReader)
ReadElementContentAsString()	读取当前元素，并将内容作为对象 String 返回。 (继承自 XmlReader)
ReadElementContentAsString(String, String)	检查指定的本地名称和命名空间 URI 是否与当前元素的本地名称和命名空间 URI 匹配，然后读取当前元素并将内容作为 String 对象返回。 (继承自 XmlReader)
ReadElementContentAsStringAsync()	异步读取当前元素，并将内容作为对象 String 返回。 (继承自 XmlReader)
ReadElementString()	读取纯文本元素。但是，我们建议改用 ReadElementContentAsString() 该方法，因为它提供了一种更直接的方法来处理此操作。 (继承自 XmlReader)
ReadElementString(String, String)	在读取纯文本元素之前，检查找到的元素和LocalName属性是否NamespaceURI与给定字符串匹配。但是，我们建议改用 ReadElementContentAsString(String, String) 该方法，因为它提供了一种更直接的方法来处理此操作。 (继承自 XmlReader)
ReadElementString(String)	在读取纯文本元素之前，检查找到的元素的属性是否 Name 与给定字符串匹配。但是，我们建议改用 ReadElementContentAsString() 该方法，因为它提供了一种更直接的方法来处理此操作。 (继承自 XmlReader)
ReadEndElement()	检查当前内容节点是否为结束标记，并将读取器前进到下一个节点。 (继承自 XmlReader)
ReadInnerXml()	在派生类中重写时，以字符串形式读取所有内容，包括标记。 (继承自 XmlReader)
ReadInnerXmlAsync()	以字符串形式异步读取所有内容，包括标记。 (继承自 XmlReader)
ReadOuterXml()	在派生类中重写时，读取内容，包括标记，表示此节点及其所有子级。 (继承自 XmlReader)
ReadOuterXmlAsync()	异步读取内容，包括标记，表示此节点及其所有子级。 (继承自 XmlReader)
ReadStartElement()	检查当前节点是否为元素，并将读取器前进到下一个节点。 (继承自 XmlReader)
ReadStartElement(String, String)	检查当前内容节点是否是具有给定 LocalName 元素的元素，并将 NamespaceURI 读取器前进到下一个节点。 (继承自 XmlReader)
ReadStartElement(String)	检查当前内容节点是否是具有给定 Name 元素的元素，并将读取器前进到下一个节点。 (继承自 XmlReader)
ReadString()	以字符串形式读取元素或文本节点的内容。
ReadString()	在派生类中重写时，将元素或文本节点的内容读取为字符串。但是，我们建议改用 ReadElementContentAsString 该方法，因为它提供了一种更直接的方法来处理此操作。 (继承自 XmlReader)
ReadSubtree()	返回可用于读取当前节点及其所有后代的新 `XmlReader` 实例。 (继承自 XmlReader)
ReadToDescendant(String, String)	使用指定的本地名称和命名空间 URI 前进 XmlReader 到下一个后代元素。 (继承自 XmlReader)
ReadToDescendant(String)	使用指定的限定名称前进 XmlReader 到下一个后代元素。 (继承自 XmlReader)
ReadToFollowing(String, String)	读取，直到找到具有指定本地名称和命名空间 URI 的元素。 (继承自 XmlReader)
ReadToFollowing(String)	读取，直到找到具有指定限定名称的元素。 (继承自 XmlReader)
ReadToNextSibling(String, String)	使用指定的本地名称和命名空间 URI 前进 `XmlReader` 到下一个同级元素。 (继承自 XmlReader)
ReadToNextSibling(String)	使用指定的限定名称前进 `XmlReader` 到下一个同级元素。 (继承自 XmlReader)
ReadValueChunk(Char[], Int32, Int32)	读取嵌入在 XML 文档中的大型文本流。 (继承自 XmlReader)
ReadValueChunkAsync(Char[], Int32, Int32)	异步读取嵌入在 XML 文档中的大型文本流。 (继承自 XmlReader)
ResetState()	将读取器的状态重置为 ReadState.Initial。
ResolveEntity()	解析节点的 `EntityReference` 实体引用。
Skip()	跳过当前节点的子节点。
Skip()	跳过当前节点的子节点。 (继承自 XmlReader)
SkipAsync()	异步跳过当前节点的子级。 (继承自 XmlReader)
ToString()	返回一个表示当前对象的字符串。 (继承自 Object)

显式接口实现

名称	说明
IDisposable.Dispose()	有关此成员的说明，请参阅 Dispose()。 (继承自 XmlReader)
IXmlLineInfo.HasLineInfo()	有关此成员的说明，请参阅 HasLineInfo()。
IXmlNamespaceResolver.GetNamespacesInScope(XmlNamespaceScope)	有关此成员的说明，请参阅 GetNamespacesInScope(XmlNamespaceScope)。
IXmlNamespaceResolver.LookupNamespace(String)	有关此成员的说明，请参阅 LookupNamespace(String)。
IXmlNamespaceResolver.LookupPrefix(String)	有关此成员的说明，请参阅 LookupPrefix(String)。

适用于

另请参阅

XML 文档和数据

反馈

此页面是否有帮助？