ASP.NET 2.0中使用sitemapdatasource页面导航控件

原文出处:http://www.ad0.cn/netfetch/article.asp?id=285

 

sitemapdatasource , sitemapdatasource 中还可以绑定到不同的其他页面控件，比如treeview,menu等，十分灵活，使到能很方便地实现页面导航的不同形式，而且还提供了运行时的编程接口，可以以编程的形式动态实现页面导航控件。本文将简单以几个例子来介绍一下在asp.net 2.0中 sitemapdatasource 如何实现页面导航。
　　页面导航的结构和sitemapdatasource控件
　　在asp.net 2.0中，要实现页面导航，应该先以xml的形式，提供出整个网站的页面结构层次。我们可以编写一个叫web.sitemap的XML文本文件， 在该文件中定义出整个要导航页面的结构层次。举例如下：

程序代码:

＜?xml version="1.0" encoding="utf-8" ?＞
＜siteMap＞
　＜siteMapNode title="Default" description="Home" url="Default.aspx" ＞
　　＜siteMapNode title="Members" description="Members" url="Members.aspx"＞
　　　＜siteMapNode title="My Account" description="My Account" url="MyAccount.aspx" /＞
　　　＜siteMapNode title="Products" description="Products" url="Products.aspx" /＞
　　＜/siteMapNode＞
　　＜siteMapNode title="Administration" description="Administration" url="~/Admin/Default.aspx"＞
　　　＜siteMapNode title="Customer" description="Customer Admin" url="~/Admin/Customer/default.aspx" /＞
　　　＜siteMapNode title="Products Admin" description="Products Admin" url="~/Admin/ProductsAdmin.aspx" /＞
　　＜/siteMapNode＞
　＜/siteMapNode＞
＜/siteMap＞

　　我们可以看到，其中，web.sitemap文件必须包含根结点sitemap。而且，设置一个父sitemapnode结点，该结点表明是默认的站点首页，在该父sitemapnode结点下，可以有若干个子sitemapnode结点，分别按层次结构代表了网站的各子栏目（留意一下上例中，各个子结点之间的包含关系）。而每一个sitemapnode结点中，有如下若干个属性：
　　1）URL属性：该属性指出要导航的栏目的地址链接，在web.sitemap中定义中，必须是每个栏目的相对地址。
　　2)Title属性：该属性指出每个子栏目的名称，显示在页面中。
　　3）Description属性：该属性指定时，则用户在鼠标移动到该栏目时，出现有关该栏目的相关提示，类似于tooltips属性。
　　在设计好sitemap属性后，接下来就可以一步步构建页面导航功能了，主要有两个步骤：
　　1） 向页面中添加 sitemapdatasource控件。该控件会自动感应绑定web.sitemap中的内容。
　　2） 将 sitemapdatasource控件绑定到如sitemappath,treeview,menu等控件中，也就是说，将它们的数据源设置为该 sitemapdatasource控件。
　　知道了方法后，我们下面就分别以treeview,menu,sitemappath三种控件为例子，介绍一下如何和 sitemapdatasource控件进行配合使用。
　　先来介绍使用treeview控件和 sitemapdatasource 控件配合使用的方法。Treeview树形列表控件十分适合于用来做页面导航，为了能具体说明，我们充分利用asp.net中的masterpage控件，先搭建出一个网站的基本框架架构。
　　在visual web developer 2005 beta 1中，新建一个网站，之后添加上文的web.sitemap文件，再添加一个名叫Navigation的master类型的页面，代码如下：

[被屏蔽广告] 程序代码

＜%@ Master Language="C#" %＞
＜html xmlns=" http://www.w3.org/1999/xhtml" ＞
＜head id="Head1" runat="server"＞
＜title＞Master Page＜/title＞
＜/head＞
＜body＞
　＜form id="form1" runat="server"＞
　　＜div＞
　　＜table style="width: 100%; height: 100%" border="1"＞
　　＜tr＞
　　　＜td style="width: 10%"＞
　　　　＜asp:TreeView ID="TreeView1" Runat="server" DataSourceID=" SiteMapDataSource1"
　　　　　　ExpandDepth="2" ShowExpandCollapse="False" NodeIndent="10"＞
　　　　　＜LevelStyles＞
　　　　　　＜asp:TreeNodeStyle Font-Bold="True" Font-Underline="False"/＞
　　　　　　＜asp:TreeNodeStyle Font-Italic="True" Font-Underline="False" /＞
　　　　　　＜asp:TreeNodeStyle Font-Size="X-Small" ImageUrl="bullet.gif" Font-Underline="False" /＞
　　　　　＜/LevelStyles＞
　　　　　＜NodeStyle ChildNodesPadding="10" /＞
　　　　＜/asp:TreeView＞
　　　＜/td＞
　　　＜td style="width: 100px"＞
　　　　＜asp:contentplaceholder id="ContentPlaceHolder1"　runat="server"＞
　　　　＜/asp:contentplaceholder＞
　　　＜/td＞
　　＜/tr＞
　＜/table＞
　＜asp: SiteMapDataSource ID=" SiteMapDataSource1" Runat="server"/＞
　＜/div＞
＜/form＞
＜/body＞
＜/html＞

