7 out of 7 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
)

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 null 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.
Exception Condition
InvalidOperationException

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

ArgumentException

name is null or String.Empty

-or-

the value for name would result in invalid XML.

Note Note:

In the .NET Framework version 2.0 release, the recommended practice is to create XmlWriter instances using the 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 note Security 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);  

  }

}


#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;

int main()
{
     XmlTextWriter* writer = 0;
     String* filename = S"sampledata.xml";

     writer = new XmlTextWriter (filename, 0);
     //Use indenting for readability.
     writer->Formatting = Formatting::Indented;

     //Write the XML delcaration. 
     writer->WriteStartDocument();

     //Write the ProcessingInstruction node.
     String* PItext=S"type='text/xsl' href='book.xsl'";
     writer->WriteProcessingInstruction(S"xml-stylesheet", PItext);

     //Write the DocumentType node.
     writer->WriteDocType(S"book", 0 , 0, S"<!ENTITY h 'hardcover'>");

     //Write a Comment node.
     writer->WriteComment(S"sample XML");

     //Write a root element.
     writer->WriteStartElement(S"book");

     //Write the genre attribute.
     writer->WriteAttributeString(S"genre", S"novel");

     //Write the ISBN attribute.
     writer->WriteAttributeString(S"ISBN", S"1-8630-014");

     //Write the title.
     writer->WriteElementString(S"title", S"The Handmaid's Tale");

     //Write the style element.
     writer->WriteStartElement(S"style");
     writer->WriteEntityRef(S"h");
     writer->WriteEndElement(); 

     //Write the price.
     writer->WriteElementString(S"price", S"19.95");

     //Write CDATA.
     writer->WriteCData(S"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);  
}


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.

.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
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