XmlWriterSettings Classe

Définition

Espace de noms:

System.Xml

Assemblys:

netstandard.dll, System.Xml.ReaderWriter.dll

Source:

XmlWriterSettings.cs

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

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 une XmlWriter écriture 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éé.

Note

Si vous utilisez l’objet avec la XmlWriterTransform méthode, vous devez utiliser la OutputSettings propriété pour obtenir un XmlWriterSettings objet avec les paramètres appropriés. Cela garantit que l’objet créé XmlWriter a les 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 ces propriétés :

Propriété	Spécifie	Valeur	Par défaut
CheckCharacters	Indique 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	Indique s’il faut vérifier que la sortie est un document ou un fragment XML 1.0 bien formé.	ConformanceLevel.Document (au niveau du document), Fragment (au niveau du fragment) ou Auto (détection automatique)	ConformanceLevel.Document (conformité au niveau du document)
WriteEndDocumentOnClose	Indique s’il faut ajouter des balises fermante à 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 ces propriétés :

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

Constructeurs

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

Propriétés

Nom	Description
Async	Obtient ou définit une valeur qui indique si des méthodes asynchrones XmlWriter peuvent être utilisées sur une instance particulière XmlWriter .
CheckCharacters	Obtient ou définit une valeur qui indique si l’enregistreur XML doit vérifier que tous les caractères du document sont conformes à la section « 2.2 Caractères » de la recommandation W3C XML 1.0.
CloseOutput	Obtient ou définit une valeur indiquant si le XmlWriter flux sous-jacent doit également être fermé ou TextWriter quand la Close() méthode est appelée.
ConformanceLevel	Obtient ou définit le niveau de conformité pour lequel l’enregistreur XML vérifie la sortie XML.
DoNotEscapeUriAttributes	Obtient ou définit une valeur qui indique si les attributs d’URI d’échappement ne s’échappent XmlWriter pas.
Encoding	Obtient ou définit le type d’encodage de texte à utiliser.
Indent	Obtient ou définit une valeur indiquant s’il faut mettre en retrait des éléments.
IndentChars	Obtient ou définit la chaîne de caractères à utiliser lors de la mise en retrait. Ce paramètre est utilisé lorsque la Indent propriété est définie sur true.
NamespaceHandling	Obtient ou définit une valeur qui indique si les déclarations d’espace de noms en double doivent être supprimées lors de l’écriture XmlWriter de contenu XML. Le comportement par défaut est que l’enregistreur génère toutes les déclarations d’espace de noms présentes dans le programme de résolution d’espace de noms de l’enregistreur.
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 faut normaliser les sauts de ligne dans la sortie.
NewLineOnAttributes	Obtient ou définit une valeur indiquant s’il faut écrire des attributs sur une nouvelle ligne.
OmitXmlDeclaration	Obtient ou définit une valeur indiquant s’il faut omettre une déclaration XML.
OutputMethod	Obtient la méthode utilisée pour sérialiser la XmlWriter sortie.
WriteEndDocumentOnClose	Obtient ou définit une valeur qui indique si les XmlWriter balises fermante sont ajoutées à toutes les balises d’élément non fermées lorsque la Close() méthode est appelée.

Méthodes

Nom	Description
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()	Sert de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (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)