XmlTextWriter.WriteStartDocument メソッド

定義

バージョン "1.0" で XML 宣言を書き込みます。Writes the XML declaration with the version "1.0".

オーバーロード

WriteStartDocument()

バージョン "1.0" で XML 宣言を書き込みます。Writes the XML declaration with the version "1.0".

WriteStartDocument(Boolean)

バージョン "1.0" とスタントアロン属性を使用して XML 宣言を書き込みます。Writes the XML declaration with the version "1.0" and the standalone attribute.

注釈

注意

.NET Framework 2.0 以降では、新しい機能を利用するXmlWriterために、 XmlWriter.CreateメソッドとXmlWriterSettingsクラスを使用してインスタンスを作成することをお勧めします。Starting with the .NET Framework 2.0, we recommend that you create XmlWriter instances by using the XmlWriter.Create method and the XmlWriterSettings class to take advantage of new functionality.

WriteStartDocument()

バージョン "1.0" で XML 宣言を書き込みます。Writes the XML declaration with the version "1.0".

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

例外

これは、コンストラクターの後に呼び出された最初の書き込みメソッドではありません。This is not the first write method called after the constructor.

次の例では、書籍を表す XML ファイルを書き込みます。The following example writes an XML file representing a book.

#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

注釈

注意

.NET Framework 2.0 以降では、新しい機能を利用するXmlWriterために、 XmlWriter.CreateメソッドとXmlWriterSettingsクラスを使用してインスタンスを作成することをお勧めします。Starting with the .NET Framework 2.0, we recommend that you create XmlWriter instances by using the XmlWriter.Create method and the XmlWriterSettings class to take advantage of new functionality.

ドキュメントのエンコーディングレベルは、ライターの実装方法によって決まります。The encoding level of the document is determined by how the writer is implemented. たとえば、 Encoding XmlTextWriterコンストラクターにオブジェクトが指定されている場合、encoding 属性の値が決定されます。For example, if an Encoding object is specified in the XmlTextWriter constructor, this determines the value of the encoding attribute. このメソッドでは、スタンドアロン属性は作成されません。This method does not create a standalone attribute.

WriteStartDocument呼び出されると、ライターは、記述しているものが整形式の XML ドキュメントであることを検証します。When WriteStartDocument is called the writer validates that what you are writing is a well-formed XML document. たとえば、XML 宣言が最初のノードであること、ルートレベルの要素が1つだけ存在することを確認します。For example, it checks that the XML declaration is the first node, that one and only one root-level element exists and so on. このメソッドが呼び出されない場合、ライターは XML フラグメントが記述されていると想定し、ルートレベルの規則は適用しません。If this method is not called, the writer assumes an XML fragment is being written and applies no root level rules.

WriteStartDocument呼び出されている場合、 WriteProcessingInstructionメソッドを使用して別の XML 宣言を作成すると、例外がスローされます。If WriteStartDocument has been called and then the WriteProcessingInstruction method is used to create another XML declaration, an exception is thrown.

WriteStartDocument(Boolean)

バージョン "1.0" とスタントアロン属性を使用して XML 宣言を書き込みます。Writes the XML declaration with the version "1.0" and the standalone attribute.

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

パラメーター

standalone
Boolean

true の場合は "standalone=yes"、false の場合は "standalone=no" を書き込みます。If true, it writes "standalone=yes"; if false, it writes "standalone=no".

例外

これは、コンストラクターの後に呼び出された最初の書き込みメソッドではありません。This is not the first write method called after the constructor.

注釈

注意

.NET Framework 2.0 以降では、新しい機能を利用するXmlWriterために、 XmlWriter.CreateメソッドとXmlWriterSettingsクラスを使用してインスタンスを作成することをお勧めします。Starting with the .NET Framework 2.0, we recommend that you create XmlWriter instances by using the XmlWriter.Create method and the XmlWriterSettings class to take advantage of new functionality.

ドキュメントのエンコーディングレベルは、ライターの実装方法によって決まります。The encoding level of the document is determined by how the writer is implemented. たとえば、 Encoding XmlTextWriterコンストラクターにオブジェクトが指定されている場合、encoding 属性の値が決定されます。For example, if an Encoding object is specified in the XmlTextWriter constructor, this determines the value of the encoding attribute.

WriteStartDocument呼び出されると、ライターは、記述しているものが整形式の XML ドキュメントであることを検証します。When WriteStartDocument is called the writer validates that what you are writing is a well-formed XML document. たとえば、XML 宣言が最初のノードであること、ルートレベルの要素が1つだけ存在することを確認します。For example, it checks that the XML declaration is the first node, that one and only one root-level element exists and so on. このメソッドが呼び出されない場合、ライターは XML フラグメントが記述されていると想定し、ルートレベルの規則は適用しません。If this method is not called, the writer assumes an XML fragment is being written and applies no root level rules.

WriteStartDocument呼び出されている場合、 WriteProcessingInstructionメソッドを使用して別の XML 宣言を作成すると、例外がスローされます。If WriteStartDocument has been called and then the WriteProcessingInstruction method is used to create another XML declaration, an exception is thrown.

適用対象