　　在上面的代码中，其中的TREEVIEW控件中的DATASORUCE属性中，就指定了 sitemapdatasource控件，并且在treeview控件中，也定义了不同结点的样式。
　　在完成了masterpage页面后，就等于已经把网站的模版页建立起来了，接下来就可以新建其他子页面，以继承masterpage页面，并且新建各自页面的内容了。比如，新建一个default.aspx页面，代码如下：

[被屏蔽广告] 程序代码

＜%@ Page Language="C#" MasterPageFile="Navigation.master" Title="Default Page"%＞
＜asp:Content ContentPlaceHolderID="ContentPlaceHolder1"
ID="Content1" Runat="Server"＞
This is the default page
＜/asp:Content＞

　　可以看到，当建立了模版页后，就可以新建其他的子页面了，只需要在其中的contentplaceholderid中写入不同的内容就可以了。运行起来后，效果如图：

　　接下来，我们来介绍如何将menu菜单控件和 sitemapdatasource 控件配合使用。其中，我们在上面的例子的基础上，在＜table style="width: 100%; height: 100%" border="1"＞下面增加如下代码就可以了，

[被屏蔽广告] 程序代码

＜tr height="100px"＞
＜td colspan="2" align="left"＞
＜asp:Menu ID="Menu1" Runat="Server"
DataSourceID=" SiteMapDataSource1"＞
＜/asp:Menu＞
＜/td＞
＜/tr＞

　　其中，我们增加了一个menu控件，其中将其datasourceid属性设定为 sitemapdatasource1就可以了，运行如下图，当然，我们可以改变menu控件的显示位置，如可以将其改成垂直样式显示。

　　而对于我们经常见到的显示出页面当前路径的导航条功能，在asp.net 2.0中也可以轻易实现，我们可以使用其中的sitemappath控件。我们紧接着在上文代码中的menu控件下，增加如下代码：

程序代码:

＜tr height="100px"＞
＜td colspan="2" align="left"＞
Currently Selected Page is:
＜asp:SiteMapPath Runat="Server" ID="SiteMapPath1"＞＜/asp:SiteMapPath＞
＜/td＞
＜/tr＞

　　要注意的是，只要增加sitemappath控件就可以了，因为它会自动和已经增加的 sitemapdatasource控件进行绑定的。我们为了说明问题，另外增加一个页面member.aspx,代码如下：

[被屏蔽广告] 程序代码

＜%@ Page Language="C#" MasterPageFile="Navigation.master" Title="Members Page"%＞
＜asp:Content ContentPlaceHolderID="ContentPlaceHolder1" ID="Content1" Runat="Server"＞
This is the members page
＜/asp:Content＞

　　运行结果如下：
　　　　

　　最后，我们看一下，如何通过编程的方式来获取页面导航中的相关数据。其中，必须引用到的是sitemap类，该类提供了很多相关的方法和属性，最重要的是currentnode属性，它可以指出当前用户正在浏览的是哪一个栏目页面，这用来跟踪用户在网站中的行动轨迹，并进行站点数据统计，有时是很有用的，举例如下：

[被屏蔽广告] 程序代码

＜%@ Page Language="C#" MasterPageFile="Navigation.master" Title="Members Page"%＞
＜script runat="Server"＞
void Page_Load(object sender, EventArgs e)
{
　Response.Write("The currently selected root node is: " + SiteMap.CurrentNode.Description + "＜br＞");
　Response.Write("The Parent for the currently selected node is : " +
　　　SiteMap.CurrentNode.ParentNode.Description);
}
＜/script＞
＜asp:Content ContentPlaceHolderID="ContentPlaceHolder1" ID="Content1" Runat="Server"＞
This is the members page
＜/asp:Content＞

　　在这个例子中，使用程序的方式，得出了用户当前正在浏览的栏目页面，以及该栏目的父栏目的名称，运行结果如下图：

　　可以看出，在asp.net 2.0中，实现页面导航的功能十分灵活而且方便，功能十分强大，更多的功能请参考MSDN。
SiteMapDataSource 类
注意：此类在 .NET Framework 2.0 版中是新增的。

提供了一个数据源控件，Web 服务器控件及其他控件可使用该控件绑定到分层的站点地图数据。
SiteMapDataSource 控件是站点地图数据的数据源，站点数据则由为站点配置的站点地图提供程序进行存储。 SiteMapDataSource 使那些并非专门作为站点导航控件的 Web 服务器控件（如 TreeView、Menu 和 DropDownList 控件）能够绑定到分层的站点地图数据。可以使用这些 Web 服务器控件将站点地图显示一个为目录，或者对站点进行主动式导航。当然，您也可以使用 SiteMapPath 控件，该控件被专门设计为一个站点导航控件，因此不需要 SiteMapDataSource 控件的实例。

