XmlWriterSettings Classe

Définition

Espace de noms:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Spécifie un jeu de fonctionnalités à prendre en charge sur l'objet XmlWriter créé par la méthode Create.

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

Héritage

Object

XmlWriterSettings

Exemples

L’exemple suivant crée un XmlWriter qui écrit dans un fichier XML et écrit chaque attribut sur une nouvelle ligne.

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.OmitXmlDeclaration = true;
settings.NewLineOnAttributes = true;

writer = XmlWriter.Create(Console.Out, settings);

writer.WriteStartElement("order");
writer.WriteAttributeString("orderID", "367A54");
writer.WriteAttributeString("date", "2001-05-03");
writer.WriteElementString("price", "19.95");
writer.WriteEndElement();
    
writer.Flush();

        Dim settings As New XmlWriterSettings()
        settings.Indent = True
        settings.OmitXmlDeclaration = True
        settings.NewLineOnAttributes = True
   
        writer = XmlWriter.Create(Console.Out, settings)

        writer.WriteStartElement("order")
        writer.WriteAttributeString("orderID", "367A54")
        writer.WriteAttributeString("date", "2001-05-03")
        writer.WriteElementString("price", "19.95")
        writer.WriteEndElement()

        writer.Flush()

L’exemple produit la sortie suivante :

<order
  orderID="367A54"
  date="2001-05-03">
  <price>19.95</price>
</order>

Remarques

La Create méthode est le mécanisme préféré pour obtenir des XmlWriter instances. La Create méthode utilise la XmlWriterSettings classe pour spécifier les fonctionnalités à implémenter dans l’objet XmlWriter créé.

Notes

Si vous utilisez l’objet XmlWriter avec la Transform méthode, vous devez utiliser la OutputSettings propriété pour obtenir un XmlWriterSettings objet avec les paramètres corrects. Cela garantit que l'objet XmlWriter créé dispose des paramètres de sortie corrects.

La XmlWriterSettings classe fournit des propriétés qui contrôlent la conformité des données et le format de sortie.

Pour les vérifications de conformité des données et les corrections automatiques, utilisez les propriétés suivantes :

Propriété	Spécifie	Valeur	Default
CheckCharacters	S’il faut vérifier que les caractères se trouvent dans le jeu de caractères XML légal, tel que défini par W3C.	true ou false	true
ConformanceLevel	Vérifiez s’il s’agit d’un document ou d’un fragment XML 1.0 bien formé.	ConformanceLevel.Document (au niveau du document), Fragment (au niveau des fragments) ou Auto (détection automatique)	ConformanceLevel.Document (conformité au niveau du document)
WriteEndDocumentOnClose	Indique s’il faut ajouter des balises fermants à tous les éléments non fermés lorsque la Close méthode est appelée.	true ou false	true

Pour spécifier le format de sortie, utilisez les propriétés suivantes :

Propriété	Spécifie	Valeur	Default
Encoding	Encodage de texte à utiliser.	Valeur System.Text.Encoding	Encoding.UTF8
Indent	S’il faut mettre en retrait les éléments	true ou false	false (pas de retrait)
IndentChars	Chaîne de caractères à utiliser lors de la mise en retrait (utilisée quand Indent est défini sur true).	String	Deux espaces
NewLineChars	Chaîne de caractères à utiliser pour les sauts de ligne.	String	\r\n (retour chariot, flux de ligne)
NewLineHandling	Comment gérer les caractères de nouvelle ligne.	System.Xml.NewLineHandling valeur : Entitize (normaliser), Replace (remplacer) ou None (laisser inchangé)	Replace (remplacez par les caractères spécifiés par NewLineChars)
NewLineOnAttributes	Indique s’il faut écrire des attributs sur des lignes individuelles (n’a aucun effet lorsque Indent est false).	true ou false	false
OmitXmlDeclaration	Indique s’il faut écrire une déclaration XML.	true ou false	false

Constructeurs

XmlWriterSettings()

Initialise une nouvelle instance de la classe XmlWriterSettings.

Propriétés

Async	Obtient ou définit une valeur qui indique si les méthodes XmlWriter asynchrones peuvent être utilisées sur une instance XmlWriter particulière.
CheckCharacters	Obtient ou définit une valeur qui indique si le writer XML doit vérifier que tous les caractères du document sont conformes à la section « 2.2 Characters » de la recommandation W3C sur XML 1.0.
CloseOutput	Obtient ou définit une valeur indiquant si XmlWriter doit également fermer le flux sous-jacent ou TextWriter lorsque la méthode Close() est appelée.
ConformanceLevel	Obtient ou définit le niveau de conformité de vérification de sortie XML du writer XML.
DoNotEscapeUriAttributes	Obtient ou définit une valeur qui indique si le XmlWriter ne place pas les attributs d'URI dans des séquences d’échappement.
Encoding	Obtient ou définit le type d'encodage de texte à utiliser.
Indent	Obtient ou définit une valeur indiquant si les éléments doivent être mis en retrait.
IndentChars	Obtient ou définit la chaîne de caractères à utiliser au moment de la mise en retrait. Ce paramètre est utilisé lorsque la propriété Indent a la valeur true.
NamespaceHandling	Obtient ou définit une valeur qui indique si XmlWriter doit supprimer des déclarations d'espace de noms en double lors de l'écriture du contenu XML. Le comportement par défaut consiste pour le writer à générer la sortie de toutes les déclarations d'espace de noms qui sont présentes dans le programme de résolution d'espace de noms du writer.
NewLineChars	Obtient ou définit la chaîne de caractères à utiliser pour les sauts de ligne.
NewLineHandling	Obtient ou définit une valeur indiquant s'il convient de normaliser des sauts de ligne dans la sortie.
NewLineOnAttributes	Obtient ou définit une valeur indiquant s'il convient d'écrire des attributs sur une nouvelle ligne.
OmitXmlDeclaration	Obtient ou définit une valeur indiquant si une déclaration XML doit être omise.
OutputMethod	Obtient la méthode utilisée pour sérialiser la sortie XmlWriter.
WriteEndDocumentOnClose	Obtient ou définit une valeur qui indique si XmlWriter ajoutera des indicateurs de fermeture à tous les indicateurs d'éléments non fermés lorsque la méthode Close() est appelée.

Méthodes

Clone()	Crée une copie de l'instance XmlWriterSettings.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
Reset()	Réinitialise les membres de la classe de paramètres à leurs valeurs par défaut.
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)