XmlDocument.CreateComment(String) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定されたデータを格納している XmlComment を作成します。
public:
virtual System::Xml::XmlComment ^ CreateComment(System::String ^ data);
public virtual System.Xml.XmlComment CreateComment(string data);
public virtual System.Xml.XmlComment CreateComment(string? data);
abstract member CreateComment : string -> System.Xml.XmlComment
override this.CreateComment : string -> System.Xml.XmlComment
Public Overridable Function CreateComment (data As String) As XmlComment
パラメーター
- data
- String
新しい XmlComment
の内容。
戻り値
新しい XmlComment
。
例
次の例では、コメントを作成し、XML ドキュメントに追加します。
using System;
using System.IO;
using System.Xml;
public class Sample
{
public static void Main()
{
XmlDocument doc = new XmlDocument();
doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" +
"<title>Pride And Prejudice</title>" +
"</book>");
//Create a comment.
XmlComment newComment;
newComment = doc.CreateComment("Sample XML document");
//Add the new node to the document.
XmlElement root = doc.DocumentElement;
doc.InsertBefore(newComment, root);
Console.WriteLine("Display the modified XML...");
doc.Save(Console.Out);
}
}
Option Explicit
Option Strict
Imports System.IO
Imports System.Xml
Public Class Sample
Public Shared Sub Main()
Dim doc As New XmlDocument()
doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" & _
"<title>Pride And Prejudice</title>" & _
"</book>")
'Create a comment.
Dim newComment As XmlComment
newComment = doc.CreateComment("Sample XML document")
'Add the new node to the document.
Dim root As XmlElement = doc.DocumentElement
doc.InsertBefore(newComment, root)
Console.WriteLine("Display the modified XML...")
doc.Save(Console.Out)
End Sub
End Class
注釈
このメソッドは、ドキュメントのコンテキストで新しいオブジェクトを作成しますが、ドキュメント ツリーに新しいオブジェクトを自動的に追加することはありません。 新しいオブジェクトを追加するには、ノード挿入メソッドのいずれかを明示的に呼び出す必要があります。
W3C Extensible Markup Language (XML) 1.0 の推奨事項によると、EntityReference ノードが Attribute ノードの子でない場合、コメント ノードは Document、Element、EntityReference ノード内でのみ許可されます。