XmlWriter.WriteComment Method
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
When overridden in a derived class, writes out a comment <!--...--> containing the specified text.
Assembly: System.Xml (in System.Xml.dll)
Parameters
- text
- Type: System.String
Text to place inside the comment.
| Exception | Condition |
|---|---|
| ArgumentException | The text would result in a non-well formed XML document. |
If text is either null or String.Empty, this method writes a comment with no data content, for example <!---->.
If text contains an invalid sequence of two dashes "--" the XmlWriter can either throw an ArgumentException or insert a space between the dashes "- -" so that the text is a valid XML comment (XmlWriter objects created by the Create method).
The following example navigates through the stream to determine the current node type, and then uses XmlWriter to output the XmlReader content.
StringBuilder output = new StringBuilder(); String xmlString = @"<?xml version='1.0'?> <!-- This is a sample XML document --> <Items> <Item>test with a child element <more/> stuff</Item> </Items>"; // Create an XmlReader using (XmlReader reader = XmlReader.Create(new StringReader(xmlString))) { XmlWriterSettings ws = new XmlWriterSettings(); ws.Indent = true; using (XmlWriter writer = XmlWriter.Create(output, ws)) { // Parse the file and display each of the nodes. while (reader.Read()) { switch (reader.NodeType) { case XmlNodeType.Element: writer.WriteStartElement(reader.Name); break; case XmlNodeType.Text: writer.WriteString(reader.Value); break; case XmlNodeType.XmlDeclaration: case XmlNodeType.ProcessingInstruction: writer.WriteProcessingInstruction(reader.Name, reader.Value); break; case XmlNodeType.Comment: writer.WriteComment(reader.Value); break; case XmlNodeType.EndElement: writer.WriteFullEndElement(); break; } } } } OutputTextBlock.Text = output.ToString();