Now that V3 (or MOSS or Office12 or whatever you want to call it) is now out in the open, I thought I'd start occassionally sharing some hard earned information about it. I've been periodically doing some How To pieces internally for folks and it seems like sharing is a good idea. So, with that in mind, here's the first piece in what I hope will be multiple installments over time.
This particular topic came about as the result of a couple persistent questions I was seeing - a) how can I write a custom aspx page and have it run from a doc library and b) how can I get my custom pages to take on the same look and feel of the site in which it is hosted. This How To answers both of those questions.
- Create your page and code in a separate directory within the portal.
- Get your code working
- Create a page without the code behind and add your code and event handlers inline to the new page.
- Modify the page directive to:
- Use the master page for the site
- Inherit from webpartpage. Your page declaration should look something like this:
<%@ Page Language="C#" MasterPageFile="~masterurl/custom.master" Inherits="Microsoft.SharePoint.WebPartPages.WebPartPage,Microsoft.SharePoint,Version=12.0.0.0,Culture=neutral,PublicKeyToken=71e9bce111e9429c" %>
5. Add the other register directives and <asp:Content> controls. You can use existing pages that SharePoint provides out of the box as reference. As an example, here are the directives and controls added from the default.aspx page in the SPS site template:
<%@ Register Tagprefix="SharePoint" Namespace="Microsoft.SharePoint.WebControls" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register Tagprefix="WebPartPages" Namespace="Microsoft.SharePoint.WebPartPages" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register Tagprefix="OSRVWC" Namespace="Microsoft.Office.Server.WebControls" Assembly="Microsoft.Office.Server, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register Tagprefix="SPSWC" Namespace="Microsoft.SharePoint.Portal.WebControls" Assembly="Microsoft.SharePoint.Portal, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register Tagprefix="SEARCHWC" Namespace="Microsoft.Office.Server.Search.WebControls" Assembly="Microsoft.Office.Server.Search, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register Tagprefix="PublishingWebControls" Namespace="Microsoft.SharePoint.Publishing.WebControls" Assembly="Microsoft.SharePoint.Publishing, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
NOTE: I'm including several Content controls below; the controls you need will vary depending upon your Master Page.
<asp:Content ContentPlaceHolderID="PlaceHolderPageTitle" runat="server"></asp:Content>
<asp:Content ContentPlaceHolderID="PlaceHolderPageTitleInTitleArea" runat="server"></asp:Content>
<asp:Content ContentPlaceHolderId="PlaceHolderPageImage" runat="server"><IMG SRC="/_layouts/images/blank.gif" width=1 height=1 alt=""></asp:Content>
<asp:Content ContentPlaceHolderId="PlaceHolderTitleBreadcrumb" runat="server"/>
<asp:Content ContentPlaceHolderId="PlaceHolderTitleAreaClass" runat="server">
<style>
TD.ms-titleareaframe, .ms-pagetitleareaframe {
height: 10px;
}
Div.ms-titleareaframe {
height: 100%;
}
.ms-pagetitleareaframe table {
background: none;
height: 10px;
}
</style>
</asp:Content>
<!-- your inline script & event handlers can go here -->
<asp:Content ContentPlaceHolderID="PlaceHolderMain" runat="server">
<!-- your controls and content goes here -->
</asp:Content>
6. Upload the page to the Pages library (or any doc library for that matter)
7. Add the path to the library where you uploaded the item into the PageParserPaths section of the web.config for your SharePoint web application. For example, to enable inline code in the Pages library you would add a line like this:
<PageParserPaths>
<PageParserPath VirtualPath="/pages/*" CompilationMode="Always" AllowServerSideScript="true" IncludeSubFolders="true"/>
</PageParserPaths>
NOTE: You want to be careful about where you add a PageParserPath VirtualPath. ANYONE that can upload a page can upload something that will execute code at that point.
8. Do an IISRESET
9. Click on your page; it should execute now and appear using the same master page and UI as the rest of the site.
That's it! This is something that I think will come in handy, and hopefully these instructions will get you there faster.
pBoy