XmlWriter.Create Méthode

Définition

Espace de noms:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Crée une instance XmlWriter.

Surcharges

Create(StringBuilder, XmlWriterSettings)	Crée une nouvelle instance de XmlWriter à l'aide des objets StringBuilder et XmlWriterSettings.
Create(String, XmlWriterSettings)	Crée une instance de XmlWriter à l'aide du nom de fichier et de l'objet XmlWriterSettings.
Create(TextWriter, XmlWriterSettings)	Crée une nouvelle instance de XmlWriter à l'aide des objets TextWriter et XmlWriterSettings.
Create(Stream, XmlWriterSettings)	Crée une instance de XmlWriter à l'aide du flux et de l'objet XmlWriterSettings.
Create(XmlWriter, XmlWriterSettings)	Crée une nouvelle instance de XmlWriter à l'aide des objets XmlWriter et XmlWriterSettings spécifiés.
Create(StringBuilder)	Crée une nouvelle instance de XmlWriter à l'aide du StringBuilder spécifié.
Create(String)	Crée une instance de XmlWriter à l'aide du nom de fichier spécifié.
Create(TextWriter)	Crée une nouvelle instance de XmlWriter à l'aide du TextWriter spécifié.
Create(Stream)	Crée une nouvelle instance de XmlWriter à l'aide du flux spécifié.
Create(XmlWriter)	Crée une instance de XmlWriter à l'aide de l'objet XmlWriter spécifié.

Remarques

Certaines surcharges Create incluent un settings paramètre qui accepte un XmlWriterSettings objet. Vous pouvez utiliser cet objet pour :

• Spécifiez les fonctionnalités souhaitées prises en charge sur l’objet créé XmlWriter .

• Réutilisez l’objet XmlWriterSettings pour créer plusieurs objets writer. L'objet XmlWriterSettings est copié et est mis en lecture seule pour chaque writer créé. Les modifications des paramètres d'une instance de l'objet XmlWriterSettings n'affectent pas les paramètres correspondants des writers existants. Par conséquent, vous pouvez utiliser les mêmes paramètres pour créer plusieurs writers avec la même fonctionnalité. Ou vous pouvez modifier les paramètres d’une instance de l’objet XmlWriterSettings et créer un nouveau writer avec différentes fonctionnalités.

• Ajoutez des fonctionnalités à un enregistreur XML existant. La méthode Create peut accepter un autre objet XmlWriter. L’objet sous-jacent XmlWriter n’a pas besoin d’être un enregistreur XML créé par la méthode statique Create . Par exemple, vous pouvez spécifier un enregistreur XML défini par l’utilisateur pour ajouter des fonctionnalités supplémentaires.

• Tirez pleinement parti des fonctionnalités telles que la vérification et la conformité de meilleure conformité à la recommandation XML 1.0 qui sont disponibles uniquement sur XmlWriter les objets créés par la méthode statique Create .

Si vous utilisez une Create surcharge qui n’accepte pas d’objet XmlWriterSettings , les paramètres d’enregistreur par défaut suivants sont utilisés :

Paramètre	Par défaut
CheckCharacters	true
CloseOutput	false
ConformanceLevel	ConformanceLevel.Document
Encoding	Encoding.UTF8
Indent	false
IndentChars	Deux espaces
NamespaceHandling	Default (aucune suppression)
NewLineChars	\r\n (retour chariot, retour à la ligne)
NewLineHandling	NewLineHandling.Replace
NewLineOnAttributes	false
OmitXmlDeclaration	false
OutputMethod	XmlOutputMethod.Xml
WriteEndDocumentOnClose	true

Notes

Bien que le .NET Framework inclut la XmlTextWriter classe, qui est une implémentation concrète de la XmlWriter classe, nous vous recommandons de créer XmlWriter des instances à l’aide de la Create méthode.

Create(StringBuilder, XmlWriterSettings)