SiteMapDataSource 绑定到站点地图数据， 并基于在站点地图层次结构中指定的起始节点显示其视图。默认情况下，起始节点是层次结构的根节点，但也可以是层次结构中的任何其他节点。起始节点由以下几个 SiteMapDataSource 属性的值来标识：


起始节点
属性值

层次结构的根节点（默认设置）。
StartFromCurrentNode 为 false。

未设置 StartingNodeUrl。

表示当前正在查看的页的节点。
StartFromCurrentNode 为 true。

未设置 StartingNodeUrl。

层次结构的特定节点。
StartFromCurrentNode 为 false。

已设置 StartingNodeUrl。


如果 StartingNodeOffset 属性设置为非 0 的值，则它会影响起始节点以及由 SiteMapDataSource 控件基于该节点公开的站点地图数据层次结构。StartingNodeOffset 的值为一个负整数或正整数，该值标识从 StartFromCurrentNode 和 StartingNodeUrl 属性所标识的起始节点沿站点地图层次结构上移或下移的层级数，以便对数据源控件公开的子树的起始节点进行偏移。

如果 StartingNodeOffset 属性设置为负数 -n，则由该数据源控件公开的子树的起始节点是所标识的起始节点上方 n 个级别的上级节点。如果 n 的值大于层次结构树中所标识起始节点上方的所有上级层级数，则子树的起始节点是站点地图层次结构的根节点。

如果 StartingNodeOffset 属性设置为正数 +n，则公开的子树的起始节点是位于所标识的起始节点下方 n 个级别的子节点。由于层次结构中可能存在多个子节点的分支，因此，如果可能， SiteMapDataSource 会尝试根据所标识起始节点与表示当前被请求页的节点之间的路径，直接解析子节点。如果表示当前被请求页的节点不在所标识起始节点的子树中，则忽略 StartingNodeOffset 属性的值。如果表示当前被请求页的节点与位于其上方的所标识起始节点之间的层级差距小于 n 个级别，则使用当前被请求页作为起始节点。

站点地图数据是从 SiteMapProvider 对象（如作为 ASP.NET 的默认站点地图提供程序的 XmlSiteMapProvider）中检索的。可指定为站点配置的任何提供程序向 SiteMapDataSource 提供站点地图数据，并且通过访问 SiteMap.Providers 集合可获得可用提供程序的列表。

与所有数据源控件一样， SiteMapDataSource 的每个实例都与单个帮助器对象关联，该帮助器对象称为数据源视图。SiteMapDataSourceView 是一个基于站点地图数据的视图，根据数据源的属性进行设置，并且通过调用 GetHierarchicalView 方法来检索此视图。SiteMapDataSourceView 维护控件所绑定到的 SiteMapNodeCollection 对象。

默认情况下，起始节点是层次结构的根节点，但是您可将起始节点设置为任何节点。起始节点可以是相对于站点地图中当前位置的一个节点，或者是相对于某个绝对位置的节点。通过设置 StartingNodeUrl 属性可指定起始节点。

SiteMapDataSource 专用于导航数据，并且不支持排序、筛选、分页或缓存之类的常规数据源操作，也不支持更新、插入或删除之类的数据记录操作。
示例

下面的代码示例演示如何以声明方式 使用 SiteMapDataSource 控件将 TreeView 控件绑定到一个站点地图。该站点地图数据从根节点级别开始检索。

C#

程序代码

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<HTML>
<BODY>
<FORM runat="server">
<asp: SiteMapDataSource
id=" SiteMapDataSource1"
runat="server" />

<asp:TreeView
id="TreeView1"
runat="server"
DataSourceID=" SiteMapDataSource1">
</asp:TreeView>

</FORM>
</BODY>
</HTML>


Visual Basic

程序代码

<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<HTML>
<BODY>
<FORM runat="server">
<asp: SiteMapDataSource
id=" SiteMapDataSource1"
runat="server" />

<asp:TreeView
id="TreeView1"
runat="server"
DataSourceID=" SiteMapDataSource1">
</asp:TreeView>

</FORM>
</BODY>
</HTML>

J#

程序代码

<%@ Page Language="VJ#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<HTML>
<BODY>
<FORM runat="server">
<asp: SiteMapDataSource
id=" SiteMapDataSource1"
runat="server">
</asp: SiteMapDataSource>

<asp:TreeView
id="TreeView1"
runat="server"
DataSourceID=" SiteMapDataSource1">
</asp:TreeView>

</FORM>
</BODY>
</HTML>

　　几乎每个网站里，为了方便用户在网站中进行页面导航，都少不了 使用页面导航控件。有了页面导航的功能，用户可以很方便地在一个复杂的网站中进行页面之间的跳转。在以往的WEB编程中，要写一个好的页面导航功能，并不是那么容易的，也要使用一些技巧。而在asp.net 2.0中，为了方便进行页面导航，新增了一个叫做页面导航控件