XmlReader Classe

Definição

Namespace:
System.Xml
Assemblies:
System.Xml.dll, System.Xml.ReaderWriter.dll
Assemblies:
netstandard.dll, System.Xml.ReaderWriter.dll
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll
Origem:
XmlReader.cs
Origem:
XmlReader.cs
Origem:
XmlReader.cs
Origem:
XmlReader.cs
Origem:
XmlReader.cs

Representa um leitor que fornece acesso rápido, sem cache, somente encaminhamento a dados XML.

public ref class XmlReader abstract : IDisposable
public ref class XmlReader abstract
public abstract class XmlReader : IDisposable
public abstract class XmlReader
type XmlReader = class
    interface IDisposable
type XmlReader = class
Public MustInherit Class XmlReader
Implements IDisposable
Public MustInherit Class XmlReader
Herança
Object
XmlReader
Derivado
Implementações
IDisposable

Exemplos

O código de exemplo a seguir mostra como usar a API assíncrona para analisar XML.

async Task TestReader(System.IO.Stream stream)
{
    XmlReaderSettings settings = new XmlReaderSettings();
    settings.Async = true;

    using (XmlReader reader = XmlReader.Create(stream, settings))
    {
        while (await reader.ReadAsync())
        {
            switch (reader.NodeType)
            {
                case XmlNodeType.Element:
                    Console.WriteLine("Start Element {0}", reader.Name);
                    break;
                case XmlNodeType.Text:
                    Console.WriteLine("Text Node: {0}",
                             await reader.GetValueAsync());
                    break;
                case XmlNodeType.EndElement:
                    Console.WriteLine("End Element {0}", reader.Name);
                    break;
                default:
                    Console.WriteLine("Other node {0} with value {1}",
                                    reader.NodeType, reader.Value);
                    break;
            }
        }
    }
}

Public Async Function TestReader(stream As System.IO.Stream) As Task
    Dim settings As New XmlReaderSettings()
    settings.Async = True

    Using reader As XmlReader = XmlReader.Create(stream, settings)
        While (Await reader.ReadAsync())
            Select Case (reader.NodeType)
                Case XmlNodeType.Element
                    Console.WriteLine("Start Element {0}", reader.Name)
                Case XmlNodeType.Text
                    Console.WriteLine("Text Node: {0}",
                             Await reader.GetValueAsync())
                Case XmlNodeType.EndElement
                    Console.WriteLine("End Element {0}", reader.Name)
                Case Else
                    Console.WriteLine("Other node {0} with value {1}",
                                    reader.NodeType, reader.Value)
            End Select
        End While
    End Using
End Function

Comentários

Para obter mais informações sobre essa API, consulte comentários de API Suplementar para XmlReader.

Construtores

Nome Description
XmlReader()

Inicializa uma nova instância da classe XmlReader.

Propriedades

Nome Description
AttributeCount

Quando substituído em uma classe derivada, obtém o número de atributos no nó atual.
BaseURI

Quando substituído em uma classe derivada, obtém o URI base do nó atual.
CanReadBinaryContent

Obtém um valor que indica se o XmlReader conteúdo binário implementa os métodos de leitura de conteúdo binário.
CanReadValueChunk

Obtém um valor que indica se o XmlReader método implementa ReadValueChunk(Char[], Int32, Int32) .
CanResolveEntity

Obtém um valor que indica se esse leitor pode analisar e resolver entidades.
Depth

Quando substituído em uma classe derivada, obtém a profundidade do nó atual no documento XML.
EOF

Quando substituído em uma classe derivada, obtém um valor que indica se o leitor está posicionado no final do fluxo.
HasAttributes

Obtém um valor que indica se o nó atual tem atributos.
HasValue

Quando substituído em uma classe derivada, obtém um valor que indica se o nó atual pode ter um Value.
IsDefault

Quando substituído em uma classe derivada, obtém um valor que indica se o nó atual é um atributo que foi gerado do valor padrão definido no DTD ou no esquema.
IsEmptyElement

Quando substituído em uma classe derivada, obtém um valor que indica se o nó atual é um elemento vazio (por exemplo, <MyElement/>).
Item[Int32]