Crée une nouvelle instance de XmlWriter à l'aide des objets StringBuilder et XmlWriterSettings.

C#

public static System.Xml.XmlWriter Create (System.Text.StringBuilder output, System.Xml.XmlWriterSettings settings);

C#

public static System.Xml.XmlWriter Create (System.Text.StringBuilder output, System.Xml.XmlWriterSettings? settings);

Paramètres

output

StringBuilder

StringBuilder dans lequel écrire. Le contenu écrit par le XmlWriter est ajouté au StringBuilder.

settings

XmlWriterSettings

Objet XmlWriterSettings permettant de configurer la nouvelle instance de XmlWriter. S'il est null, un XmlWriterSettings avec des paramètres par défaut est utilisé.

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

Retours

XmlWriter

Objet XmlWriter.

Exceptions

ArgumentNullException

builder a la valeur null.

Create(String, XmlWriterSettings)

Crée une instance de XmlWriter à l'aide du nom de fichier et de l'objet XmlWriterSettings.

C#

public static System.Xml.XmlWriter Create (string outputFileName, System.Xml.XmlWriterSettings? settings);

C#

public static System.Xml.XmlWriter Create (string outputFileName, System.Xml.XmlWriterSettings settings);

Paramètres

outputFileName

String

Fichier dans lequel écrire. XmlWriter crée un fichier au chemin d'accès spécifié et y écrit en syntaxe de texte XML 1.0. outputFileName doit être un chemin d'accès de système de fichiers.

settings

XmlWriterSettings

Objet XmlWriterSettings permettant de configurer la nouvelle instance de XmlWriter. S'il est null, un XmlWriterSettings avec des paramètres par défaut est utilisé.

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

Retours

XmlWriter

Objet XmlWriter.

Exceptions

ArgumentNullException

url a la valeur null.

Exemples

L’exemple suivant crée un XmlWriter objet avec les paramètres définis.

C#

using System;
using System.IO;
using System.Xml;
using System.Text;

public class Sample {

  public static void Main() {

    XmlWriter writer = null;

    try {

       // Create an XmlWriterSettings object with the correct options.
       XmlWriterSettings settings = new XmlWriterSettings();
       settings.Indent = true;
       settings.IndentChars = ("\t");
       settings.OmitXmlDeclaration = true;

       // Create the XmlWriter object and write some content.
       writer = XmlWriter.Create("data.xml", settings);
       writer.WriteStartElement("book");
       writer.WriteElementString("item", "tesing");
       writer.WriteEndElement();
    
       writer.Flush();
     }
     finally  {
        if (writer != null)
          writer.Close();
     }
  }
}

Create(TextWriter, XmlWriterSettings)

Crée une nouvelle instance de XmlWriter à l'aide des objets TextWriter et XmlWriterSettings.

C#

public static System.Xml.XmlWriter Create (System.IO.TextWriter output, System.Xml.XmlWriterSettings settings);

C#

public static System.Xml.XmlWriter Create (System.IO.TextWriter output, System.Xml.XmlWriterSettings? settings);

Paramètres

output

TextWriter

TextWriter dans lequel écrire. XmlWriter écrit la syntaxe du texte XML 1.0 et l'ajoute au TextWriter spécifié.

settings

XmlWriterSettings

Objet XmlWriterSettings permettant de configurer la nouvelle instance de XmlWriter. S'il est null, un XmlWriterSettings avec des paramètres par défaut est utilisé.

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

Retours

XmlWriter

Objet XmlWriter.

Exceptions

ArgumentNullException

text a la valeur null.

Exemples

L’exemple suivant écrit une chaîne XML.

C#

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
StringWriter sw = new StringWriter();

using (XmlWriter writer = XmlWriter.Create(sw, settings))
{
    writer.WriteStartElement("book");
    writer.WriteElementString("price", "19.95");
    writer.WriteEndElement();
    writer.Flush();

    String output = sw.ToString();
}

