XmlTextWriter.WriteComment メソッド
指定したテキストを格納するコメント <!--...--> を書き込みます。
Overrides Public Sub WriteComment( _
ByVal text As String _)
[C#]
public override void WriteComment(stringtext);
[C++]
public: void WriteComment(String* text);
[JScript]
public override function WriteComment(
text : String);
パラメータ
- text
コメント内に配置するテキスト。
例外
| 例外の種類 | 条件 |
|---|---|
| ArgumentException | テキストは、非整形式の XML ドキュメントになります。 |
| InvalidOperationException | WriteState が Closed です。 |
解説
text が null 参照 (Visual Basic では Nothing) または String.Empty の場合、このメソッドは、<!----> などのデータの内容を含まない Comment を書き込みます。
使用例
[Visual Basic, C#, C++] book を表す XML ファイルを書き込む例を次に示します。
Option Explicit
Option Strict
Imports System
Imports System.IO
Imports System.Xml
Public Class Sample
Private Shared filename As String = "sampledata.xml"
Public Shared Sub Main()
Dim writer As XmlTextWriter = Nothing
writer = New XmlTextWriter(filename, Nothing)
'Use indenting for readability.
writer.Formatting = Formatting.Indented
'Write the XML delcaration.
writer.WriteStartDocument()
'Write the ProcessingInstruction 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 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.
Dim doc As 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)
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()
{
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);
}
}
[C++]
#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);
}
[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン .gif)
をクリックします。
必要条件
プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ, .NET Compact Framework - Windows CE .NET, Common Language Infrastructure (CLI) Standard