TemplateControl.XPath Method (String) (System.Web.UI)

.NET Framework Class Library

TemplateControl..::.XPath Method (String)

Evaluates an XPath data-binding expression.

Namespace: System.Web.UI
Assembly: System.Web (in System.Web.dll)

Protected Friend Function XPath ( _
	xPathExpression As String _
) As Object

protected internal Object XPath(
	string xPathExpression
)

protected public:
Object^ XPath(
	String^ xPathExpression
)

member XPath : 
        xPathExpression:string -> Object

Parameters

xPathExpression: Type: System..::.String
The XPath expression to evaluate. For more information, see XPathBinder.

Return Value

Type: System..::.Object
An object that results from the evaluation of the data-binding expression.

Exceptions

Exception	Condition
InvalidOperationException	The data-binding method can be used only for controls contained on a Page.

Remarks

The XPath method calls the XPathBinder..::.Eval method using the GetDataItem method to resolve the IXPathNavigable object reference that the expression is evaluated against.

Examples

The following code example demonstrates how to use the XPath method in a Repeater control.


<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>TemplateControl XPath Example</title>
</head>
<body>
    <h3>TemplateControl XPath and XPathSelect Example</h3>
    <form id="form1" runat="server">
    <div>
      <asp:XmlDataSource
        id="XmlDataSource1" 
        runat="server"
        XPath="contacts" 
        DataFile="contacts.xml" />    
      <asp:FormView 
        id="FormView1" 
        runat="server" 
        DataSourceID="XmlDataSource1">
        <ItemTemplate>
          <hr />
          <asp:Repeater 
            id="Repeater1" 
            runat="server" 
            DataSource='<%# XPathSelect("contact") %>' >
            <ItemTemplate>
              Name: <%# XPath("name") %> <br />
              Note: <%# XPath("note") %> <br />
              <hr />
            </ItemTemplate>
          </asp:Repeater>
        </ItemTemplate>
      </asp:FormView>
    </div>
    </form>
</body>
</html>


<%@ Page Language="C#"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>TemplateControl XPath and XPathSelect Example</title>
</head>
<body>
    <h3>TemplateControl XPath Example</h3>
    <form id="form1" runat="server">
    <div>
      <asp:XmlDataSource
        id="XmlDataSource1" 
        runat="server"
        XPath="contacts" 
        DataFile="contacts.xml" />    
      <asp:FormView 
        id="FormView1" 
        runat="server" 
        DataSourceID="XmlDataSource1">
        <ItemTemplate>
          <hr />
          <asp:Repeater 
            id="Repeater1" 
            runat="server" 
            DataSource='<%# XPathSelect("contact") %>' >
            <ItemTemplate>
              Name: <%# XPath("name") %> <br />
              Note: <%# XPath("note") %> <br />
              <hr />
            </ItemTemplate>
          </asp:Repeater>
        </ItemTemplate>
      </asp:FormView>
    </div>
    </form>
</body>
</html>

The following test XML data can be used in the preceding code example.

<contacts>
   <contact id="1">
     <name>contact name 1</name>
     <note>contact note 1</note>
   </contact>
   <contact id="2">
     <name>contact name 2</name>
     <note>contact note 2</note>
   </contact>
</contacts>

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

TemplateControl Class

XPath Overload

System.Web.UI Namespace

XPathBinder

Other Resources

Data-Binding Expression Syntax

Advertise Here