XmlTextWriter.WriteEntityRef メソッド

.NET Framework クラス ライブラリ リファレンス

XmlTextWriter.WriteEntityRef メソッド

&name; のようにエンティティ参照を書き込みます。

名前空間: System.Xml
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public Overrides Sub WriteEntityRef
 ( _
    name As String _
)

Visual Basic (使用法)

Dim instance As XmlTextWriter
Dim name As String

instance.WriteEntityRef(name)

C#

public override void WriteEntityRef (
    string name
)

C++

public:
virtual void WriteEntityRef (
    String^ name
) override

J#

public void WriteEntityRef (
    String name
)

JScript

public override function WriteEntityRef (
    name : String
)

パラメータ

name

エンティティ参照の名前。

例外

例外の種類	条件
ArgumentException	テキストが非整形式の XML ドキュメントになるか、name が null 参照 (Visual Basic では Nothing) または String.Empty です。

解説

メモ
Microsoft .NET Framework version 2.0 リリースでは、System.Xml.XmlWriter.Create メソッドと XmlWriterSettings クラスを使用して XmlWriter インスタンスを作成することをお勧めします。これにより、このリリースで導入されたすべての新機能を十分に活用できます。詳細については、「XML ライタの作成」を参照してください。

使用例

book を表す XML ファイルを書き込む例を次に示します。

Visual Basic

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 <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlTextWriter^ writer = nullptr;
   String^ filename = "sampledata.xml";
   writer = gcnew XmlTextWriter( filename, nullptr );
   
   //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", nullptr, nullptr, "<!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 = gcnew 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 );
}

J#

import System.*;
import System.IO.*;
import System.Xml.*;

public class Sample
{
    private static String fileName = "sampledata.xml";

    public static void main(String[]
 args)
    {
        XmlTextWriter writer = null;
        writer = new XmlTextWriter(fileName, null);

        //Use indenting for readability.
        writer.set_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.set_PreserveWhitespace(true);

        //Load the file.
        doc.Load(fileName);

        //Display the XML content to the console.
        Console.Write(doc.get_InnerXml());
    } //main 
} //Sample

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
XmlTextWriter クラス
XmlTextWriter メンバ
System.Xml 名前空間