mcs/class/System.XML/Documentation/en/System.Xml/XmlNodeType.xml

   1 <Type Name="XmlNodeType" FullName="System.Xml.XmlNodeType" FullNameSP="System_Xml_XmlNodeType" Maintainer="ecma">
   2   <TypeSignature Language="ILASM" Value=".class public sealed serializable XmlNodeType extends System.Enum" />
   3   <TypeSignature Language="C#" Value="public enum XmlNodeType" />
   4   <MemberOfLibrary>XML</MemberOfLibrary>
   5   <AssemblyInfo>
   6     <AssemblyName>System.Xml</AssemblyName>
   7     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <Base>
  12     <BaseTypeName>System.Enum</BaseTypeName>
  13   </Base>
  14   <Docs>
  15     <summary>
  16       <para>Specifies the type of node.</para>
  17     </summary>
  18     <remarks>
  19       <para>A given set of XML data is modeled as a tree of nodes.
  20       This enumeration specifies the different node types.</para>
  21     </remarks>
  22   </Docs>
  23   <Members>
  24     <Member MemberName="Attribute">
  25       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType Attribute = 2" />
  26       <MemberSignature Language="C#" Value="Attribute" />
  27       <MemberType>Field</MemberType>
  28       <ReturnValue>
  29         <ReturnType>System.Xml.XmlNodeType</ReturnType>
  30       </ReturnValue>
  31       <Parameters />
  32       <MemberValue>Attribute</MemberValue>
  33       <Docs>
  34         <summary>
  35           <para> An
  36  attribute.
  37  </para>
  38           <para> Example XML: <c>id="123"</c></para>
  39           <para> An <see langword="Attribute" /> node can have the
  40 following child node types: <see langword="Text" /> and
  41 <see langword="EntityReference" />. The <see langword="Attribute" /> node does not
  42 appear as the child node of any other node type. It is not considered a
  43 child node of an <see langword="Element" />
  44 .</para>
  45         </summary>
  46         <remarks>To be added.</remarks>
  47       </Docs>
  48       <Excluded>0</Excluded>
  49       <AssemblyInfo>
  50         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  51         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  52       </AssemblyInfo>
  53     </Member>
  54     <Member MemberName="CDATA">
  55       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType CDATA = 4" />
  56       <MemberSignature Language="C#" Value="CDATA" />
  57       <MemberType>Field</MemberType>
  58       <ReturnValue>
  59         <ReturnType>System.Xml.XmlNodeType</ReturnType>
  60       </ReturnValue>
  61       <Parameters />
  62       <MemberValue>CDATA</MemberValue>
  63       <Docs>
  64         <summary>
  65           <para>A CDATA
  66
  67       section.</para>
  68           <para>Example XML: <c>
  69       &lt;![CDATA[escaped text]]&gt;</c></para>
  70           <para> CDATA sections are used to escape blocks of text that would otherwise
  71    be recognized as markup. A <see langword="CDATA" /> node cannot have any child
  72    nodes. It can appear as the child of the <see langword="DocumentFragment" />,
  73 <see langword="EntityReference" />, and <see langword="Element" /> nodes.</para>
  74         </summary>
  75         <remarks>To be added.</remarks>
  76       </Docs>
  77       <Excluded>0</Excluded>
  78       <AssemblyInfo>
  79         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  80         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  81       </AssemblyInfo>
  82     </Member>
  83     <Member MemberName="Comment">
  84       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType Comment = 8" />
  85       <MemberSignature Language="C#" Value="Comment" />
  86       <MemberType>Field</MemberType>
  87       <ReturnValue>
  88         <ReturnType>System.Xml.XmlNodeType</ReturnType>
  89       </ReturnValue>
  90       <Parameters />
  91       <MemberValue>Comment</MemberValue>
  92       <Docs>
  93         <summary>
  94           <para> A comment.
  95       </para>
  96           <para> Example XML: <c> &lt;!-- comment --&gt;</c></para>
  97           <para> A <see langword="Comment" /> node cannot have any child
  98 nodes. It can appear as the child of the <see langword="Document" />,
  99 <see langword="DocumentFragment" />, <see langword="Element" />, and
 100 <see langword="EntityReference" />
 101 nodes.</para>
 102         </summary>
 103         <remarks>To be added.</remarks>
 104       </Docs>
 105       <Excluded>0</Excluded>
 106       <AssemblyInfo>
 107         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 108         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 109       </AssemblyInfo>
 110     </Member>
 111     <Member MemberName="Document">
 112       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType Document = 9" />
 113       <MemberSignature Language="C#" Value="Document" />
 114       <MemberType>Field</MemberType>
 115       <ReturnValue>
 116         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 117       </ReturnValue>
 118       <Parameters />
 119       <MemberValue>Document</MemberValue>
 120       <Docs>
 121         <summary>
 122           <para> A document object that, as the root of the document tree, provides access
 123  to the entire XML document.
 124  </para>
 125           <para> A <see langword="Document" /> node
 126  can have the following child node types:
 127 <see langword="XmlDeclaration" />
 128 , <see langword="Element" /> (maximum of one),
 129 <see langword="ProcessingInstruction" />, <see langword="Comment" />, and
 130 <see langword="DocumentType" />
 131 . It cannot
 132 appear as the child of any node types.</para>
 133         </summary>
 134         <remarks>To be added.</remarks>
 135       </Docs>
 136       <Excluded>0</Excluded>
 137       <AssemblyInfo>
 138         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 139         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 140       </AssemblyInfo>
 141     </Member>
 142     <Member MemberName="DocumentFragment">
 143       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType DocumentFragment = 11" />
 144       <MemberSignature Language="C#" Value="DocumentFragment" />
 145       <MemberType>Field</MemberType>
 146       <ReturnValue>
 147         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 148       </ReturnValue>
 149       <Parameters />
 150       <MemberValue>DocumentFragment</MemberValue>
 151       <Docs>
 152         <summary>
 153           <para> A document fragment.
 154       </para>
 155           <para> The <see langword="DocumentFragment" /> node associates a
 156    node or sub-tree with a document without actually being contained within the
 157    document. A <see langword="DocumentFragment" /> node can have the following child
 158    node types: <see langword="Element" />, <see langword="ProcessingInstruction" />,
 159 <see langword="Comment" />, <see langword="Text" />, <see langword="CDATA" />, and
 160 <see langword="EntityReference" />
 161 . It
 162 cannot appear as the child of any node types.</para>
 163         </summary>
 164         <remarks>To be added.</remarks>
 165       </Docs>
 166       <Excluded>0</Excluded>
 167       <AssemblyInfo>
 168         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 169         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 170       </AssemblyInfo>
 171     </Member>
 172     <Member MemberName="DocumentType">
 173       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType DocumentType = 10" />
 174       <MemberSignature Language="C#" Value="DocumentType" />
 175       <MemberType>Field</MemberType>
 176       <ReturnValue>
 177         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 178       </ReturnValue>
 179       <Parameters />
 180       <MemberValue>DocumentType</MemberValue>
 181       <Docs>
 182         <summary>
 183           <para> The document type declaration, indicated by the following tag.
 184       </para>
 185           <para> Example XML: <c>&lt;!DOCTYPE ...&gt;</c></para>
 186           <para> A <see langword="DocumentType" /> node can have the
 187 following child node types: <see langword="Notation" /> and
 188 <see langword="Entity" />. It can appear as the child of the
 189 <see langword="Document" />
 190 node.
 191 </para>
 192         </summary>
 193         <remarks>To be added.</remarks>
 194       </Docs>
 195       <Excluded>0</Excluded>
 196       <AssemblyInfo>
 197         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 198         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 199       </AssemblyInfo>
 200     </Member>
 201     <Member MemberName="Element">
 202       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType Element = 1" />
 203       <MemberSignature Language="C#" Value="Element" />
 204       <MemberType>Field</MemberType>
 205       <ReturnValue>
 206         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 207       </ReturnValue>
 208       <Parameters />
 209       <MemberValue>Element</MemberValue>
 210       <Docs>
 211         <summary>
 212           <para> An element.
 213       </para>
 214           <para> Example XML: <c>&lt;name&gt;</c></para>
 215 An <see langword="Element" /> node can have the
 216 following child node types: <see langword="Element" />, <see langword="Text" />,
 217 <see langword="Comment" />, <see langword="ProcessingInstruction" />,
 218 <see langword="CDATA" />, and <see langword="EntityReference" />. It can be the
 219 child of the <see langword="Document" />, <see langword="DocumentFragment" />,
 220 <see langword="EntityReference" />, and <see langword="Element" />
 221 nodes.
 222 </summary>
 223         <remarks>To be added.</remarks>
 224       </Docs>
 225       <Excluded>0</Excluded>
 226       <AssemblyInfo>
 227         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 228         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 229       </AssemblyInfo>
 230     </Member>
 231     <Member MemberName="EndElement">
 232       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType EndElement = 15" />
 233       <MemberSignature Language="C#" Value="EndElement" />
 234       <MemberType>Field</MemberType>
 235       <ReturnValue>
 236         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 237       </ReturnValue>
 238       <Parameters />
 239       <MemberValue>EndElement</MemberValue>
 240       <Docs>
 241         <summary>
 242           <para> An end element.</para>
 243           <para>Example XML: <c>&lt;/name&gt;</c></para>
 244           <para>Returned when <see cref="T:System.Xml.XmlReader" /> gets to the end of an element.</para>
 245         </summary>
 246         <remarks>To be added.</remarks>
 247       </Docs>
 248       <Excluded>0</Excluded>
 249       <AssemblyInfo>
 250         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 251         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 252       </AssemblyInfo>
 253     </Member>
 254     <Member MemberName="EndEntity">
 255       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType EndEntity = 16" />
 256       <MemberSignature Language="C#" Value="EndEntity" />
 257       <MemberType>Field</MemberType>
 258       <ReturnValue>
 259         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 260       </ReturnValue>
 261       <Parameters />
 262       <MemberValue>EndEntity</MemberValue>
 263       <Docs>
 264         <summary>
 265           <para>Returned when <see cref="T:System.Xml.XmlReader" /> gets to the end of the entity
 266    replacement as a result of a call to <see cref="M:System.Xml.XmlReader.ResolveEntity" />
 267    .</para>
 268         </summary>
 269         <remarks>To be added.</remarks>
 270       </Docs>
 271       <Excluded>0</Excluded>
 272       <AssemblyInfo>
 273         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 274         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 275       </AssemblyInfo>
 276     </Member>
 277     <Member MemberName="Entity">
 278       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType Entity = 6" />
 279       <MemberSignature Language="C#" Value="Entity" />
 280       <MemberType>Field</MemberType>
 281       <ReturnValue>
 282         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 283       </ReturnValue>
 284       <Parameters />
 285       <MemberValue>Entity</MemberValue>
 286       <Docs>
 287         <summary>
 288           <para>An entity declaration.</para>
 289           <para>Example XML: <c>&lt;!ENTITY ...&gt;</c></para>
 290           <para>An <see langword="Entity" /> node can have child nodes
 291    that represent the expanded entity (for example, <see langword="Text" /> and
 292 <see langword="EntityReference" /> nodes). It can appear as the child of the
 293 <see langword="DocumentType" />
 294 node.</para>
 295         </summary>
 296         <remarks>To be added.</remarks>
 297       </Docs>
 298       <Excluded>0</Excluded>
 299       <AssemblyInfo>
 300         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 301         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 302       </AssemblyInfo>
 303     </Member>
 304     <Member MemberName="EntityReference">
 305       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType EntityReference = 5" />
 306       <MemberSignature Language="C#" Value="EntityReference" />
 307       <MemberType>Field</MemberType>
 308       <ReturnValue>
 309         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 310       </ReturnValue>
 311       <Parameters />
 312       <MemberValue>EntityReference</MemberValue>
 313       <Docs>
 314         <summary>
 315           <para>A reference to an entity.</para>
 316           <para>Example XML: <c>&amp;num;</c></para>
 317           <para> An <see langword="EntityReference" /> node can have the
 318    following child node types: <see langword="Element" />,
 319 <see langword="ProcessingInstruction" />, <see langword="Comment" />,
 320 <see langword="Text" />, <see langword="CDATA" />, and
 321 <see langword="EntityReference" />. It can appear as the child of the
 322 <see langword="Attribute" />, <see langword="DocumentFragment" />,
 323 <see langword="Element" />, and <see langword="EntityReference" />
 324
 325 nodes.</para>
 326         </summary>
 327         <remarks>To be added.</remarks>
 328       </Docs>
 329       <Excluded>0</Excluded>
 330       <AssemblyInfo>
 331         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 332         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 333       </AssemblyInfo>
 334     </Member>
 335     <Member MemberName="None">
 336       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType None = 0" />
 337       <MemberSignature Language="C#" Value="None" />
 338       <MemberType>Field</MemberType>
 339       <ReturnValue>
 340         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 341       </ReturnValue>
 342       <Parameters />
 343       <MemberValue>None</MemberValue>
 344       <Docs>
 345         <summary>
 346           <para>This is returned by the <see cref="T:System.Xml.XmlReader" /> if a read
 347    method has not been called or if no more nodes
 348    are available to be read.</para>
 349         </summary>
 350         <remarks>To be added.</remarks>
 351       </Docs>
 352       <Excluded>0</Excluded>
 353       <AssemblyInfo>
 354         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 355         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 356       </AssemblyInfo>
 357     </Member>
 358     <Member MemberName="Notation">
 359       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType Notation = 12" />
 360       <MemberSignature Language="C#" Value="Notation" />
 361       <MemberType>Field</MemberType>
 362       <ReturnValue>
 363         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 364       </ReturnValue>
 365       <Parameters />
 366       <MemberValue>Notation</MemberValue>
 367       <Docs>
 368         <summary>
 369           <para> A notation in the document type declaration.
 370       </para>
 371           <para> Example XML: <c>&lt;!NOTATION ...&gt;</c></para>
 372           <para> A <see langword="Notation" /> node cannot have any child
 373 nodes. It can appear as the child of the <see langword="DocumentType" />
 374 node.
 375 </para>
 376         </summary>
 377         <remarks>To be added.</remarks>
 378       </Docs>
 379       <Excluded>0</Excluded>
 380       <AssemblyInfo>
 381         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 382         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 383       </AssemblyInfo>
 384     </Member>
 385     <Member MemberName="ProcessingInstruction">
 386       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType ProcessingInstruction = 7" />
 387       <MemberSignature Language="C#" Value="ProcessingInstruction" />
 388       <MemberType>Field</MemberType>
 389       <ReturnValue>
 390         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 391       </ReturnValue>
 392       <Parameters />
 393       <MemberValue>ProcessingInstruction</MemberValue>
 394       <Docs>
 395         <summary>
 396           <para> A processing instruction.
 397       </para>
 398           <para> Example XML: <c>&lt;?pi test?&gt;</c></para>
 399           <para> A <see langword="ProcessingInstruction" /> node cannot have
 400 any child nodes. It can appear as the child of the <see langword="Document" />,
 401 <see langword="DocumentFragment" />, <see langword="Element" />, and
 402 <see langword="EntityReference" />
 403 nodes.
 404 </para>
 405         </summary>
 406         <remarks>To be added.</remarks>
 407       </Docs>
 408       <Excluded>0</Excluded>
 409       <AssemblyInfo>
 410         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 411         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 412       </AssemblyInfo>
 413     </Member>
 414     <Member MemberName="SignificantWhitespace">
 415       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType SignificantWhitespace = 14" />
 416       <MemberSignature Language="C#" Value="SignificantWhitespace" />
 417       <MemberType>Field</MemberType>
 418       <ReturnValue>
 419         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 420       </ReturnValue>
 421       <Parameters />
 422       <MemberValue>SignificantWhitespace</MemberValue>
 423       <Docs>
 424         <summary>
 425           <para> White space between markup in a mixed content model or white
 426       space within the <c>xml:space="preserve"</c> scope.
 427    </para>
 428         </summary>
 429         <remarks>To be added.</remarks>
 430       </Docs>
 431       <Excluded>0</Excluded>
 432       <AssemblyInfo>
 433         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 434         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 435       </AssemblyInfo>
 436     </Member>
 437     <Member MemberName="Text">
 438       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType Text = 3" />
 439       <MemberSignature Language="C#" Value="Text" />
 440       <MemberType>Field</MemberType>
 441       <ReturnValue>
 442         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 443       </ReturnValue>
 444       <Parameters />
 445       <MemberValue>Text</MemberValue>
 446       <Docs>
 447         <summary>
 448           <para> The
 449       text content of a node.
 450       </para>
 451           <para> A <see langword="Text" /> node cannot have any child nodes.
 452    It can appear as the child node of the <see langword="Attribute" />,
 453 <see langword="DocumentFragment" />, <see langword="Element" />, and
 454 <see langword="EntityReference" />
 455 nodes.
 456 </para>
 457         </summary>
 458         <remarks>To be added.</remarks>
 459       </Docs>
 460       <Excluded>0</Excluded>
 461       <AssemblyInfo>
 462         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 463         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 464       </AssemblyInfo>
 465     </Member>
 466     <Member MemberName="Whitespace">
 467       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType Whitespace = 13" />
 468       <MemberSignature Language="C#" Value="Whitespace" />
 469       <MemberType>Field</MemberType>
 470       <ReturnValue>
 471         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 472       </ReturnValue>
 473       <Parameters />
 474       <MemberValue>Whitespace</MemberValue>
 475       <Docs>
 476         <summary>
 477           <para> White space between markup.
 478       </para>
 479         </summary>
 480         <remarks>To be added.</remarks>
 481       </Docs>
 482       <Excluded>0</Excluded>
 483       <AssemblyInfo>
 484         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 485         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 486       </AssemblyInfo>
 487     </Member>
 488     <Member MemberName="XmlDeclaration">
 489       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Xml.XmlNodeType XmlDeclaration = 17" />
 490       <MemberSignature Language="C#" Value="XmlDeclaration" />
 491       <MemberType>Field</MemberType>
 492       <ReturnValue>
 493         <ReturnType>System.Xml.XmlNodeType</ReturnType>
 494       </ReturnValue>
 495       <Parameters />
 496       <MemberValue>XmlDeclaration</MemberValue>
 497       <Docs>
 498         <summary>
 499           <para> The XML declaration.
 500  </para>
 501           <para> Example XML: <c>&lt;?xml version="1.0"?&gt;</c></para>
 502           <para> The <see langword="XmlDeclaration" />
 503 node must be the first node in the document. It cannot have children. It is a
 504 child of the <see langword="Document" />
 505 node. It can have attributes that provide version
 506 and encoding information.</para>
 507         </summary>
 508         <remarks>To be added.</remarks>
 509       </Docs>
 510       <Excluded>0</Excluded>
 511       <AssemblyInfo>
 512         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 513         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 514       </AssemblyInfo>
 515     </Member>
 516   </Members>
 517   <TypeExcluded>0</TypeExcluded>
 518 </Type>