MSDN Visual系列:在SharePoint中创建应用程序页面
在自定义SharePoint解决方案中,我们可以通过创建自定义应用程序页面的方式来添加一些用户界面组件。与站点页面(如,default.aspx)不同,一个应用程序页面需要在每个前端Web服务器上部署一次,并且不能在各个站点中被定制。应用程序页面宿主在_layouts虚拟目录中。而且,它们的后台代码被编译到了一个单独的DLL中。它们在一个服务器场中是通用的。正因为这些原因,它们比站点页面的性能要好。在应用程序页面中,我们可以随意的添加代码逻辑。对于站点页面,这是不可以的。
代码工作
通常,我们将自定义应用程序页面关联到application.master这个母版页。SharePoint默认的后台应用页面都是使用这个母版页。同样,我们也要将自定义应用程序页面继承自Microsoft.SharePoint.dll中定义的一个基类,名叫LayoutsPageBase。下面的例子为自定义应用程序页面提供了个基本框架。
<%@ Page Language="C#" MasterPageFile="~/_layouts/application.master"
Inherits="Microsoft.SharePoint.WebControls.LayoutsPageBase" %>
<%@ Import Namespace="Microsoft.SharePoint" %>
<script runat="server">
protected override void OnLoad(EventArgs e) {
SPWeb site = this.Web;
lblSiteTitle.Text = site.Title;
lblSiteID.Text = site.ID.ToString().ToUpper();
}
</script>
<asp:Content ID="Main" runat="server"
contentplaceholderid="PlaceHolderMain" >
Site Title: <asp:Label ID="lblSiteTitle" runat="server" />
<br/>
Site ID: <asp:Label ID="lblSiteID" runat="server" />
</asp:Content>
<asp:Content ID="PageTitle" runat="server"
contentplaceholderid="PlaceHolderPageTitle" >
Hello World
</asp:Content>
<asp:Content ID="PageTitleInTitleArea" runat="server"
contentplaceholderid="PlaceHolderPageTitleInTitleArea" >
The Quintessential 'Hello World' of Application Page
</asp:Content>
部署
尽管我们可以将我们写好的页面直接部署到\LAYOUTS目录下,但这么做有可能和MS或其他第三方公司创建的页面发生重名。最好是将我们的页面部署到一个\LAYOUTS下的公司专用或项目专用的目录下。比如,我们可以将上面的应用程序页面部署到一个公司专用的目录\Layouts\Litware下。
要点:
我们通常将我们的应用程序关联到application.master母版页。在我们的文章中展示的示例自定义页面添加了三个Content标签用于在结果页面中输出HTML内容。通常情况下,这个页面会替换application.master中定义的三个占位符:PlaceHolderMain,PlaceHolderPageTitle和PlaceHolderPageTitleInTitleArea。可是这只是可供我们覆盖的所有占位符得一小部分。
同时,还需要注意的一点是,一个应用程序页面可以放一段脚本在顶部,使用编程方式操作对象模型。当我们在Visual Studio 2005种编写一个简单页面时,可以很方便的利用代码颜色和代码智能感知功能帮助我们完成这类代码的编写。然而,对于SharePoint的应用程序页面来说,我们必须手工将@Assembly内容编写上,并且正确的添加引用到Microsoft.SharePoint.dll。
应用程序页是很有用的。它提供了快速、简便的方式来访问SharePoint对象模型。当创建了一个应用程序页面并覆写了Onload方法后,我们可以获取通过下面的代码获取到当前站点上下文环境下的整个SharePoint对象模型。
SPWeb site = SPContext.Current.Web;
获取站点上下文的能力使我们编写的应用程序页面变得更强大。一个应用页面会由于访问它的上下文站点不同而不同。我们通过一个站点上下文环境访问,和在另一个站点上下文环境下访问得到的结果可能无论从展现上或功能上都不尽相同。
查看视频