XmlTextWriter.WriteStartDocument Méthode

Définition

Écrit la déclaration XML avec la version "1.0".

Surcharges

WriteStartDocument()

Écrit la déclaration XML avec la version "1.0".

WriteStartDocument(Boolean)

Écrit la déclaration XML avec la version "1.0" et l'attribut autonome.

Remarques

Notes

À compter de la .NET Framework 2.0, nous vous recommandons de créer XmlWriter des instances à l’aide de la méthode et de la XmlWriter.Create XmlWriterSettings classe pour tirer parti de nouvelles fonctionnalités.

WriteStartDocument()

Écrit la déclaration XML avec la version "1.0".

public:
 override void WriteStartDocument();
public override void WriteStartDocument ();
override this.WriteStartDocument : unit -> unit
Public Overrides Sub WriteStartDocument ()

Exceptions

Il ne s'agit pas de la première méthode d'écriture appelée à la suite du constructeur.

Exemples

L’exemple suivant écrit un fichier XML représentant un livre.

#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlTextWriter^ writer = nullptr;
   String^ filename = "sampledata.xml";
   writer = gcnew XmlTextWriter( filename, nullptr );
   
   //Use indenting for readability.
   writer->Formatting = Formatting::Indented;
   
   //Write the XML delcaration. 
   writer->WriteStartDocument();
   
   //Write the ProcessingInstruction node.
   String^ PItext = "type='text/xsl' href='book.xsl'";
   writer->WriteProcessingInstruction( "xml-stylesheet", PItext );
   
   //Write the DocumentType node.
   writer->WriteDocType( "book", nullptr, nullptr, "<!ENTITY h 'hardcover'>" );
   
   //Write a Comment node.
   writer->WriteComment( "sample XML" );
   
   //Write a root element.
   writer->WriteStartElement( "book" );
   
   //Write the genre attribute.
   writer->WriteAttributeString( "genre", "novel" );
   
   //Write the ISBN attribute.
   writer->WriteAttributeString( "ISBN", "1-8630-014" );
   
   //Write the title.
   writer->WriteElementString( "title", "The Handmaid's Tale" );
   
   //Write the style element.
   writer->WriteStartElement( "style" );
   writer->WriteEntityRef( "h" );
   writer->WriteEndElement();
   
   //Write the price.
   writer->WriteElementString( "price", "19.95" );
   
   //Write CDATA.
   writer->WriteCData( "Prices 15% off!!" );
   
   //Write the close tag for the root element.
   writer->WriteEndElement();
   writer->WriteEndDocument();
   
   //Write the XML to file and close the writer.
   writer->Flush();
   writer->Close();
   
   //Load the file into an XmlDocument to ensure well formed XML.
   XmlDocument^ doc = gcnew XmlDocument;
   
   //Preserve white space for readability.
   doc->PreserveWhitespace = true;
   
   //Load the file.
   doc->Load( filename );
   
   //Display the XML content to the console.
   Console::Write( doc->InnerXml );
}
using System;
using System.IO;
using System.Xml;

public class Sample
{
  private const string filename = "sampledata.xml";

  public static void Main()
  {
     XmlTextWriter writer = null;

     writer = new XmlTextWriter (filename, null);
     //Use indenting for readability.
     writer.Formatting = Formatting.Indented;

     //Write the XML delcaration.
     writer.WriteStartDocument();

     //Write the ProcessingInstruction node.
     String PItext="type='text/xsl' href='book.xsl'";
     writer.WriteProcessingInstruction("xml-stylesheet", PItext);

     //Write the DocumentType node.
     writer.WriteDocType("book", null , null, "<!ENTITY h 'hardcover'>");

     //Write a Comment node.
     writer.WriteComment("sample XML");

     //Write a root element.
     writer.WriteStartElement("book");

     //Write the genre attribute.
     writer.WriteAttributeString("genre", "novel");

     //Write the ISBN attribute.
     writer.WriteAttributeString("ISBN", "1-8630-014");

     //Write the title.
     writer.WriteElementString("title", "The Handmaid's Tale");

     //Write the style element.
     writer.WriteStartElement("style");
     writer.WriteEntityRef("h");
     writer.WriteEndElement();

     //Write the price.
     writer.WriteElementString("price", "19.95");

     //Write CDATA.
     writer.WriteCData("Prices 15% off!!");

     //Write the close tag for the root element.
     writer.WriteEndElement();

     writer.WriteEndDocument();

     //Write the XML to file and close the writer.
     writer.Flush();
     writer.Close();

     //Load the file into an XmlDocument to ensure well formed XML.
     XmlDocument doc = new XmlDocument();
     //Preserve white space for readability.
     doc.PreserveWhitespace = true;
     //Load the file.
     doc.Load(filename);

     //Display the XML content to the console.
     Console.Write(doc.InnerXml);
  }
}
Option Explicit
Option Strict

Imports System.IO
Imports System.Xml

Public Class Sample
    Private Shared filename As String = "sampledata.xml"
    Public Shared Sub Main()
        Dim writer As XmlTextWriter = Nothing
        
        writer = New XmlTextWriter(filename, Nothing)
        'Use indenting for readability.
        writer.Formatting = Formatting.Indented
        
        'Write the XML delcaration. 
        writer.WriteStartDocument()
        
        'Write the ProcessingInstruction node.
        Dim PItext As String = "type='text/xsl' href='book.xsl'"
        writer.WriteProcessingInstruction("xml-stylesheet", PItext)
        
        'Write the DocumentType node.
        writer.WriteDocType("book", Nothing, Nothing, "<!ENTITY h 'hardcover'>")
        
        'Write a Comment node.
        writer.WriteComment("sample XML")
        
        'Write a root element.
        writer.WriteStartElement("book")
        
        'Write the genre attribute.
        writer.WriteAttributeString("genre", "novel")
        
        'Write the ISBN attribute.
        writer.WriteAttributeString("ISBN", "1-8630-014")
        
        'Write the title.
        writer.WriteElementString("title", "The Handmaid's Tale")
        
        'Write the style element.
        writer.WriteStartElement("style")
        writer.WriteEntityRef("h")
        writer.WriteEndElement()
        
        'Write the price.
        writer.WriteElementString("price", "19.95")
        
        'Write CDATA.
        writer.WriteCData("Prices 15% off!!")
        
        'Write the close tag for the root element.
        writer.WriteEndElement()
        
        writer.WriteEndDocument()
        
        'Write the XML to file and close the writer.
        writer.Flush()
        writer.Close()
        
        'Load the file into an XmlDocument to ensure well formed XML.
        Dim doc As New XmlDocument()
        'Preserve white space for readability.
        doc.PreserveWhitespace = True
        'Load the file.
        doc.Load(filename)
        
        'Display the XML content to the console.
        Console.Write(doc.InnerXml)
    End Sub
End Class

Remarques

Notes

À compter de la .NET Framework 2.0, nous vous recommandons de créer XmlWriter des instances à l’aide de la méthode et de la XmlWriter.Create XmlWriterSettings classe pour tirer parti de nouvelles fonctionnalités.

Le niveau d’encodage du document est déterminé par la façon dont l’enregistreur est implémenté. Par exemple, si un Encoding objet est spécifié dans le XmlTextWriter constructeur, cela détermine la valeur de l’attribut d’encodage. Cette méthode ne crée pas d’attribut autonome.

Quand WriteStartDocument on appelle l’enregistreur valide que ce que vous écrivez est un document XML bien formé. Par exemple, il vérifie que la déclaration XML est le premier nœud, qu’un seul élément de niveau racine existe et ainsi de suite. Si cette méthode n’est pas appelée, l’enregistreur suppose qu’un fragment XML est écrit et n’applique aucune règle de niveau racine.

Si WriteStartDocument elle a été appelée et que la WriteProcessingInstruction méthode est utilisée pour créer une autre déclaration XML, une exception est levée.

S’applique à

WriteStartDocument(Boolean)

Écrit la déclaration XML avec la version "1.0" et l'attribut autonome.

public:
 override void WriteStartDocument(bool standalone);
public override void WriteStartDocument (bool standalone);
override this.WriteStartDocument : bool -> unit
Public Overrides Sub WriteStartDocument (standalone As Boolean)

Paramètres

standalone
Boolean

Si la valeur est true, elle écrit "standalone=yes"; si la valeur est false, elle écrit "standalone=no".

Exceptions

Il ne s'agit pas de la première méthode d'écriture appelée à la suite du constructeur.

Remarques

Notes

À compter de la .NET Framework 2.0, nous vous recommandons de créer XmlWriter des instances à l’aide de la XmlWriter.Create méthode et de la XmlWriterSettings classe pour tirer parti de nouvelles fonctionnalités.

Le niveau d’encodage du document est déterminé par la façon dont l’enregistreur est implémenté. Par exemple, si un Encoding objet est spécifié dans le XmlTextWriter constructeur, cela détermine la valeur de l’attribut d’encodage.

Lorsqu’on WriteStartDocument appelle l’enregistreur, l’enregistreur valide que ce que vous écrivez est un document XML bien formé. Par exemple, il vérifie que la déclaration XML est le premier nœud, qu’un seul élément de niveau racine existe et ainsi de suite. Si cette méthode n’est pas appelée, l’enregistreur suppose qu’un fragment XML est écrit et n’applique aucune règle de niveau racine.

Si WriteStartDocument elle a été appelée et que la WriteProcessingInstruction méthode est utilisée pour créer une autre déclaration XML, une exception est levée.

S’applique à