Create(Stream, XmlWriterSettings)

Crée une instance de XmlWriter à l'aide du flux et de l'objet XmlWriterSettings.

C#

public static System.Xml.XmlWriter Create (System.IO.Stream output, System.Xml.XmlWriterSettings settings);

C#

public static System.Xml.XmlWriter Create (System.IO.Stream output, System.Xml.XmlWriterSettings? settings);

Paramètres

output

Stream

Flux dans lequel vous voulez écrire. XmlWriter écrit la syntaxe du texte XML 1.0 et l'ajoute au flux de données spécifié.

settings

XmlWriterSettings

Objet XmlWriterSettings permettant de configurer la nouvelle instance de XmlWriter. S'il est null, un XmlWriterSettings avec des paramètres par défaut est utilisé.

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

Retours

XmlWriter

Objet XmlWriter.

Exceptions

ArgumentNullException

stream a la valeur null.

Exemples

L’exemple suivant écrit un fragment XML dans un flux de mémoire.

C#

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");
writer.Flush();
writer.Close();

// Do additional processing on the stream.

Remarques

XmlWriter écrit toujours une marque d’ordre d’octet (BOM) dans le flux de données sous-jacent ; toutefois, certains flux ne doivent pas avoir de boM. Pour omettre le boM, créez un XmlWriterSettings objet et définissez la propriété Encoding comme un nouvel UTF8Encoding objet avec la valeur booléenne dans le constructeur défini sur false.

Create(XmlWriter, XmlWriterSettings)

Crée une nouvelle instance de XmlWriter à l'aide des objets XmlWriter et XmlWriterSettings spécifiés.

C#

public static System.Xml.XmlWriter Create (System.Xml.XmlWriter output, System.Xml.XmlWriterSettings settings);

C#

public static System.Xml.XmlWriter Create (System.Xml.XmlWriter output, System.Xml.XmlWriterSettings? settings);

Paramètres

output

XmlWriter

L'objet XmlWriter à utiliser comme writer sous-jacent.

settings

XmlWriterSettings

Objet XmlWriterSettings permettant de configurer la nouvelle instance de XmlWriter. S'il est null, un XmlWriterSettings avec des paramètres par défaut est utilisé.

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

Retours

XmlWriter

Objet XmlWriter autour de l'objet XmlWriter spécifié.

Exceptions

ArgumentNullException

writer a la valeur null.

Remarques

Cette méthode vous permet d’ajouter des fonctionnalités supplémentaires à un objet sous-jacent XmlWriter . L’objet sous-jacent XmlWriter peut être un objet créé par la XmlWriter.Create méthode ou un objet créé à l’aide de l’implémentation XmlTextWriter .

Create(StringBuilder)

Crée une nouvelle instance de XmlWriter à l'aide du StringBuilder spécifié.

C#

public static System.Xml.XmlWriter Create (System.Text.StringBuilder output);

Paramètres

output

StringBuilder

StringBuilder dans lequel écrire. Le contenu écrit par le XmlWriter est ajouté au StringBuilder.

Retours

XmlWriter

Objet XmlWriter.

Exceptions

ArgumentNullException

builder a la valeur null.

Remarques

Lorsque vous utilisez cette surcharge, un XmlWriterSettings objet avec des paramètres par défaut est utilisé pour créer l’enregistreur XML.

Paramètre	Par défaut
CheckCharacters	true
CloseOutput	false
ConformanceLevel	ConformanceLevel.Document
Encoding	Encoding.UTF8
Indent	false
IndentChars	Deux espaces
NamespaceHandling	Default (aucune suppression)
NewLineChars	\r\n (retour chariot, retour à la ligne)
NewLineHandling	NewLineHandling.Replace
NewLineOnAttributes	false
OmitXmlDeclaration	false
OutputMethod	XmlOutputMethod.Xml
WriteEndDocumentOnClose	true