Quando substituído em uma classe derivada, obtém o valor do atributo com o índice especificado.
Item[String, String]

Quando substituído em uma classe derivada, obtém o valor do atributo com o especificado LocalName e NamespaceURI.
Item[String]

Quando substituído em uma classe derivada, obtém o valor do atributo com o especificado Name.
LocalName

Quando substituído em uma classe derivada, obtém o nome local do nó atual.
Name

Quando substituído em uma classe derivada, obtém o nome qualificado do nó atual.
NamespaceURI

Quando substituído em uma classe derivada, obtém o URI do namespace (conforme definido na especificação do Namespace W3C) do nó no qual o leitor está posicionado.
NameTable

Quando substituído em uma classe derivada, obtém o XmlNameTable associado a essa implementação.
NodeType

Quando substituído em uma classe derivada, obtém o tipo do nó atual.
Prefix

Quando substituído em uma classe derivada, obtém o prefixo de namespace associado ao nó atual.
QuoteChar

Quando substituído em uma classe derivada, obtém o caractere de aspas usado para colocar o valor de um nó de atributo.
ReadState

Quando substituído em uma classe derivada, obtém o estado do leitor.
SchemaInfo

Obtém as informações de esquema atribuídas ao nó atual como resultado da validação do esquema.
Settings

Obtém o XmlReaderSettings objeto usado para criar essa XmlReader instância.
Value

Quando substituído em uma classe derivada, obtém o valor de texto do nó atual.
ValueType

Obtém o tipo CLR (Common Language Runtime) para o nó atual.
XmlLang

Quando substituído em uma classe derivada, obtém o escopo atual xml:lang .
XmlSpace

Quando substituído em uma classe derivada, obtém o escopo atual xml:space .

Métodos

Nome Description
Close()

Quando substituído em uma classe derivada, altera o ReadState para Closed.
Create(Stream, XmlReaderSettings, String)

Cria uma nova XmlReader instância usando o fluxo, o URI base e as configurações especificados.
Create(Stream, XmlReaderSettings, XmlParserContext)

Cria uma nova XmlReader instância usando o fluxo, as configurações e as informações de contexto especificadas para análise.
Create(Stream, XmlReaderSettings)

Cria uma nova XmlReader instância com o fluxo e as configurações especificados.
Create(Stream)

Cria uma nova XmlReader instância usando o fluxo especificado com configurações padrão.
Create(String, XmlReaderSettings, XmlParserContext)

Cria uma nova XmlReader instância usando o URI, as configurações e as informações de contexto especificadas para análise.
Create(String, XmlReaderSettings)

Cria uma nova XmlReader instância usando o URI e as configurações especificados.
Create(String)

Cria uma nova XmlReader instância com URI especificado.
Create(TextReader, XmlReaderSettings, String)

Cria uma nova XmlReader instância usando o leitor de texto, as configurações e o URI base especificados.
Create(TextReader, XmlReaderSettings, XmlParserContext)

Cria uma nova XmlReader instância usando o leitor de texto, as configurações e as informações de contexto especificadas para análise.
Create(TextReader, XmlReaderSettings)

Cria uma nova XmlReader instância usando o leitor de texto e as configurações especificados.
Create(TextReader)

Cria uma nova XmlReader instância usando o leitor de texto especificado.
Create(XmlReader, XmlReaderSettings)

Cria uma nova XmlReader instância usando o leitor XML e as configurações especificados.
Dispose()

Libera todos os recursos usados pela instância atual da XmlReader classe.
Dispose(Boolean)

Libera os recursos não gerenciados usados pelo XmlReader e, opcionalmente, libera os recursos gerenciados.
Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetAttribute(Int32)

Quando substituído em uma classe derivada, obtém o valor do atributo com o índice especificado.
GetAttribute(String, String)

Quando substituído em uma classe derivada, obtém o valor do atributo com o especificado LocalName e NamespaceURI.
GetAttribute(String)

Quando substituído em uma classe derivada, obtém o valor do atributo com o especificado Name.
GetHashCode()

