mcs/class/System.XML/Documentation/en/System.Xml.XPath/XPathExpression.xml

   1 <Type Name="XPathExpression" FullName="System.Xml.XPath.XPathExpression">
   2   <TypeSignature Maintainer="auto" Language="C#" Value="public abstract class XPathExpression" />
   3   <AssemblyInfo>
   4     <AssemblyName>System.Xml</AssemblyName>
   5     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <ThreadSafetyStatement>All the dynamic members are not designed to be thread safe. This class cannot be used parallely in multiple thread for XPath evaluation.</ThreadSafetyStatement>
  10   <Base>
  11     <BaseTypeName>System.Object</BaseTypeName>
  12   </Base>
  13   <Interfaces />
  14   <Docs>
  15     <summary>Represents a compiled XPath expression that is ready for evaluation. This class is mainly used to avoid multiple-time compilation of XPath expression string. To create XPathExpression instance, <see cref="M:System.Xml.XPath.XPathNavigator.Compile" /> is used.</summary>
  16     <remarks>To be added.</remarks>
  17   </Docs>
  18   <Members>
  19     <Member MemberName="AddSort">
  20       <MemberSignature Language="C#" Value="public abstract void AddSort (object expr, System.Collections.IComparer comparer);" />
  21       <MemberType>Method</MemberType>
  22       <ReturnValue>
  23         <ReturnType>System.Void</ReturnType>
  24       </ReturnValue>
  25       <Parameters>
  26         <Parameter Name="expr" Type="System.Object" />
  27         <Parameter Name="comparer" Type="System.Collections.IComparer" />
  28       </Parameters>
  29       <Docs>
  30         <param name="expr">To be added.</param>
  31         <param name="comparer">An <see cref="T:System.Collections.IComparer" /> instance that is used to sort results.</param>
  32         <summary>Indicates this instance that the evaluation result of this expression must be sorted in the specified order.</summary>
  33         <remarks>With this IComparer parameter, it is possible to sort result values in custom sorting.</remarks>
  34       </Docs>
  35       <AssemblyInfo>
  36         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  37         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  38       </AssemblyInfo>
  39     </Member>
  40     <Member MemberName="AddSort">
  41       <MemberSignature Language="C#" Value="public abstract void AddSort (object expr, System.Xml.XPath.XmlSortOrder order, System.Xml.XPath.XmlCaseOrder caseOrder, string lang, System.Xml.XPath.XmlDataType dataType);" />
  42       <MemberType>Method</MemberType>
  43       <ReturnValue>
  44         <ReturnType>System.Void</ReturnType>
  45       </ReturnValue>
  46       <Parameters>
  47         <Parameter Name="expr" Type="System.Object" />
  48         <Parameter Name="order" Type="System.Xml.XPath.XmlSortOrder" />
  49         <Parameter Name="caseOrder" Type="System.Xml.XPath.XmlCaseOrder" />
  50         <Parameter Name="lang" Type="System.String" />
  51         <Parameter Name="dataType" Type="System.Xml.XPath.XmlDataType" />
  52       </Parameters>
  53       <Docs>
  54         <param name="expr">A <see cref="T:System.String" /> or <see cref="T:System.Xml.XPath.XPathExpression" /> instance that represents an XPath expression.</param>
  55         <param name="order">An <see cref="T:System.Xml.XPath.XmlSortOrder" /> value that indicates if the sorting is done in ascending or descending.</param>
  56         <param name="caseOrder">An <see cref="T:System.Xml.XPath.XmlCaseOrder" /> value that indicates the character case ordering (lower-first, upper-first or ignore the case).</param>
  57         <param name="lang">A string that represents language that is used for case order evaluation.</param>
  58         <param name="dataType">A <see cref="T:System.Xml.XPath.XmlDataType" /> value that indicates if the sorting is done by string comparison or numeric comparison.</param>
  59         <summary>Indicates this instance that the evaluation result of this expression must be sorted in the specified order.</summary>
  60         <remarks>Sorting feature is typically used internally in XSLT "for-each" expression. Thus, this method is designed to be capable of processing XSLT conformant sorting.</remarks>
  61       </Docs>
  62       <AssemblyInfo>
  63         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  64         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  65       </AssemblyInfo>
  66     </Member>
  67     <Member MemberName="Clone">
  68       <MemberSignature Language="C#" Value="public abstract System.Xml.XPath.XPathExpression Clone ();" />
  69       <MemberType>Method</MemberType>
  70       <ReturnValue>
  71         <ReturnType>System.Xml.XPath.XPathExpression</ReturnType>
  72       </ReturnValue>
  73       <Parameters />
  74       <Docs>
  75         <summary>Clones this instance and returns the copy.</summary>
  76         <returns>An XPathExpression that is the copy of this instance.</returns>
  77         <remarks>To be added.</remarks>
  78       </Docs>
  79       <AssemblyInfo>
  80         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  81         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  82       </AssemblyInfo>
  83     </Member>
  84     <Member MemberName="Compile">
  85       <MemberSignature Language="C#" Value="public static System.Xml.XPath.XPathExpression Compile (string xpath);" />
  86       <MemberType>Method</MemberType>
  87       <ReturnValue>
  88         <ReturnType>System.Xml.XPath.XPathExpression</ReturnType>
  89       </ReturnValue>
  90       <Parameters>
  91         <Parameter Name="xpath" Type="System.String" />
  92       </Parameters>
  93       <Docs>
  94         <param name="xpath">To be added.</param>
  95         <summary>To be added.</summary>
  96         <returns>To be added.</returns>
  97         <remarks>To be added.</remarks>
  98         <since version=".NET 2.0" />
  99       </Docs>
 100       <AssemblyInfo>
 101         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 102       </AssemblyInfo>
 103     </Member>
 104     <Member MemberName="Compile">
 105       <MemberSignature Language="C#" Value="public static System.Xml.XPath.XPathExpression Compile (string xpath, System.Xml.IXmlNamespaceResolver nsmgr);" />
 106       <MemberType>Method</MemberType>
 107       <ReturnValue>
 108         <ReturnType>System.Xml.XPath.XPathExpression</ReturnType>
 109       </ReturnValue>
 110       <Parameters>
 111         <Parameter Name="xpath" Type="System.String" />
 112         <Parameter Name="nsmgr" Type="System.Xml.IXmlNamespaceResolver" />
 113       </Parameters>
 114       <Docs>
 115         <param name="xpath">To be added.</param>
 116         <param name="nsmgr">To be added.</param>
 117         <summary>To be added.</summary>
 118         <returns>To be added.</returns>
 119         <remarks>To be added.</remarks>
 120         <since version=".NET 2.0" />
 121       </Docs>
 122       <AssemblyInfo>
 123         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 124       </AssemblyInfo>
 125     </Member>
 126     <Member MemberName="Expression">
 127       <MemberSignature Language="C#" Value="public abstract string Expression { get; }" />
 128       <MemberType>Property</MemberType>
 129       <ReturnValue>
 130         <ReturnType>System.String</ReturnType>
 131       </ReturnValue>
 132       <Docs>
 133         <summary>This property is a string representation of this XPath expression.</summary>
 134         <value>The string that represents the XPath expression.</value>
 135         <remarks>To be added.</remarks>
 136       </Docs>
 137       <AssemblyInfo>
 138         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 139         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 140       </AssemblyInfo>
 141     </Member>
 142     <Member MemberName="ReturnType">
 143       <MemberSignature Language="C#" Value="public abstract System.Xml.XPath.XPathResultType ReturnType { get; }" />
 144       <MemberType>Property</MemberType>
 145       <ReturnValue>
 146         <ReturnType>System.Xml.XPath.XPathResultType</ReturnType>
 147       </ReturnValue>
 148       <Docs>
 149         <summary>Represents the return type of this XPath expression.</summary>
 150         <value>An <see cref="T:System.Xml.XPath.XPathResultType" /> value that indicates the return type.</value>
 151         <remarks>The return type varies for each XPath expression and it might be <see cref="F:System.Xml.XPath.XPathResultType.Any" />. For example, the return type of a variable binding expression (e.g. "$foo") can be anything.</remarks>
 152       </Docs>
 153       <AssemblyInfo>
 154         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 155         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 156       </AssemblyInfo>
 157     </Member>
 158     <Member MemberName="SetContext">
 159       <MemberSignature Language="C#" Value="public abstract void SetContext (System.Xml.IXmlNamespaceResolver nsResolver);" />
 160       <MemberType>Method</MemberType>
 161       <ReturnValue>
 162         <ReturnType>System.Void</ReturnType>
 163       </ReturnValue>
 164       <Parameters>
 165         <Parameter Name="nsResolver" Type="System.Xml.IXmlNamespaceResolver" />
 166       </Parameters>
 167       <Docs>
 168         <param name="nsResolver">To be added.</param>
 169         <summary>To be added.</summary>
 170         <remarks>To be added.</remarks>
 171         <since version=".NET 2.0" />
 172       </Docs>
 173       <AssemblyInfo>
 174         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 175       </AssemblyInfo>
 176     </Member>
 177     <Member MemberName="SetContext">
 178       <MemberSignature Language="C#" Value="public abstract void SetContext (System.Xml.XmlNamespaceManager nsManager);" />
 179       <MemberType>Method</MemberType>
 180       <ReturnValue>
 181         <ReturnType>System.Void</ReturnType>
 182       </ReturnValue>
 183       <Parameters>
 184         <Parameter Name="nsManager" Type="System.Xml.XmlNamespaceManager" />
 185       </Parameters>
 186       <Docs>
 187         <param name="nsManager">an <see cref="T:System.Xml.XmlNamespaceManager" /> to be used as XPath evaluation context.</param>
 188         <summary>Sets an <see cref="T:System.Xml.XmlNamespaceManager" /> instance as an XPath evaluation context, especially to provide namespace mappings in XPath.</summary>
 189         <remarks>
 190           <para>
 191                 This method sets an XmlNamespaceManager as XPath (and thus XSLT) evaluation context. This class might provide other XSLT context information such as current whitespace preservation value and current variable bindings. (<see cref="T:System.Xml.Xsl.XsltContext" /> is derived from XmlNamespaceManager.)
 192                 </para>
 193           <para>
 194                 To evaluate compiled XPath expression that was originally just a string that might contain arbitrary namespace prefixes, this class requires a "namespace context" before evaluating prefixed XPath expression. The argument XmlNamespaceManager has a mapping from prefix (that might be used in XPath expression string) and namespace URI. Without this information, XPath evaluation might result in an error (since it cannot determine the namespace URI for the prefix).
 195                 </para>
 196         </remarks>
 197       </Docs>
 198       <AssemblyInfo>
 199         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 200         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 201       </AssemblyInfo>
 202     </Member>
 203   </Members>
 204 </Type>