XmlReader Classe

Définition

Espace de noms:

System.Xml

Assembly:

System.Xml.dll

Représente un lecteur qui fournit un accès rapide et non mis en cache uniquement aux données XML.

public ref class XmlReader abstract : IDisposable

public abstract class XmlReader : IDisposable

type XmlReader = class
    interface IDisposable

Public MustInherit Class XmlReader
Implements IDisposable

Héritage

Object

XmlReader

Dérivé

System.Xml.XmlDictionaryReader

System.Xml.XmlNodeReader

System.Xml.XmlTextReader

System.Xml.XmlValidatingReader

Implémente

IDisposable

Exemples

L’exemple de code suivant montre comment utiliser l’API asynchrone pour analyser 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

Remarques

Pour plus d’informations sur cette API, consultez les remarques d’API supplémentaires pour XmlReader.

Constructeurs

Nom	Description
XmlReader()	Initialise une nouvelle instance de la classe XmlReader.

Propriétés

Nom	Description
AttributeCount	En cas de substitution dans une classe dérivée, obtient le nombre d’attributs sur le nœud actuel.
BaseURI	En cas de substitution dans une classe dérivée, obtient l’URI de base du nœud actuel.
CanReadBinaryContent	Obtient une valeur indiquant si l’implémente XmlReader les méthodes de lecture de contenu binaire.
CanReadValueChunk	Obtient une valeur indiquant si la XmlReader méthode implémente ReadValueChunk(Char[], Int32, Int32) .
CanResolveEntity	Obtient une valeur indiquant si ce lecteur peut analyser et résoudre les entités.
Depth	En cas de substitution dans une classe dérivée, obtient la profondeur du nœud actuel dans le document XML.
EOF	En cas de substitution dans une classe dérivée, obtient une valeur indiquant si le lecteur est positionné à la fin du flux.
HasAttributes	Obtient une valeur indiquant si le nœud actuel a des attributs.
HasValue	En cas de substitution dans une classe dérivée, obtient une valeur indiquant si le nœud actuel peut avoir un Value.
IsDefault	En cas de substitution dans une classe dérivée, obtient une valeur indiquant si le nœud actuel est un attribut généré à partir de la valeur par défaut définie dans le DTD ou le schéma.
IsEmptyElement	En cas de substitution dans une classe dérivée, obtient une valeur indiquant si le nœud actuel est un élément vide (par exemple). <MyElement/>
Item[Int32]	En cas de substitution dans une classe dérivée, obtient la valeur de l’attribut avec l’index spécifié.
Item[String, String]	En cas de substitution dans une classe dérivée, obtient la valeur de l’attribut avec les valeurs spécifiées LocalName et NamespaceURI.
Item[String]	En cas de substitution dans une classe dérivée, obtient la valeur de l’attribut avec le paramètre spécifié Name.
LocalName	En cas de substitution dans une classe dérivée, obtient le nom local du nœud actuel.
Name	En cas de substitution dans une classe dérivée, obtient le nom qualifié du nœud actuel.
NamespaceURI	En cas de substitution dans une classe dérivée, obtient l’URI d’espace de noms (tel que défini dans la spécification de l’espace de noms W3C) du nœud sur lequel le lecteur est positionné.
NameTable	En cas de substitution dans une classe dérivée, obtient l’associé XmlNameTable à cette implémentation.
NodeType	En cas de substitution dans une classe dérivée, obtient le type du nœud actuel.
Prefix	En cas de substitution dans une classe dérivée, obtient le préfixe d’espace de noms associé au nœud actuel.
QuoteChar	En cas de substitution dans une classe dérivée, obtient le caractère guillemet utilisé pour placer la valeur d’un nœud d’attribut.
ReadState	En cas de substitution dans une classe dérivée, obtient l’état du lecteur.
SchemaInfo	Obtient les informations de schéma qui ont été affectées au nœud actuel à la suite de la validation du schéma.
Settings	Obtient l’objet XmlReaderSettings utilisé pour créer cette XmlReader instance.
Value	En cas de substitution dans une classe dérivée, obtient la valeur de texte du nœud actuel.
ValueType	Obtient le type CLR (Common Language Runtime) pour le nœud actuel.
XmlLang	En cas de substitution dans une classe dérivée, obtient l’étendue actuelle xml:lang .
XmlSpace	En cas de substitution dans une classe dérivée, obtient l’étendue actuelle xml:space .