Si vous souhaitez spécifier les fonctionnalités à prendre en charge sur l’enregistreur XML créé, utilisez une surcharge qui prend un XmlWriterSettings objet comme l’un de ses arguments et transmettez un XmlWriterSettings objet avec vos paramètres personnalisés.

Create(String)

Crée une instance de XmlWriter à l'aide du nom de fichier spécifié.

C#

public static System.Xml.XmlWriter Create (string outputFileName);

Paramètres

outputFileName

String

Fichier dans lequel écrire. XmlWriter crée un fichier au chemin d'accès spécifié et y écrit en syntaxe de texte XML 1.0. outputFileName doit être un chemin d'accès de système de fichiers.

Retours

XmlWriter

Objet XmlWriter.

Exceptions

ArgumentNullException

url a la valeur null.

Exemples

L’exemple suivant crée un XmlWriter objet et écrit un nœud de livre.

C#

using (XmlWriter writer = XmlWriter.Create("output.xml"))
{
    writer.WriteStartElement("book");
    writer.WriteElementString("price", "19.95");
    writer.WriteEndElement();
    writer.Flush();
}

Remarques

Lorsque vous utilisez cette surcharge, un XmlWriterSettings objet avec des paramètres par défaut est utilisé pour créer l’enregistreur XML.

Paramètre	Par défaut
CheckCharacters	true
CloseOutput	false
ConformanceLevel	ConformanceLevel.Document
Encoding	Encoding.UTF8
Indent	false
IndentChars	Deux espaces
NamespaceHandling	Default (aucune suppression)
NewLineChars	\r\n (retour chariot, retour à la ligne)
NewLineHandling	NewLineHandling.Replace
NewLineOnAttributes	false
OmitXmlDeclaration	false
OutputMethod	XmlOutputMethod.Xml
WriteEndDocumentOnClose	true

Si vous souhaitez spécifier les fonctionnalités à prendre en charge sur l’enregistreur XML créé, utilisez une surcharge qui prend un objet comme l’un XmlWriterSettings de ses arguments et transmettez un XmlWriterSettings objet avec vos paramètres personnalisés.

Create(TextWriter)

Crée une nouvelle instance de XmlWriter à l'aide du TextWriter spécifié.

C#

public static System.Xml.XmlWriter Create (System.IO.TextWriter output);

Paramètres

output

TextWriter

TextWriter dans lequel écrire. XmlWriter écrit la syntaxe du texte XML 1.0 et l'ajoute au TextWriter spécifié.

Retours

XmlWriter

Objet XmlWriter.

Exceptions

ArgumentNullException

text a la valeur null.

Exemples

L’exemple suivant crée un enregistreur qui s’affiche dans la console.

C#

using (XmlWriter writer = XmlWriter.Create(Console.Out))
{
    writer.WriteStartElement("book");
    writer.WriteElementString("price", "19.95");
    writer.WriteEndElement();
    writer.Flush();
}

Remarques

Lorsque vous utilisez cette surcharge, un XmlWriterSettings objet avec des paramètres par défaut est utilisé pour créer l’enregistreur XML.

Paramètre	Par défaut
CheckCharacters	true
CloseOutput	false
ConformanceLevel	ConformanceLevel.Document
Encoding	Encoding.UTF8
Indent	false
IndentChars	Deux espaces
NamespaceHandling	Default (aucune suppression)
NewLineChars	\r\n (retour chariot, retour à la ligne)
NewLineHandling	NewLineHandling.Replace
NewLineOnAttributes	false
OmitXmlDeclaration	false
OutputMethod	XmlOutputMethod.Xml
WriteEndDocumentOnClose	true

Si vous souhaitez spécifier les fonctionnalités à prendre en charge sur l’enregistreur créé, utilisez une surcharge qui prend un objet comme l’un XmlWriterSettings de ses arguments et transmettez un XmlWriterSettings objet avec vos paramètres personnalisés.