Serve como a função de hash padrão.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
GetValueAsync()

Obtém de forma assíncrona o valor do nó atual.
IsName(String)

Retorna um valor que indica se o argumento de cadeia de caracteres é um nome XML válido.
IsNameToken(String)

Retorna um valor que indica se o argumento de cadeia de caracteres é ou não um token de nome XML válido.
IsStartElement()

Chama MoveToContent() e testa se o nó de conteúdo atual é uma marca inicial ou uma marca de elemento vazia.
IsStartElement(String, String)

Chama MoveToContent() e testa se o nó de conteúdo atual é uma marca inicial ou uma marca de elemento vazia e se as LocalName propriedades do NamespaceURI elemento encontrado correspondem às cadeias de caracteres fornecidas.
IsStartElement(String)

Chama MoveToContent() e testa se o nó de conteúdo atual é uma marca inicial ou uma marca de elemento vazia e se a Name propriedade do elemento encontrado corresponde ao argumento fornecido.
LookupNamespace(String)

Quando substituído em uma classe derivada, resolve um prefixo de namespace no escopo do elemento atual.
MemberwiseClone()

Cria uma cópia superficial do Objectatual.

(Herdado de Object)
MoveToAttribute(Int32)

Quando substituído em uma classe derivada, passa para o atributo com o índice especificado.
MoveToAttribute(String, String)

Quando substituído em uma classe derivada, move para o atributo com o especificado LocalName e NamespaceURI.
MoveToAttribute(String)

Quando substituído em uma classe derivada, move-se para o atributo com o especificado Name.
MoveToContent()

Verifica se o nó atual é um conteúdo (texto de espaço não branco, CDATA, Element, , EndElement, EntityReferenceou EndEntity) nó. Se o nó não for um nó de conteúdo, o leitor ignorará o próximo nó de conteúdo ou o fim do arquivo. Ele ignora nós do seguinte tipo: ProcessingInstruction, , DocumentType, Comment, ou WhitespaceSignificantWhitespace.
MoveToContentAsync()

Verifica de forma assíncrona se o nó atual é um nó de conteúdo. Se o nó não for um nó de conteúdo, o leitor ignorará o próximo nó de conteúdo ou o fim do arquivo.
MoveToElement()

Quando substituído em uma classe derivada, move-se para o elemento que contém o nó de atributo atual.
MoveToFirstAttribute()

Quando substituído em uma classe derivada, passa para o primeiro atributo.
MoveToNextAttribute()

Quando substituído em uma classe derivada, passa para o próximo atributo.
Read()

Quando substituído em uma classe derivada, lê o próximo nó do fluxo.
ReadAsync()

Lê de forma assíncrona o próximo nó do fluxo.
ReadAttributeValue()

Quando substituído em uma classe derivada, analisa o valor do atributo em um ou mais TextEntityReferencenós ou EndEntity nós.
ReadContentAs(Type, IXmlNamespaceResolver)

Lê o conteúdo como um objeto do tipo especificado.
ReadContentAsAsync(Type, IXmlNamespaceResolver)

Lê o conteúdo de forma assíncrona como um objeto do tipo especificado.
ReadContentAsBase64(Byte[], Int32, Int32)

Lê o conteúdo e retorna os bytes binários decodificados em Base64.
ReadContentAsBase64Async(Byte[], Int32, Int32)

Lê o conteúdo de forma assíncrona e retorna os bytes binários decodificados em Base64.
ReadContentAsBinHex(Byte[], Int32, Int32)

Lê o conteúdo e retorna os BinHex bytes binários decodificados.
ReadContentAsBinHexAsync(Byte[], Int32, Int32)

Lê o conteúdo de forma assíncrona e retorna os BinHex bytes binários decodificados.
ReadContentAsBoolean()

Lê o conteúdo do texto na posição atual como um Boolean.
ReadContentAsDateTime()

Lê o conteúdo do texto na posição atual como um DateTime objeto.
ReadContentAsDateTimeOffset()

Lê o conteúdo do texto na posição atual como um DateTimeOffset objeto.
ReadContentAsDecimal()

Lê o conteúdo do texto na posição atual como um Decimal objeto.
ReadContentAsDouble()

Lê o conteúdo do texto na posição atual como um número de ponto flutuante de precisão dupla.
ReadContentAsFloat()

Lê o conteúdo do texto na posição atual como um número de ponto flutuante de precisão única.
ReadContentAsInt()

Lê o conteúdo do texto na posição atual como um inteiro com sinal de 32 bits.
ReadContentAsLong()

Lê o conteúdo do texto na posição atual como um inteiro com sinal de 64 bits.
ReadContentAsObject()

Lê o conteúdo do texto na posição atual como um Object.
ReadContentAsObjectAsync()

Lê de forma assíncrona o conteúdo do texto na posição atual como um Object.
ReadContentAsString()

Lê o conteúdo do texto na posição atual como um String objeto.
ReadContentAsStringAsync()

Lê de forma assíncrona o conteúdo do texto na posição atual como um String objeto.
ReadElementContentAs(Type, IXmlNamespaceResolver, String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual e lê o conteúdo do elemento como o tipo solicitado.
ReadElementContentAs(Type, IXmlNamespaceResolver)

Lê o conteúdo do elemento como o tipo solicitado.
ReadElementContentAsAsync(Type, IXmlNamespaceResolver)

Lê de forma assíncrona o conteúdo do elemento como o tipo solicitado.
ReadElementContentAsBase64(Byte[], Int32, Int32)

Lê o elemento e decodifica o Base64 conteúdo.
ReadElementContentAsBase64Async(Byte[], Int32, Int32)

Lê o elemento de forma assíncrona e decodifica o Base64 conteúdo.
ReadElementContentAsBinHex(Byte[], Int32, Int32)

Lê o elemento e decodifica o BinHex conteúdo.
ReadElementContentAsBinHexAsync(Byte[], Int32, Int32)

Lê o elemento de forma assíncrona e decodifica o BinHex conteúdo.
ReadElementContentAsBoolean()

Lê o elemento atual e retorna o conteúdo como um Boolean objeto.
ReadElementContentAsBoolean(String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual, lê o elemento atual e retorna o conteúdo como um Boolean objeto.
ReadElementContentAsDateTime()

Lê o elemento atual e retorna o conteúdo como um DateTime objeto.
ReadElementContentAsDateTime(String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual, lê o elemento atual e retorna o conteúdo como um DateTime objeto.
ReadElementContentAsDecimal()

Lê o elemento atual e retorna o conteúdo como um Decimal objeto.
ReadElementContentAsDecimal(String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual, lê o elemento atual e retorna o conteúdo como um Decimal objeto.
ReadElementContentAsDouble()

Lê o elemento atual e retorna o conteúdo como um número de ponto flutuante de precisão dupla.
ReadElementContentAsDouble(String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual, lê o elemento atual e retorna o conteúdo como um número de ponto flutuante de precisão dupla.
ReadElementContentAsFloat()

Lê o elemento atual e retorna o conteúdo como número de ponto flutuante de precisão única.
ReadElementContentAsFloat(String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual, lê o elemento atual e retorna o conteúdo como um número de ponto flutuante de precisão única.
ReadElementContentAsInt()

Lê o elemento atual e retorna o conteúdo como um inteiro com sinal de 32 bits.
ReadElementContentAsInt(String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual, lê o elemento atual e retorna o conteúdo como um inteiro com sinal de 32 bits.
ReadElementContentAsLong()

Lê o elemento atual e retorna o conteúdo como um inteiro com sinal de 64 bits.
ReadElementContentAsLong(String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual, lê o elemento atual e retorna o conteúdo como um inteiro com sinal de 64 bits.
ReadElementContentAsObject()

Lê o elemento atual e retorna o conteúdo como um Object.
ReadElementContentAsObject(String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual, lê o elemento atual e retorna o conteúdo como um Object.
ReadElementContentAsObjectAsync()

Lê o elemento atual de forma assíncrona e retorna o conteúdo como um Object.
ReadElementContentAsString()

Lê o elemento atual e retorna o conteúdo como um String objeto.
ReadElementContentAsString(String, String)

Verifica se o nome local especificado e o URI do namespace correspondem ao do elemento atual, lê o elemento atual e retorna o conteúdo como um String objeto.
ReadElementContentAsStringAsync()

Lê o elemento atual de forma assíncrona e retorna o conteúdo como um String objeto.
ReadElementString()

Lê um elemento somente texto. No entanto, recomendamos que você use o ReadElementContentAsString() método, pois ele fornece uma maneira mais simples de lidar com essa operação.
ReadElementString(String, String)

Verifica se as LocalName propriedades do NamespaceURI elemento encontrado correspondem às cadeias de caracteres fornecidas antes de ler um elemento somente texto. No entanto, recomendamos que você use o ReadElementContentAsString(String, String) método, pois ele fornece uma maneira mais simples de lidar com essa operação.
ReadElementString(String)

Verifica se a Name propriedade do elemento encontrado corresponde à cadeia de caracteres determinada antes de ler um elemento somente texto. No entanto, recomendamos que você use o ReadElementContentAsString() método, pois ele fornece uma maneira mais simples de lidar com essa operação.
ReadEndElement()

Verifica se o nó de conteúdo atual é uma marca de término e avança o leitor para o próximo nó.
ReadInnerXml()

Quando substituído em uma classe derivada, lê todo o conteúdo, incluindo marcação, como uma cadeia de caracteres.
ReadInnerXmlAsync()

Lê de forma assíncrona todo o conteúdo, incluindo marcação, como uma cadeia de caracteres.
ReadOuterXml()

Quando substituído em uma classe derivada, lê o conteúdo, incluindo marcação, representando esse nó e todos os seus filhos.
ReadOuterXmlAsync()

Lê o conteúdo de forma assíncrona, incluindo marcação, representando esse nó e todos os seus filhos.
ReadStartElement()

Verifica se o nó atual é um elemento e avança o leitor para o próximo nó.
ReadStartElement(String, String)

Verifica se o nó de conteúdo atual é um elemento com o determinado LocalName e NamespaceURI avança o leitor para o próximo nó.
ReadStartElement(String)

Verifica se o nó de conteúdo atual é um elemento com o determinado Name e avança o leitor para o próximo nó.
ReadString()

Quando substituído em uma classe derivada, lê o conteúdo de um elemento ou nó de texto como uma cadeia de caracteres. No entanto, recomendamos que você use o ReadElementContentAsString método, pois ele fornece uma maneira mais simples de lidar com essa operação.
ReadSubtree()

Retorna uma nova XmlReader instância que pode ser usada para ler o nó atual e todos os seus descendentes.
ReadToDescendant(String, String)

Avança para o XmlReader próximo elemento descendente com o nome local e o URI do namespace especificados.
ReadToDescendant(String)

Avança para o XmlReader próximo elemento descendente com o nome qualificado especificado.
ReadToFollowing(String, String)

Lê até que um elemento com o nome local e o URI do namespace especificados seja encontrado.
ReadToFollowing(String)

Lê até que um elemento com o nome qualificado especificado seja encontrado.
ReadToNextSibling(String, String)

Avança para o XmlReader próximo elemento irmão com o nome local e o URI do namespace especificados.
ReadToNextSibling(String)

Avança para o XmlReader próximo elemento irmão com o nome qualificado especificado.
ReadValueChunk(Char[], Int32, Int32)

Lê grandes fluxos de texto inseridos em um documento XML.
ReadValueChunkAsync(Char[], Int32, Int32)

Lê de forma assíncrona grandes fluxos de texto inseridos em um documento XML.
ResolveEntity()

Quando substituído em uma classe derivada, resolve a referência de entidade para EntityReference nós.
Skip()

Ignora os subordinados do nó atual.
SkipAsync()

Ignora assíncronamente os filhos do nó atual.
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Implantações explícitas de interface

Nome Description
IDisposable.Dispose()

Para obter uma descrição deste membro, consulte Dispose().

Aplica-se a

Confira também