Méthodes

Nom	Description
Close()	En cas de substitution dans une classe dérivée, change la ReadState valeur Closed.
Create(Stream, XmlReaderSettings, String)	Crée une XmlReader instance à l’aide du flux, de l’URI de base et des paramètres spécifiés.
Create(Stream, XmlReaderSettings, XmlParserContext)	Crée une XmlReader instance à l’aide du flux, des paramètres et des informations de contexte spécifiés pour l’analyse.
Create(Stream, XmlReaderSettings)	Crée une XmlReader instance avec le flux et les paramètres spécifiés.
Create(Stream)	Crée une XmlReader instance à l’aide du flux spécifié avec les paramètres par défaut.
Create(String, XmlReaderSettings, XmlParserContext)	Crée une XmlReader instance à l’aide de l’URI, des paramètres et des informations de contexte spécifiées pour l’analyse.
Create(String, XmlReaderSettings)	Crée une XmlReader instance à l’aide de l’URI et des paramètres spécifiés.
Create(String)	Crée une XmlReader instance avec l’URI spécifié.
Create(TextReader, XmlReaderSettings, String)	Crée une XmlReader instance à l’aide du lecteur de texte, des paramètres et de l’URI de base spécifiés.
Create(TextReader, XmlReaderSettings, XmlParserContext)	Crée une XmlReader instance à l’aide du lecteur de texte, des paramètres et des informations de contexte spécifiées pour l’analyse.
Create(TextReader, XmlReaderSettings)	Crée une XmlReader instance à l’aide du lecteur de texte et des paramètres spécifiés.
Create(TextReader)	Crée une XmlReader instance à l’aide du lecteur de texte spécifié.
Create(XmlReader, XmlReaderSettings)	Crée une XmlReader instance à l’aide du lecteur et des paramètres XML spécifiés.
Dispose()	Libère toutes les ressources utilisées par l’instance actuelle de la XmlReader classe.
Dispose(Boolean)	Libère les ressources non managées utilisées par les XmlReader ressources gérées et libère éventuellement les ressources managées.
Equals(Object)	Détermine si l’objet spécifié est égal à l’objet actuel. (Hérité de Object)
GetAttribute(Int32)	En cas de substitution dans une classe dérivée, obtient la valeur de l’attribut avec l’index spécifié.
GetAttribute(String, String)	En cas de substitution dans une classe dérivée, obtient la valeur de l’attribut avec les valeurs spécifiées LocalName et NamespaceURI.
GetAttribute(String)	En cas de substitution dans une classe dérivée, obtient la valeur de l’attribut avec le paramètre spécifié Name.
GetHashCode()	Sert de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
GetValueAsync()	Obtient de façon asynchrone la valeur du nœud actuel.
IsName(String)	Retourne une valeur indiquant si l’argument de chaîne est un nom XML valide.
IsNameToken(String)	Retourne une valeur indiquant si l’argument de chaîne est un jeton de nom XML valide.
IsStartElement()	Appelle MoveToContent() et teste si le nœud de contenu actuel est une balise de démarrage ou une balise d’élément vide.
IsStartElement(String, String)	Appelle MoveToContent() et teste si le nœud de contenu actuel est une balise de début ou une balise d’élément vide et si les LocalName propriétés de NamespaceURI l’élément trouvé correspondent aux chaînes données.
IsStartElement(String)	Appelle MoveToContent() et teste si le nœud de contenu actuel est une balise de début ou une balise d’élément vide et si la Name propriété de l’élément trouvé correspond à l’argument donné.
LookupNamespace(String)	En cas de substitution dans une classe dérivée, résout un préfixe d’espace de noms dans l’étendue de l’élément actuel.
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
MoveToAttribute(Int32)	En cas de substitution dans une classe dérivée, passe à l’attribut avec l’index spécifié.
MoveToAttribute(String, String)	En cas de substitution dans une classe dérivée, passe à l’attribut avec le paramètre spécifié LocalName et NamespaceURI.
MoveToAttribute(String)	En cas de substitution dans une classe dérivée, passe à l’attribut avec le paramètre spécifié Name.
MoveToContent()	Vérifie si le nœud actuel est un nœud de contenu (texte non blanc, CDATA, , Element, EndElementEntityReferenceou EndEntity) de contenu. Si le nœud n’est pas un nœud de contenu, le lecteur passe avant au nœud de contenu suivant ou à la fin du fichier. Il ignore les nœuds du type suivant : ProcessingInstruction, , DocumentType, Comment, Whitespaceou SignificantWhitespace.
MoveToContentAsync()	Vérifie de façon asynchrone si le nœud actuel est un nœud de contenu. Si le nœud n’est pas un nœud de contenu, le lecteur passe avant au nœud de contenu suivant ou à la fin du fichier.
MoveToElement()	En cas de substitution dans une classe dérivée, passe à l’élément qui contient le nœud d’attribut actuel.
MoveToFirstAttribute()	En cas de substitution dans une classe dérivée, passe au premier attribut.
MoveToNextAttribute()	En cas de substitution dans une classe dérivée, passe à l’attribut suivant.
Read()	En cas de substitution dans une classe dérivée, lit le nœud suivant à partir du flux.
ReadAsync()	Lit de façon asynchrone le nœud suivant à partir du flux.
ReadAttributeValue()	En cas de substitution dans une classe dérivée, analyse la valeur d’attribut en un ou plusieurs Textnœuds , EntityReferenceou EndEntity nœuds.
ReadContentAs(Type, IXmlNamespaceResolver)	Lit le contenu en tant qu’objet du type spécifié.
ReadContentAsAsync(Type, IXmlNamespaceResolver)	Lit de façon asynchrone le contenu en tant qu’objet du type spécifié.
ReadContentAsBase64(Byte[], Int32, Int32)	Lit le contenu et retourne les octets binaires décodés en Base64.
ReadContentAsBase64Async(Byte[], Int32, Int32)	Lit de façon asynchrone le contenu et retourne les octets binaires décodés en base64.
ReadContentAsBinHex(Byte[], Int32, Int32)	Lit le contenu et retourne les BinHex octets binaires décodés.
ReadContentAsBinHexAsync(Byte[], Int32, Int32)	Lit de façon asynchrone le contenu et retourne les BinHex octets binaires décodés.
ReadContentAsBoolean()	Lit le contenu du texte à la position actuelle en tant que Boolean.
ReadContentAsDateTime()	Lit le contenu du texte à la position actuelle en tant qu’objet DateTime .
ReadContentAsDateTimeOffset()	Lit le contenu du texte à la position actuelle en tant qu’objet DateTimeOffset .
ReadContentAsDecimal()	Lit le contenu du texte à la position actuelle en tant qu’objet Decimal .
ReadContentAsDouble()	Lit le contenu du texte à la position actuelle sous la forme d’un nombre à virgule flottante double précision.
ReadContentAsFloat()	Lit le contenu du texte à la position actuelle sous la forme d’un nombre à virgule flottante simple précision.
ReadContentAsInt()	Lit le contenu du texte à la position actuelle sous la forme d’un entier signé 32 bits.
ReadContentAsLong()	Lit le contenu du texte à la position actuelle sous la forme d’un entier signé 64 bits.
ReadContentAsObject()	Lit le contenu du texte à la position actuelle en tant que Object.
ReadContentAsObjectAsync()	Lit de façon asynchrone le contenu du texte à la position actuelle en tant que Object.
ReadContentAsString()	Lit le contenu du texte à la position actuelle en tant qu’objet String .
ReadContentAsStringAsync()	Lit de manière asynchrone le contenu du texte à la position actuelle en tant qu’objet String .
ReadElementContentAs(Type, IXmlNamespaceResolver, String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit le contenu de l’élément comme type demandé.
ReadElementContentAs(Type, IXmlNamespaceResolver)	Lit le contenu de l’élément comme type demandé.
ReadElementContentAsAsync(Type, IXmlNamespaceResolver)	Lit de manière asynchrone le contenu de l’élément comme type demandé.
ReadElementContentAsBase64(Byte[], Int32, Int32)	Lit l’élément et décode le Base64 contenu.
ReadElementContentAsBase64Async(Byte[], Int32, Int32)	Lit de façon asynchrone l’élément et décode le Base64 contenu.
ReadElementContentAsBinHex(Byte[], Int32, Int32)	Lit l’élément et décode le BinHex contenu.
ReadElementContentAsBinHexAsync(Byte[], Int32, Int32)	Lit de façon asynchrone l’élément et décode le BinHex contenu.
ReadElementContentAsBoolean()	Lit l’élément actuel et retourne le contenu en tant qu’objet Boolean .
ReadElementContentAsBoolean(String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit l’élément actuel et retourne le contenu en tant qu’objet Boolean .
ReadElementContentAsDateTime()	Lit l’élément actuel et retourne le contenu en tant qu’objet DateTime .
ReadElementContentAsDateTime(String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit l’élément actuel et retourne le contenu en tant qu’objet DateTime .
ReadElementContentAsDecimal()	Lit l’élément actuel et retourne le contenu en tant qu’objet Decimal .
ReadElementContentAsDecimal(String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit l’élément actuel et retourne le contenu en tant qu’objet Decimal .
ReadElementContentAsDouble()	Lit l’élément actuel et retourne le contenu sous forme de nombre à virgule flottante double précision.
ReadElementContentAsDouble(String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit l’élément actuel et retourne le contenu sous la forme d’un nombre à virgule flottante double précision.
ReadElementContentAsFloat()	Lit l’élément actuel et retourne le contenu sous forme de nombre à virgule flottante simple précision.
ReadElementContentAsFloat(String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit l’élément actuel et retourne le contenu sous la forme d’un nombre à virgule flottante simple précision.
ReadElementContentAsInt()	Lit l’élément actuel et retourne le contenu sous la forme d’un entier signé 32 bits.
ReadElementContentAsInt(String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit l’élément actuel et retourne le contenu sous la forme d’un entier signé 32 bits.
ReadElementContentAsLong()	Lit l’élément actuel et retourne le contenu sous la forme d’un entier signé 64 bits.
ReadElementContentAsLong(String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit l’élément actuel et retourne le contenu sous la forme d’un entier signé 64 bits.
ReadElementContentAsObject()	Lit l’élément actuel et retourne le contenu en tant que Object.
ReadElementContentAsObject(String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit l’élément actuel et retourne le contenu en tant que Object.
ReadElementContentAsObjectAsync()	Lit de façon asynchrone l’élément actuel et retourne le contenu sous la forme d’un Object.
ReadElementContentAsString()	Lit l’élément actuel et retourne le contenu en tant qu’objet String .
ReadElementContentAsString(String, String)	Vérifie que le nom local et l’URI d’espace de noms spécifiés correspondent à celui de l’élément actuel, puis lit l’élément actuel et retourne le contenu en tant qu’objet String .
ReadElementContentAsStringAsync()	Lit de façon asynchrone l’élément actuel et retourne le contenu en tant qu’objet String .
ReadElementString()	Lit un élément texte uniquement. Toutefois, nous vous recommandons d’utiliser la méthode à la ReadElementContentAsString() place, car elle offre un moyen plus simple de gérer cette opération.
ReadElementString(String, String)	Vérifie que les propriétés et LocalName les NamespaceURI propriétés de l’élément trouvées correspondent aux chaînes données avant de lire un élément texte uniquement. Toutefois, nous vous recommandons d’utiliser la méthode à la ReadElementContentAsString(String, String) place, car elle offre un moyen plus simple de gérer cette opération.
ReadElementString(String)	Vérifie que la Name propriété de l’élément trouvée correspond à la chaîne donnée avant de lire un élément texte uniquement. Toutefois, nous vous recommandons d’utiliser la méthode à la ReadElementContentAsString() place, car elle offre un moyen plus simple de gérer cette opération.
ReadEndElement()	Vérifie que le nœud de contenu actuel est une balise de fin et avance le lecteur vers le nœud suivant.
ReadInnerXml()	En cas de substitution dans une classe dérivée, lit tout le contenu, y compris le balisage, sous forme de chaîne.
ReadInnerXmlAsync()	Lit de façon asynchrone tout le contenu, y compris le balisage, sous forme de chaîne.
ReadOuterXml()	En cas de substitution dans une classe dérivée, lit le contenu, y compris le balisage, représentant ce nœud et tous ses enfants.
ReadOuterXmlAsync()	Lit de façon asynchrone le contenu, y compris le balisage, représentant ce nœud et tous ses enfants.
ReadStartElement()	Vérifie que le nœud actuel est un élément et avance le lecteur vers le nœud suivant.
ReadStartElement(String, String)	Vérifie que le nœud de contenu actuel est un élément avec l’élément donné LocalName et NamespaceURI avance le lecteur vers le nœud suivant.
ReadStartElement(String)	Vérifie que le nœud de contenu actuel est un élément avec le lecteur donné Name et avance le lecteur vers le nœud suivant.
ReadString()	En cas de substitution dans une classe dérivée, lit le contenu d’un nœud d’élément ou de texte sous forme de chaîne. Toutefois, nous vous recommandons d’utiliser la méthode à la ReadElementContentAsString place, car elle offre un moyen plus simple de gérer cette opération.
ReadSubtree()	Retourne une nouvelle XmlReader instance qui peut être utilisée pour lire le nœud actuel et tous ses descendants.
ReadToDescendant(String, String)	Avance l’élément XmlReader descendant suivant avec le nom local et l’URI d’espace de noms spécifiés.
ReadToDescendant(String)	Avance l’élément XmlReader descendant suivant avec le nom qualifié spécifié.
ReadToFollowing(String, String)	Lit jusqu’à ce qu’un élément portant le nom local et l’URI d’espace de noms spécifiés se trouvent.
ReadToFollowing(String)	Lit jusqu’à ce qu’un élément portant le nom qualifié spécifié soit trouvé.
ReadToNextSibling(String, String)	Avance l’élément XmlReader frère suivant avec le nom local et l’URI d’espace de noms spécifiés.
ReadToNextSibling(String)	Avance l’élément XmlReader frère suivant avec le nom qualifié spécifié.
ReadValueChunk(Char[], Int32, Int32)	Lit de grands flux de texte incorporés dans un document XML.
ReadValueChunkAsync(Char[], Int32, Int32)	Lit de manière asynchrone de grands flux de texte incorporés dans un document XML.
ResolveEntity()	En cas de substitution dans une classe dérivée, résout la référence d’entité pour EntityReference les nœuds.
Skip()	Ignore les enfants du nœud actuel.
SkipAsync()	Ignore de façon asynchrone les enfants du nœud actuel.
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)

Voir aussi

• Documents et données XML