linux-packaging-mono/mcs/class/System.XML/Documentation/en/System.Xml.XPath/XPathDocument.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="XPathDocument" FullName="System.Xml.XPath.XPathDocument">
  <TypeSignature Maintainer="auto" Language="C#" Value="public class XPathDocument : System.Xml.XPath.IXPathNavigable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit XPathDocument extends System.Object implements class System.Xml.XPath.IXPathNavigable" />
  <AssemblyInfo>
    <AssemblyName>System.Xml</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <ThreadSafetyStatement>This class is not thread safe.</ThreadSafetyStatement>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.Xml.XPath.IXPathNavigable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>For more information about processing XML data by using the XPath data model, see the <format type="text/html"><a href="536c6fce-1453-4654-9c72-bca54d47e081">Process XML Data Using the XPath Data Model</a></format> topic.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides a fast, read-only, in-memory representation of an XML document by using the XPath data model.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public XPathDocument (System.IO.Stream stream);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream stream) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue />
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Xml.XPath.XPathDocument" /> class from the XML data in the specified <see cref="T:System.IO.Stream" /> object.</para>
        </summary>
        <param name="stream">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.Stream" /> object that contains the XML data.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public XPathDocument (System.IO.TextReader textReader);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.TextReader textReader) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue />
      <Parameters>
        <Parameter Name="textReader" Type="System.IO.TextReader" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>After the <see cref="T:System.IO.TextReader" /> object has been used to load XML data, the cursor of the <see cref="T:System.IO.TextReader" /> object is positioned at the end of the data. The <see cref="T:System.IO.TextReader" /> object must be reset to read through the data again.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Xml.XPath.XPathDocument" /> class from the XML data that is contained in the specified <see cref="T:System.IO.TextReader" /> object.</para>
        </summary>
        <param name="textReader">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.TextReader" /> object that contains the XML data.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public XPathDocument (string uri);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string uri) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue />
      <Parameters>
        <Parameter Name="uri" Type="System.String" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>To preserve white space, use the <see cref="M:System.Xml.XPath.XPathDocument.#ctor(System.String,System.Xml.XmlSpace)" /> constructor that accepts an <see cref="T:System.Xml.XmlSpace" /> object as a parameter.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Xml.XPath.XPathDocument" /> class from the XML data in the specified file.</para>
        </summary>
        <param name="uri">
          <attribution license="cc4" from="Microsoft" modified="false" />The path of the file that contains the XML data.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public XPathDocument (System.Xml.XmlReader reader);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Xml.XmlReader reader) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue />
      <Parameters>
        <Parameter Name="reader" Type="System.Xml.XmlReader" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An <see cref="T:System.Xml.XmlReader" /> object can be used to load a whole XML document or part of an XML document into an <see cref="T:System.Xml.XPath.XPathDocument" />. To load part of an XML document into an <see cref="T:System.Xml.XPath.XPathDocument" />, position the <see cref="T:System.Xml.XmlReader" /> object on the top XML node to load data from. When you create an <see cref="T:System.Xml.XPath.XPathDocument" /> by using the <see cref="M:System.Xml.XPath.XPathDocument.#ctor(System.Xml.XmlReader)" /> constructor, data is loaded from the current top node through all its siblings. Afterwards, the <see cref="T:System.Xml.XmlReader" /> is positioned on the outer scope of the top XML node. Alternatively, you can use the <see cref="M:System.XmlReader.ReadSubtree" /> method to load the <see cref="T:System.Xml.XPath.XPathDocument" /> into a particular  element in the XML document.</para>
          <para>The following are important notes to consider when you use the <see cref="M:System.Xml.XPath.XPathDocument.#ctor(System.Xml.XmlReader)" /> constructor.</para>
          <list type="bullet">
            <item>
              <para>An <see cref="T:System.Xml.XmlReader" /> object with the appropriate associated <see cref="T:System.Xml.XmlResolver" /> object settings can be used to resolve entities or other references in XML data.</para>
            </item>
            <item>
              <para>If the <see cref="T:System.Xml.XmlReader" /> object is positioned on a leaf node that is not valid for the root level of a document—for example, a white space or attribute node—the <see cref="T:System.Xml.XmlReader" /> object continues to read until it is positioned on a node that can be used for the root. The <see cref="T:System.Xml.XPath.XPathDocument" /> begins loading at this point.</para>
            </item>
            <item>
              <para>To preserve white space, use the <see cref="M:System.Xml.XPath.XPathDocument.#ctor(System.Xml.XmlReader,System.Xml.XmlSpace)" /> constructor that accepts an <see cref="T:System.Xml.XmlSpace" /> object as a parameter.</para>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Xml.XPath.XPathDocument" /> class from the XML data that is contained in the specified <see cref="T:System.Xml.XmlReader" /> object.</para>
        </summary>
        <param name="reader">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.XmlReader" /> object that contains the XML data. </param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public XPathDocument (string uri, System.Xml.XmlSpace space);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string uri, valuetype System.Xml.XmlSpace space) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue />
      <Parameters>
        <Parameter Name="uri" Type="System.String" />
        <Parameter Name="space" Type="System.Xml.XmlSpace" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <list type="bullet">
            <item>
              <para>The <see cref="T:System.Xml.XmlSpace" /> object passed as a parameter specifies whether to preserve white space. <see cref="F:System.Xml.XmlSpace.Default" /> preserves only significant white space; <see cref="F:System.Xml.XmlSpace.Preserve" /> preserves all white space. By default, the <see cref="T:System.Xml.XmlSpace" /> object is set to <see cref="F:System.Xml.XmlSpace.Default" />.</para>
            </item>
            <item>
              <para>The functionality of the <see cref="M:System.Xml.XPath.XPathDocument.#ctor(System.String,System.Xml.XmlSpace)" /> constructor is identical to that of the <see cref="M:System.Xml.XPath.XPathDocument.#ctor(System.String)" /> constructor, except for the white space handling options described.</para>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Xml.XPath.XPathDocument" /> class from the XML data in the file specified with the white space handling specified.</para>
        </summary>
        <param name="uri">
          <attribution license="cc4" from="Microsoft" modified="false" />The path of the file that contains the XML data.</param>
        <param name="space">
          <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.XmlSpace" /> object.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public XPathDocument (System.Xml.XmlReader reader, System.Xml.XmlSpace space);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Xml.XmlReader reader, valuetype System.Xml.XmlSpace space) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue />
      <Parameters>
        <Parameter Name="reader" Type="System.Xml.XmlReader" />
        <Parameter Name="space" Type="System.Xml.XmlSpace" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <list type="bullet">
            <item>
              <para>The <see cref="T:System.Xml.XmlSpace" /> object passed as a parameter specifies whether to preserve white space. <see cref="F:System.Xml.XmlSpace.Default" /> preserves only significant white space; <see cref="F:System.Xml.XmlSpace.Preserve" /> preserves all white space. By default, the <see cref="T:System.Xml.XmlSpace" /> object is set to <see cref="F:System.Xml.XmlSpace.Default" />.</para>
            </item>
            <item>
              <para>The functionality of the <see cref="M:System.Xml.XPath.XPathDocument.#ctor(System.Xml.XmlReader,System.Xml.XmlSpace)" /> constructor is identical to that of the <see cref="M:System.Xml.XPath.XPathDocument.#ctor(System.Xml.XmlReader)" /> constructor, except for the white space handling options described.</para>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Xml.XPath.XPathDocument" /> class from the XML data that is contained in the specified <see cref="T:System.Xml.XmlReader" /> object with the specified white space handling.</para>
        </summary>
        <param name="reader">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.XmlReader" /> object that contains the XML data.</param>
        <param name="space">
          <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.XmlSpace" /> object.</param>
      </Docs>
    </Member>
    <Member MemberName="CreateNavigator">
      <MemberSignature Language="C#" Value="public System.Xml.XPath.XPathNavigator CreateNavigator ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Xml.XPath.XPathNavigator CreateNavigator() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Xml.XPath.XPathNavigator</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="T:System.Xml.XPath.XPathNavigator" /> is positioned on the root element of the <see cref="T:System.Xml.XPath.XPathDocument" />. If there is no root element, the <see cref="T:System.Xml.XPath.XPathNavigator" /> is positioned on the first element in the <see cref="T:System.Xml.XPath.XPathDocument" />.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a read-only <see cref="T:System.Xml.XPath.XPathNavigator" /> object for navigating through nodes in this <see cref="T:System.Xml.XPath.XPathDocument" />.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>A read-only <see cref="T:System.Xml.XPath.XPathNavigator" /> object.</para>
        </returns>
      </Docs>
    </Member>
  </Members>
</Type>