mcs/class/System.Xml.Linq/Documentation/en/System.Xml.Linq/XDocumentType.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="XDocumentType" FullName="System.Xml.Linq.XDocumentType">
   3   <TypeSignature Language="C#" Value="public class XDocumentType : System.Xml.Linq.XNode" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit XDocumentType extends System.Xml.Linq.XNode" />
   5   <AssemblyInfo>
   6     <AssemblyName>System.Xml.Linq</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Xml.Linq.XNode</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Docs>
  14     <remarks>
  15       <attribution license="cc4" from="Microsoft" modified="false" />
  16       <para>Data Type Definitions (DTD) in XML are a way to do the following:</para>
  17       <list type="bullet">
  18         <item>
  19           <para>Validate XML trees to a limited extent.</para>
  20         </item>
  21         <item>
  22           <para>Expand entities, which is a form of text replacement.</para>
  23         </item>
  24         <item>
  25           <para>Supply default attributes.</para>
  26         </item>
  27       </list>
  28       <para>This class represents the XML concept of a DTD.</para>
  29       <para>DTD support in sqltecxlinq is limited. </para>
  30       <para>sqltecxlinq will expand internal entities by default, but it will not resolve external entity references unless an <see cref="T:System.Xml.XmlReader" /> with an associated <see cref="T:System.Xml.XmlResolver" /> is used to load the XML tree. </para>
  31       <para>sqltecxlinq will not validate a document against a DTD, but you can use a validating <see cref="T:System.Xml.XmlReader" /> to perform DTD validation if necessary.</para>
  32       <para>To validate an sqltecxlinq tree against an XML schema, use the <see cref="Overload:System.Xml.Schema.Extensions.Validate" /> method.</para>
  33       <para>When a document contains entity references that are defined in a DTD, the references are expanded upon creation of the XML tree. However, when you serialize or save the XML tree, the content of the expanded entities is preserved; the entity references are not.</para>
  34       <para>Default attributes from the DTD will be materialized as regular attributes in the XML tree. After a default attribute from the DTD is materialized, there is no way to determine that the attribute was a default attribute from the DTD.</para>
  35       <para>You can populate an XML tree with an XML document that contains an internal DTD. The XML tree will then contain a <see cref="P:System.Xml.Linq.XDocument.DocumentType" /> node. When you serialize or save the tree, the internal DTD will also be saved as part of the document.</para>
  36     </remarks>
  37     <summary>
  38       <attribution license="cc4" from="Microsoft" modified="false" />
  39       <para>Represents an XML Document Type Definition (DTD). </para>
  40     </summary>
  41   </Docs>
  42   <Members>
  43     <Member MemberName=".ctor">
  44       <MemberSignature Language="C#" Value="public XDocumentType (System.Xml.Linq.XDocumentType other);" />
  45       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Xml.Linq.XDocumentType other) cil managed" />
  46       <MemberType>Constructor</MemberType>
  47       <AssemblyInfo>
  48         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  49       </AssemblyInfo>
  50       <Parameters>
  51         <Parameter Name="other" Type="System.Xml.Linq.XDocumentType" />
  52       </Parameters>
  53       <Docs>
  54         <remarks>
  55           <attribution license="cc4" from="Microsoft" modified="false" />
  56           <para>This constructor is primarily used internally when making a deep copy of an XML tree.</para>
  57         </remarks>
  58         <summary>
  59           <attribution license="cc4" from="Microsoft" modified="false" />
  60           <para>Initializes an instance of the <see cref="T:System.Xml.Linq.XDocumentType" /> class from another <see cref="T:System.Xml.Linq.XDocumentType" /> object.</para>
  61         </summary>
  62         <param name="other">
  63           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.Linq.XDocumentType" /> object to copy from.</param>
  64       </Docs>
  65     </Member>
  66     <Member MemberName=".ctor">
  67       <MemberSignature Language="C#" Value="public XDocumentType (string name, string publicId, string systemId, string internalSubset);" />
  68       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, string publicId, string systemId, string internalSubset) cil managed" />
  69       <MemberType>Constructor</MemberType>
  70       <AssemblyInfo>
  71         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  72       </AssemblyInfo>
  73       <Parameters>
  74         <Parameter Name="name" Type="System.String" />
  75         <Parameter Name="publicId" Type="System.String" />
  76         <Parameter Name="systemId" Type="System.String" />
  77         <Parameter Name="internalSubset" Type="System.String" />
  78       </Parameters>
  79       <Docs>
  80         <remarks>To be added.</remarks>
  81         <summary>
  82           <attribution license="cc4" from="Microsoft" modified="false" />
  83           <para>Initializes an instance of the <see cref="T:System.Xml.Linq.XDocumentType" /> class. </para>
  84         </summary>
  85         <param name="name">
  86           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the qualified name of the DTD, which is the same as the qualified name of the root element of the XML document.</param>
  87         <param name="publicId">
  88           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the public identifier of an external public DTD.</param>
  89         <param name="systemId">
  90           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the system identifier of an external private DTD.</param>
  91         <param name="internalSubset">
  92           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the internal subset for an internal DTD.</param>
  93       </Docs>
  94     </Member>
  95     <Member MemberName="InternalSubset">
  96       <MemberSignature Language="C#" Value="public string InternalSubset { get; set; }" />
  97       <MemberSignature Language="ILAsm" Value=".property instance string InternalSubset" />
  98       <MemberType>Property</MemberType>
  99       <AssemblyInfo>
 100         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 101       </AssemblyInfo>
 102       <ReturnValue>
 103         <ReturnType>System.String</ReturnType>
 104       </ReturnValue>
 105       <Docs>
 106         <value>To be added.</value>
 107         <remarks>To be added.</remarks>
 108         <summary>
 109           <attribution license="cc4" from="Microsoft" modified="false" />
 110           <para>Gets or sets the internal subset for this Document Type Definition (DTD).</para>
 111         </summary>
 112       </Docs>
 113     </Member>
 114     <Member MemberName="Name">
 115       <MemberSignature Language="C#" Value="public string Name { get; set; }" />
 116       <MemberSignature Language="ILAsm" Value=".property instance string Name" />
 117       <MemberType>Property</MemberType>
 118       <AssemblyInfo>
 119         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 120       </AssemblyInfo>
 121       <ReturnValue>
 122         <ReturnType>System.String</ReturnType>
 123       </ReturnValue>
 124       <Docs>
 125         <value>To be added.</value>
 126         <remarks>To be added.</remarks>
 127         <summary>
 128           <attribution license="cc4" from="Microsoft" modified="false" />
 129           <para>Gets or sets the name for this Document Type Definition (DTD).</para>
 130         </summary>
 131       </Docs>
 132     </Member>
 133     <Member MemberName="NodeType">
 134       <MemberSignature Language="C#" Value="public override System.Xml.XmlNodeType NodeType { get; }" />
 135       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Xml.XmlNodeType NodeType" />
 136       <MemberType>Property</MemberType>
 137       <AssemblyInfo>
 138         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 139       </AssemblyInfo>
 140       <ReturnValue>
 141         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 142       </ReturnValue>
 143       <Docs>
 144         <value>To be added.</value>
 145         <remarks>
 146           <attribution license="cc4" from="Microsoft" modified="false" />
 147           <para>Because all classes that derive from <see cref="T:System.Xml.Linq.XObject" /> contain a <see cref="P:System.Xml.Linq.XObject.NodeType" /> property, you can write code that operates on collections of concrete subclass of <see cref="T:System.Xml.Linq.XObject" />. Your code can then test for the node type of each node in the collection.</para>
 148         </remarks>
 149         <summary>
 150           <attribution license="cc4" from="Microsoft" modified="false" />
 151           <para>Gets the node type for this node.</para>
 152         </summary>
 153       </Docs>
 154     </Member>
 155     <Member MemberName="PublicId">
 156       <MemberSignature Language="C#" Value="public string PublicId { get; set; }" />
 157       <MemberSignature Language="ILAsm" Value=".property instance string PublicId" />
 158       <MemberType>Property</MemberType>
 159       <AssemblyInfo>
 160         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 161       </AssemblyInfo>
 162       <ReturnValue>
 163         <ReturnType>System.String</ReturnType>
 164       </ReturnValue>
 165       <Docs>
 166         <value>To be added.</value>
 167         <remarks>
 168           <attribution license="cc4" from="Microsoft" modified="false" />
 169           <para>If an XML document uses an external public DTD, this property will contain the public identifier of the external DTD.</para>
 170         </remarks>
 171         <summary>
 172           <attribution license="cc4" from="Microsoft" modified="false" />
 173           <para>Gets or sets the public identifier for this Document Type Definition (DTD).</para>
 174         </summary>
 175       </Docs>
 176     </Member>
 177     <Member MemberName="SystemId">
 178       <MemberSignature Language="C#" Value="public string SystemId { get; set; }" />
 179       <MemberSignature Language="ILAsm" Value=".property instance string SystemId" />
 180       <MemberType>Property</MemberType>
 181       <AssemblyInfo>
 182         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 183       </AssemblyInfo>
 184       <ReturnValue>
 185         <ReturnType>System.String</ReturnType>
 186       </ReturnValue>
 187       <Docs>
 188         <value>To be added.</value>
 189         <remarks>
 190           <attribution license="cc4" from="Microsoft" modified="false" />
 191           <para>If an XML document uses an external private DTD, this property will contain the private identifier of the external DTD.</para>
 192         </remarks>
 193         <summary>
 194           <attribution license="cc4" from="Microsoft" modified="false" />
 195           <para>Gets or sets the system identifier for this Document Type Definition (DTD).</para>
 196         </summary>
 197       </Docs>
 198     </Member>
 199     <Member MemberName="WriteTo">
 200       <MemberSignature Language="C#" Value="public override void WriteTo (System.Xml.XmlWriter writer);" />
 201       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void WriteTo(class System.Xml.XmlWriter writer) cil managed" />
 202       <MemberType>Method</MemberType>
 203       <AssemblyInfo>
 204         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 205       </AssemblyInfo>
 206       <ReturnValue>
 207         <ReturnType>System.Void</ReturnType>
 208       </ReturnValue>
 209       <Parameters>
 210         <Parameter Name="writer" Type="System.Xml.XmlWriter" />
 211       </Parameters>
 212       <Docs>
 213         <remarks>
 214           <attribution license="cc4" from="Microsoft" modified="false" />
 215           <para>This method is primarily used internally by the methods that write an XML tree to an <see cref="T:System.Xml.XmlWriter" />.</para>
 216         </remarks>
 217         <summary>
 218           <attribution license="cc4" from="Microsoft" modified="false" />
 219           <para>Write this <see cref="T:System.Xml.Linq.XDocumentType" /> to an <see cref="T:System.Xml.XmlWriter" />.</para>
 220         </summary>
 221         <param name="writer">
 222           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.XmlWriter" /> into which this method will write.</param>
 223       </Docs>
 224     </Member>
 225   </Members>
 226 </Type>