Export (0) Print
Expand All

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)

public abstract void WriteDocType (
	string name,
	string pubid,
	string sysid,
	string subset
)
public abstract void WriteDocType (
	String name, 
	String pubid, 
	String sysid, 
	String subset
)
public abstract 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 a 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

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

The value for name would result in invalid XML.

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: This method was not implemented in the Microsoft .NET Compact Framework version 1.0, but is implemented in version 2.0.

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() {
  
     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

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

Community Additions

ADD
Show:
© 2014 Microsoft