Create(Stream)

Crée une nouvelle instance de XmlWriter à l'aide du flux spécifié.

C#

public static System.Xml.XmlWriter Create (System.IO.Stream output);

Paramètres

output

Stream

Flux dans lequel vous voulez écrire. XmlWriter écrit la syntaxe du texte XML 1.0 et l'ajoute au flux de données spécifié.

Retours

XmlWriter

Objet XmlWriter.

Exceptions

ArgumentNullException

stream a la valeur null.

Exemples

L’exemple suivant écrit un fragment XML dans un flux de mémoire. (Il utilise la Create(Stream, XmlWriterSettings) surcharge, qui configure également les paramètres sur la nouvelle instance d’enregistreur XML.)

C#

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");
writer.Flush();
writer.Close();

// Do additional processing on the stream.

Remarques

Lorsque vous utilisez cette surcharge, un XmlWriterSettings objet avec les paramètres par défaut suivants est utilisé pour créer l’enregistreur XML :

Paramètre	Par défaut
CheckCharacters	true
CloseOutput	false
ConformanceLevel	ConformanceLevel.Document
Encoding	Encoding.UTF8
Indent	false
IndentChars	Deux espaces
NamespaceHandling	Default (aucune suppression)
NewLineChars	\r\n (retour chariot, retour à la ligne)
NewLineHandling	NewLineHandling.Replace
NewLineOnAttributes	false
OmitXmlDeclaration	false
OutputMethod	XmlOutputMethod.Xml
WriteEndDocumentOnClose	true

Si vous souhaitez spécifier les fonctionnalités à prendre en charge sur l’enregistreur créé, utilisez une surcharge qui prend un objet comme l’un XmlWriterSettings de ses arguments et transmettez un XmlWriterSettings objet avec vos paramètres personnalisés.

De plus, XmlWriter écrit toujours une marque d’ordre d’octet (BOM) dans le flux de données sous-jacent ; toutefois, certains flux ne doivent pas avoir de boM. Pour omettre le boM, créez un XmlWriterSettings objet et définissez la propriété Encoding sur un nouvel UTF8Encoding objet avec la valeur booléenne dans le constructeur défini sur false.

Create(XmlWriter)

Crée une instance de XmlWriter à l'aide de l'objet XmlWriter spécifié.

C#

public static System.Xml.XmlWriter Create (System.Xml.XmlWriter output);

Paramètres

output

XmlWriter

L'objet XmlWriter à utiliser comme writer sous-jacent.

Retours

XmlWriter

Objet XmlWriter autour de l'objet XmlWriter spécifié.

Exceptions

ArgumentNullException

writer a la valeur null.

Remarques

Cette méthode vous permet d’ajouter des fonctionnalités à un objet sous-jacent XmlWriter . L’objet sous-jacent XmlWriter peut être un objet créé par la XmlWriter.Create méthode ou un objet créé à l’aide de l’implémentation XmlTextWriter .

Lorsque vous utilisez cette surcharge, un XmlWriterSettings objet avec des paramètres par défaut est utilisé pour créer l’enregistreur XML.

Paramètre	Par défaut
CheckCharacters	true
CloseOutput	false
ConformanceLevel	ConformanceLevel.Document
Encoding	Encoding.UTF8
Indent	false
IndentChars	Deux espaces
NamespaceHandling	Default (aucune suppression)
NewLineChars	\r\n (retour chariot, retour à la ligne)
NewLineHandling	NewLineHandling.Replace
NewLineOnAttributes	false
OmitXmlDeclaration	false
OutputMethod	XmlOutputMethod.Xml
WriteEndDocumentOnClose	true

Si vous souhaitez spécifier les fonctionnalités à prendre en charge sur l’enregistreur XML créé, utilisez une surcharge qui prend un XmlWriterSettings objet comme l’un de ses arguments et transmettez un XmlWriterSettings objet avec vos paramètres personnalisés.