This documentation is archived and is not being maintained.

XmlDocumentType.Entities Property

Gets the collection of XmlEntity nodes declared in the document type declaration.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

public XmlNamedNodeMap Entities { get; }

Property Value

Type: System.Xml.XmlNamedNodeMap
An XmlNamedNodeMap containing the XmlEntity nodes. The returned XmlNamedNodeMap is read-only.

The order in which the entities are returned is not based on the order in which these items may appear in the document. The order is also not guaranteed to be the same between similar documents, or between different implementations or versions of the class.

The following example displays information about the entities declared in the XML document.

using System;
using System.IO;
using System.Xml;

public class Sample
{
  private const String filename = "doment.xml";

  public static void Main()
  {      
     XmlDocument doc = new XmlDocument();
     doc.Load(filename);

     Console.WriteLine("Display information on all entities...");     
     XmlNamedNodeMap nMap = doc.DocumentType.Entities;
     DisplayEntities(nMap);
  }

  public static void DisplayEntities(XmlNamedNodeMap nMap)
  {    
     for (int i=0; i < nMap.Count; i++)
     {
        XmlEntity ent = (XmlEntity) nMap.Item(i);
        Console.Write("{0} ", ent.NodeType);
        Console.Write("{0} ", ent.Name);
        Console.Write("{0} ", ent.NotationName);
        Console.Write("{0} ", ent.PublicId);
        Console.Write("{0} ", ent.SystemId);
        Console.WriteLine();
     }
  }
}
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;

__gc public class Sample 
{
public:
   static void DisplayEntities(XmlNamedNodeMap * nMap)
   { 
      for (int i = 0; i < nMap -> Count; i++) 
      {
         XmlEntity * ent = dynamic_cast<XmlEntity*>(nMap -> Item(i));
         Console::Write(S" {0} ", __box(ent -> NodeType));
         Console::Write(S" {0} ", ent -> Name);
         Console::Write(S" {0} ", ent -> NotationName);
         Console::Write(S" {0} ", ent -> PublicId);
         Console::Write(S" {0} ", ent -> SystemId);
         Console::WriteLine();
      }
   }
};

int main() 
{
   XmlDocument* doc = new XmlDocument();
   doc -> Load(S"doment.xml");

   Console::WriteLine(S"Display information on all entities...");     
   XmlNamedNodeMap * nMap = doc -> DocumentType -> Entities;
   Sample * MySample = new Sample();
   MySample -> DisplayEntities(nMap);
}

The example uses the file doment.xml as input.

<!DOCTYPE doc [

  <!ELEMENT doc ANY>

  <!NOTATION w SYSTEM "wine.exe">
  <!NOTATION v PUBLIC "vine.exe">

  <!NOTATION jpg PUBLIC "Jpeg picture format">
  <!NOTATION gif SYSTEM "Gif picture format">

  <!ENTITY wn PUBLIC "http://www.cohowinery.com" "coho.exe" NDATA w>
  <!ENTITY vn SYSTEM "http://www.cohovineyard.com" NDATA v>
  <!ENTITY mytxt "Text Sample">

  <!ATTLIST doc 
        src     ENTITY         #IMPLIED
        srcs    ENTITIES       #IMPLIED
        jpgPic  NOTATION (jpg) #IMPLIED
        gifPic  NOTATION (gif) #REQUIRED>
]>

<doc jpgPic="jpg" gifPic="gif" srcs="vn wn">
    something
</doc>

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: