.NET Framework Class Library
XmlWriter..::.WriteDocType Method

When overridden in a derived class, writes the DOCTYPE declaration with the specified name and optional attributes.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)
Syntax

Visual Basic (Declaration)
Public MustOverride Sub WriteDocType ( _
    name As String, _
    pubid As String, _
    sysid As String, _
    subset As String _
)
Visual Basic (Usage)
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
)
Visual C++
public:
virtual void WriteDocType(
    String^ name, 
    String^ pubid, 
    String^ sysid, 
    String^ subset
) abstract
JScript
public abstract function WriteDocType(
    name : String, 
    pubid : String, 
    sysid : String, 
    subset : String
)

Parameters

name
Type: System..::.String
The name of the DOCTYPE. This must be non-empty.
pubid
Type: System..::.String
If non-null it also writes PUBLIC "pubid" "sysid" where pubid and sysid are replaced with the value of the given arguments.
sysid
Type: System..::.String
If pubid is nullNothingnullptra null reference (Nothing in Visual Basic) and sysid is non-null it writes SYSTEM "sysid" where sysid is replaced with the value of this argument.
subset
Type: System..::.String
If non-null it writes [subset] where subset is replaced with the value of this argument.
Exceptions

ExceptionCondition
InvalidOperationException

This method was called outside the prolog (after the root element).

ArgumentException

The value for name would result in invalid XML.

Remarks

This method does not check for invalid characters in pubid, sysid or subset. It also does not check that the internal subset is well-formed.

Security noteSecurity Note:

The XmlWriter does not validate the data that is passed to the WriteDocType method. You should not pass arbitrary data to this method.

Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows CE Platform Note: When using this method with the XmlDictionaryWriter on the .NET Compact Framework, it throws a NotSupportedException.

Examples

The following example writes an XML file representing a book.

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();  
  }

}
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

Other Resources

Tags :


Page view tracker