XmlWriter.WriteDocType メソッド

.NET Framework クラス ライブラリ リファレンス

XmlWriter.WriteDocType メソッド

派生クラスでオーバーライドされると、指定した名前とオプションの属性を含む DOCTYPE 宣言を書き込みます。

名前空間: System.Xml
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public MustOverride Sub
 WriteDocType ( _
    name As String, _
    pubid As String, _
    sysid As String, _
    subset As String _
)

Visual Basic (使用法)

Dim instance As XmlWriter
Dim name As String
Dim pubid As String
Dim sysid As String
Dim subset As String

instance.WriteDocType(name, pubid, sysid, subset)

C#

public abstract void WriteDocType (
    string name,
    string pubid,
    string sysid,
    string subset
)

C++

public:
virtual void WriteDocType (
    String^ name, 
    String^ pubid, 
    String^ sysid, 
    String^ subset
) abstract

J#

public abstract void WriteDocType (
    String name, 
    String pubid, 
    String sysid, 
    String subset
)

JScript

public abstract function WriteDocType (
    name : String, 
    pubid : String, 
    sysid : String, 
    subset : String
)

パラメータ

name

DOCTYPE の名前。これを空にすることはできません。

pubid

null でない場合は、PUBLIC "pubid" "sysid" も書き込みます。pubid と sysid は、指定した引数の値に置き換えられます。

sysid

pubid が null 参照 (Visual Basic では Nothing) で sysid が null でない場合は、SYSTEM "sysid" を書き込みます。sysid は、この引数の値に置き換えられます。

subset

null でない場合は、[subset] を書き込みます。subset は、この引数の値に置き換えられます。

例外

例外の種類	条件
InvalidOperationException	このメソッドが、プロローグの外 (ルート要素の後) で呼び出されました。
ArgumentException	name の値が、無効な XML になることがあります。

解説

このメソッドは、pubid、sysid、または subset に無効な文字があるかどうかを確認しません。また、内部サブセットが整形式かどうかも確認しません。

セキュリティに関するメモ
XmlWriter は、WriteDocType メソッドに渡されるデータの検証を行いません。このメソッドに任意のデータを渡さないでください。

Windows Mobile for Pocket PC、Windows Mobile for Smartphone、Windows CE プラットフォームメモ : このメソッドは、Microsoft .NET Compact Framework Version 1.0 には実装されていませんでしたが、Version 2.0 には実装されています。

使用例

book を表す XML ファイルを書き込む例を次に示します。

Visual Basic

Option Strict
Option Explicit

Imports System
Imports System.IO
Imports System.Xml

Public Class Sample
    Private Const filename As
 String = "sampledata.xml"
    
  Public Shared Sub Main()

     Dim settings As XmlWriterSettings = new
 XmlWriterSettings()
     settings.Indent = true
     Dim writer As XmlWriter = XmlWriter.Create(filename,
 settings)
        
     ' Write the Processing Instruction 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 the 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()
        
    End Sub 'Main 
End Class 'Sample

C#

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

public class Sample {

  private const string filename
 = "sampledata.xml";

  public static void Main()
 {
  
     XmlWriterSettings settings = new XmlWriterSettings();
     settings.Indent = true;
     XmlWriter writer = XmlWriter.Create(filename, settings);

     // Write the Processing Instruction 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 the 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();  
  }

}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
XmlWriter クラス
XmlWriter メンバ
System.Xml 名前空間
その他の技術情報
XmlWriter による XML の書き方