0 out of 1 rated this helpful - Rate this topic

XmlTextWriter.WriteDocType Method

Writes the DOCTYPE declaration with the specified name and optional attributes.

Namespace: System.Xml
Assembly: System.Xml (in system.xml.dll)

public override void WriteDocType (
	string name,
	string pubid,
	string sysid,
	string subset
)
public void WriteDocType (
	String name, 
	String pubid, 
	String sysid, 
	String subset
)
public override function WriteDocType (
	name : String, 
	pubid : String, 
	sysid : String, 
	subset : String
)

Parameters

name

The name of the DOCTYPE. This must be non-empty.

pubid

If non-null it also writes PUBLIC "pubid" "sysid" where pubid and sysid are replaced with the value of the given arguments.

sysid

If pubid is null and sysid is non-null it writes SYSTEM "sysid" where sysid is replaced with the value of this argument.

subset

If non-null it writes [subset] where subset is replaced with the value of this argument.

Exception typeCondition

InvalidOperationException

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

ArgumentException

name is a null reference (Nothing in Visual Basic) or String.Empty

-or-

the value for name would result in invalid XML.

NoteNote

In the Microsoft .NET Framework version 2.0 release, the recommended practice is to create XmlWriter instances using the System.Xml.XmlWriter.Create method and the XmlWriterSettings class. This allows you to take full advantage of all the new features introduced in this release. For more information, see Creating XML Writers.

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 XmlTextWriter does not validate any data that is passed to the WriteDocType method. You should not pass arbitrary data to this method.

The following example writes an XML file representing a book.

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

  }

}

import System.*;
import System.IO.*;
import System.Xml.*;

public class Sample
{
    private static String fileName = "sampledata.xml";

    public static void main(String[] args)
    {
        XmlTextWriter writer = null;
        writer = new XmlTextWriter(fileName, null);

        //Use indenting for readability.
        writer.set_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.set_PreserveWhitespace(true);

        //Load the file.
        doc.Load(fileName);

        //Display the XML content to the console.
        Console.Write(doc.get_InnerXml());
    } //main 
} //Sample

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.