XmlDocument.CreateComment(String) XmlDocument.CreateComment(String) XmlDocument.CreateComment(String) XmlDocument.CreateComment(String) Method

定義

指定されたデータを格納している XmlComment を作成します。Creates an XmlComment containing the specified data.

public:
 virtual System::Xml::XmlComment ^ CreateComment(System::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 String String String

新しい XmlComment の内容。The content of the new XmlComment.

戻り値

新しい XmlCommentThe new XmlComment.

次の例では、コメントを作成し、XML ドキュメントに追加します。The following example creates a comment and adds it to an XML document.

#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlDocument^ doc = gcnew 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 );
}

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 'Sample

注釈

このメソッドでは、ドキュメントのコンテキストで新しいオブジェクトが作成されますが、新しいオブジェクトがドキュメントツリーに自動的に追加されることはありません。Although this method creates the new object in the context of the document, it does not automatically add the new object to the document tree. 新しいオブジェクトを追加するには、ノードの挿入メソッドの1つを明示的に呼び出す必要があります。To add the new object, you must explicitly call one of the node insert methods.

W3C拡張マークアップ言語 (XML) 1.0 の推奨事項に従って、entityreference ノードが属性ノードの子でない場合、Comment ノードは Document、Element、および entityreference ノード内でのみ許可されます。According to the W3C Extensible Markup Language (XML) 1.0 recommendation, Comment nodes are only allowed within Document, Element and EntityReference nodes, when the EntityReference node is not a child of an Attribute node.

適用対象