XmlWriterSettings Classe

Définition

Spécifie un jeu de fonctionnalités à prendre en charge sur l'objet XmlWriter créé par la méthode Create.Specifies a set of features to support on the XmlWriter object created by the Create method.

public ref class XmlWriterSettings sealed
public sealed class XmlWriterSettings
type XmlWriterSettings = class
Public NotInheritable Class XmlWriterSettings
Héritage
XmlWriterSettings

Exemples

L’exemple suivant crée un XmlWriter qui écrit dans un fichier XML et écrit chaque attribut sur une nouvelle ligne.The following example creates an XmlWriter that writes to an XML file and writes each attribute on a new line.

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 génère la sortie suivante :The sample produces the following output:

<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 l’obtention d' XmlWriter instances.The Create method is the preferred mechanism for obtaining XmlWriter instances. La Create méthode utilise la XmlWriterSettings classe pour spécifier les fonctionnalités à implémenter dans l' XmlWriter objet créé.The Create method uses the XmlWriterSettings class to specify which features to implement in the XmlWriter object that is created.

Notes

Si vous utilisez l' XmlWriter objet avec la Transform méthode, vous devez utiliser la OutputSettings propriété pour obtenir un XmlWriterSettings objet avec les paramètres corrects.If you're using the XmlWriter object with the Transform method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. Cela garantit que l'objet XmlWriter créé dispose des paramètres de sortie corrects.This ensures that the created XmlWriter object has the correct output settings.

La XmlWriterSettings classe fournit des propriétés qui contrôlent la conformité des données et le format de sortie.The XmlWriterSettings class provides properties that control data conformance and output format.

Pour les vérifications de conformité des données et les corrections automatiques, utilisez les propriétés suivantes :For data conformance checks and auto-corrections, use these properties:

PropriétéProperty SpécifieSpecifies ValeurValue DefaultDefault
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.Whether to check that characters are in the legal XML character set, as defined by W3C. true ou falsetrue or false true
ConformanceLevel Indique s’il faut vérifier que la sortie est un fragment ou un document XML 1,0 correctement construit.Whether to check that output is a well-formed XML 1.0 document or fragment. ConformanceLevel.Document (au niveau du document), Fragment (au niveau de la fragmentation) ou Auto (détection automatique)ConformanceLevel.Document (document-level), Fragment (fragment-level), or Auto (auto-detection) ConformanceLevel.Document (conformité au niveau du document)ConformanceLevel.Document (document-level conformance)
WriteEndDocumentOnClose Indique s’il faut ajouter des balises de fermeture à tous les éléments non fermés lorsque la Close méthode est appelée.Whether to add closing tags to all unclosed elements when the Close method is called. true ou falsetrue or false true

Pour spécifier le format de sortie, utilisez les propriétés suivantes :To specify output format, use these properties:

PropriétéProperty SpécifieSpecifies ValeurValue DefaultDefault
Encoding Encodage de texte à utiliser.Text encoding to use. Valeur System.Text.EncodingSystem.Text.Encoding value Encoding.UTF8
Indent Indique s’il faut mettre en retrait des élémentsWhether to indent elements true ou falsetrue or false false (aucune mise en retrait)false (no indentation)
IndentChars Chaîne de caractères à utiliser lors de la mise en retrait (utilisée lorsque Indent a la valeur true ).Character string to use when indenting (used when Indent is set to true). StringString Deux espacesTwo spaces
NewLineChars Chaîne de caractères à utiliser pour les sauts de ligne.Character string to use for line breaks. StringString \r\n (retour chariot, saut de ligne)\r\n (carriage return, line feed)
NewLineHandling Comment gérer les caractères de saut de ligne.How to handle newline characters. System.Xml.NewLineHandling valeur : Entitize (normaliser), Replace (remplacer) ou None (ne pas modifier)System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace), or None (leave unchanged) Replace (à remplacer par les caractères spécifiés par NewLineChars )Replace (replace with characters specified by NewLineChars)
NewLineOnAttributes Indique s’il faut écrire des attributs sur des lignes individuelles (n’a aucun effet lorsque Indent a la valeur false ).Whether to write attributes on individual lines (has no effect when Indent is false). true ou falsetrue or false false
OmitXmlDeclaration Indique s’il faut écrire une déclaration XML.Whether to write an XML declaration. true ou falsetrue or false false

Constructeurs

XmlWriterSettings()

Initialise une nouvelle instance de la classe XmlWriterSettings.Initializes a new instance of the XmlWriterSettings class.

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.Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

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.Gets or sets a value that indicates whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.

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.Gets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close() method is called.

ConformanceLevel

Obtient ou définit le niveau de conformité de vérification de sortie XML du writer XML.Gets or sets the level of conformance that the XML writer checks the XML output for.

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.Gets or sets a value that indicates whether the XmlWriter does not escape URI attributes.

Encoding

Obtient ou définit le type d'encodage de texte à utiliser.Gets or sets the type of text encoding to use.

Indent

Obtient ou définit une valeur indiquant si les éléments doivent être mis en retrait.Gets or sets a value indicating whether to indent elements.

IndentChars

Obtient ou définit la chaîne de caractères à utiliser au moment de la mise en retrait.Gets or sets the character string to use when indenting. Ce paramètre est utilisé lorsque la propriété Indent a la valeur true.This setting is used when the Indent property is set to 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.Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. 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.The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.

NewLineChars

Obtient ou définit la chaîne de caractères à utiliser pour les sauts de ligne.Gets or sets the character string to use for line breaks.

NewLineHandling

Obtient ou définit une valeur indiquant s'il convient de normaliser des sauts de ligne dans la sortie.Gets or sets a value indicating whether to normalize line breaks in the output.

NewLineOnAttributes

Obtient ou définit une valeur indiquant s'il convient d'écrire des attributs sur une nouvelle ligne.Gets or sets a value indicating whether to write attributes on a new line.

OmitXmlDeclaration

Obtient ou définit une valeur indiquant si une déclaration XML doit être omise.Gets or sets a value indicating whether to omit an XML declaration.

OutputMethod

Obtient la méthode utilisée pour sérialiser la sortie XmlWriter.Gets the method used to serialize the XmlWriter output.

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.Gets or sets a value that indicates whether the XmlWriter will add closing tags to all unclosed element tags when the Close() method is called.

Méthodes

Clone()

Crée une copie de l'instance XmlWriterSettings.Creates a copy of the XmlWriterSettings instance.

Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.Determines whether the specified object is equal to the current object.

(Hérité de Object)
GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Hérité de Object)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
Reset()

Réinitialise les membres de la classe de paramètres à leurs valeurs par défaut.Resets the members of the settings class to their default values.

ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Hérité de Object)

S’applique à