Cet article a fait l’objet d’une traduction automatique. Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez également afficher le texte anglais dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte traduit.
Traduction
Anglais

XmlWriterSettings classe

 

Date de publication : novembre 2016

Spécifie un ensemble de fonctionnalités pour prendre en charge sur les XmlWriter objet créé par le XmlWriter.Create (méthode).

Espace de noms:   System.Xml
Assembly:  System.Xml (dans System.Xml.dll)

System.Object
  System.Xml.XmlWriterSettings

[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public sealed class XmlWriterSettings

NomDescription
System_CAPS_pubmethodXmlWriterSettings()

Initialise une nouvelle instance de la classe XmlWriterSettings.

NomDescription
System_CAPS_pubpropertyAsync

Obtient ou définit une valeur qui indique si asynchrone XmlWriter méthodes peuvent être utilisées sur un rôle particulier XmlWriter instance.

System_CAPS_pubpropertyCheckCharacters

Obtient ou définit une valeur qui indique si le writer XML doit vérifier pour vous assurer que tous les caractères dans le document sont conformes à la section « 2.2 Characters » de la W3C XML 1.0 Recommendation.

System_CAPS_pubpropertyCloseOutput

Obtient ou définit une valeur indiquant si le XmlWriter doit également fermer le flux sous-jacent ou TextWriter lors de la Close méthode est appelée.

System_CAPS_pubpropertyConformanceLevel

Obtient ou définit le niveau de conformité de vérification de sortie XML du writer XML.

System_CAPS_pubpropertyDoNotEscapeUriAttributes

Obtient ou définit une valeur qui indique si le XmlWriter n’échappe pas les attributs d’URI.

System_CAPS_pubpropertyEncoding

Obtient ou définit le type d'encodage de texte à utiliser.

System_CAPS_pubpropertyIndent

Obtient ou définit une valeur indiquant si les éléments doivent être mis en retrait.

System_CAPS_pubpropertyIndentChars

Obtient ou définit la chaîne de caractères à utiliser au moment de la mise en retrait. Ce paramètre est utilisé lorsque le Indent est définie sur true.

System_CAPS_pubpropertyNamespaceHandling

Obtient ou définit une valeur qui indique si le XmlWriter doit supprimer les 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.

System_CAPS_pubpropertyNewLineChars

Obtient ou définit la chaîne de caractères à utiliser pour les sauts de ligne.

System_CAPS_pubpropertyNewLineHandling

Obtient ou définit une valeur indiquant s'il convient de normaliser des sauts de ligne dans la sortie.

System_CAPS_pubpropertyNewLineOnAttributes

Obtient ou définit une valeur indiquant s'il convient d'écrire des attributs sur une nouvelle ligne.

System_CAPS_pubpropertyOmitXmlDeclaration

Obtient ou définit une valeur indiquant si une déclaration XML doit être omise.

System_CAPS_pubpropertyOutputMethod

Obtient la méthode utilisée pour sérialiser le XmlWriter sortie.

System_CAPS_pubpropertyWriteEndDocumentOnClose

Obtient ou définit une valeur qui indique si le XmlWriter ajoute des balises élément non toutes les balises de fin lorsque la Close méthode est appelée.

NomDescription
System_CAPS_pubmethodClone()

Crée une copie de l'instance XmlWriterSettings.

System_CAPS_pubmethodEquals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.(Hérité de Object.)

System_CAPS_pubmethodGetHashCode()

Fait office de fonction de hachage par défaut.(Hérité de Object.)

System_CAPS_pubmethodGetType()

Obtient le Type de l'instance actuelle.(Hérité de Object.)

System_CAPS_pubmethodReset()

Réinitialise les membres de la classe de paramètres à leurs valeurs par défaut.

System_CAPS_pubmethodToString()

Retourne une chaîne qui représente l'objet actuel.(Hérité de Object.)

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

System_CAPS_noteRemarque

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

La XmlWriterSettings classe fournit des propriétés ce format de données contrôle mise en conformité et de sortie.

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

Property

Informations fournies

Valeur

default

CheckCharacters

S’il faut vérifier que les caractères sont dans le code XML juridique caractère ensemble, comme défini par le W3C.

true ou false

true

ConformanceLevel

Si vous souhaitez vérifier que la sortie est un document XML 1.0 correctement construit ou un fragment.

ConformanceLevel.Document (au niveau du document), Fragment (au niveau du fragment), ou Auto (détection automatique)

ConformanceLevel.Document (la conformité au niveau du document)

WriteEndDocumentOnClose

Si vous souhaitez ajouter des balises de fermeture à 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 :

Property

Informations fournies

Valeur

default

Encoding

Encodage de texte à utiliser.

Valeur System.Text.Encoding

Encoding.UTF8

Indent

S’il faut mettre en retrait des éléments

true ou false

false (aucune mise en retrait)

IndentChars

Chaîne à utiliser lors de la mise en retrait de caractères (utilisée lorsque 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, saut de ligne)

NewLineHandling

Comment gérer les caractères de saut de ligne.

System.Xml.NewLineHandling valeur : Entitize (normaliser), Replace (remplacez) ou None (laisser inchangé)

Replace (Remplacez par les caractères spécifiés par NewLineChars)

NewLineOnAttributes

S’il faut écrire des attributs sur des lignes individuelles (n’a aucun effet lorsque Indent est false).

true ou false

false

OmitXmlDeclaration

Si vous souhaitez écrire une déclaration XML.

true ou false

false

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();

L’exemple génère la sortie suivante :

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

Plateforme Windows universelle
Disponible depuis 8
.NET Framework
Disponible depuis 2.0
Bibliothèque de classes portable
Pris en charge dans : plateformes .NET portables
Silverlight
Disponible depuis 2.0
Silverlight pour Windows Phone
Disponible depuis 7.0
Windows Phone
Disponible depuis 8.1

Tous les membres statiques publics ( Shared en Visual Basic) de ce type sont thread-safe. Les membres d’instance n’ont pas la garantie d’être thread-safe.

Retour au début
Afficher: