Freigeben über

XmlTextWriter.WriteStartDocument Methode

  • Referenz

Definition

Namespace:
System.Xml
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll

Schreibt die XML-Deklaration mit der Version "1.0".

Überlädt

WriteStartDocument()

Schreibt die XML-Deklaration mit der Version "1.0".
WriteStartDocument(Boolean)

Schreibt die XML-Deklaration mit der Version "1.0" und dem eigenständigen Attribut.

Hinweise

Hinweis

Ab dem .NET Framework 2.0 empfehlen wir, Instanzen mithilfe der Methode und der XmlWriter.Create XmlWriterSettings Klasse zu erstellenXmlWriter, um neue Funktionen zu nutzen.

WriteStartDocument()

Schreibt die XML-Deklaration mit der Version "1.0".

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

Ausnahmen

InvalidOperationException

Dies ist nicht die erste nach dem Konstruktor aufgerufene Schreibmethode.

Beispiele

Im folgenden Beispiel wird eine XML-Datei geschrieben, die ein Buch darstellt.

#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

Hinweise

Hinweis

Ab dem .NET Framework 2.0 empfehlen wir, Instanzen mithilfe der Methode und der XmlWriter.Create XmlWriterSettings Klasse zu erstellenXmlWriter, um neue Funktionen zu nutzen.

Die Codierungsebene des Dokuments wird durch die Implementierung des Autors bestimmt. Wenn beispielsweise ein Encoding Objekt im XmlTextWriter Konstruktor angegeben wird, bestimmt dies den Wert des Codierungsattributes. Diese Methode erstellt kein eigenständiges Attribut.

Wenn WriteStartDocument der Autor aufgerufen wird, überprüft, dass das, was Sie schreiben, ein gut gebildetes XML-Dokument ist. Sie überprüft beispielsweise, dass die XML-Deklaration der erste Knoten ist, dass ein und nur ein Stammelement vorhanden ist und so weiter. Wenn diese Methode nicht aufgerufen wird, geht der Writer davon aus, dass ein XML-Fragment geschrieben wird und keine Regeln auf Stammebene angewendet werden.

Wenn WriteStartDocument sie aufgerufen wurde und die WriteProcessingInstruction Methode zum Erstellen einer anderen XML-Deklaration verwendet wird, wird eine Ausnahme ausgelöst.

Gilt für

WriteStartDocument(Boolean)

Schreibt die XML-Deklaration mit der Version "1.0" und dem eigenständigen Attribut.

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

Parameter

standalone
Boolean

Wenn true, wird "standalone=yes" geschrieben, wenn false, wird "standalone=no" geschrieben.

Ausnahmen

InvalidOperationException

Dies ist nicht die erste nach dem Konstruktor aufgerufene Schreibmethode.

Hinweise

Hinweis

Ab dem .NET Framework 2.0 empfehlen wir, Instanzen mithilfe der XmlWriter.Create Methode und der XmlWriterSettings Klasse zu erstellenXmlWriter, um neue Funktionen zu nutzen.

Die Codierungsebene des Dokuments wird durch die Implementierung des Writers bestimmt. Wenn beispielsweise ein Encoding Objekt im XmlTextWriter Konstruktor angegeben wird, bestimmt dies den Wert des Codierungsattributes.

Wenn WriteStartDocument der Writer aufgerufen wird, überprüft, ob es sich bei der Erstellung um ein gut gebildetes XML-Dokument handelt. Sie überprüft beispielsweise, ob die XML-Deklaration der erste Knoten ist, dass ein und nur ein Element auf Stammebene vorhanden ist usw. Wenn diese Methode nicht aufgerufen wird, geht der Writer davon aus, dass ein XML-Fragment geschrieben wird und keine Regeln auf Stammebene angewendet werden.

Wenn WriteStartDocument sie aufgerufen wurde und die WriteProcessingInstruction Methode zum Erstellen einer anderen XML-Deklaration verwendet wird, wird eine Ausnahme ausgelöst.

Gilt für