ASP to MOSS

Introduction

 We already have a number of ASP .Net Web Applications consisting web forms, user controls, business layer, and data access layer, Many times a need arises to add this web application to a SharePoint site.

This article discusses different/various ways of integrating aspx pages of a web application to a SharePoint site.

The main advantages of this approach are:

1. Business users and end users need not go to a separate web application URL(All those pages can be seen within the SharePoint site itself.
2. Once the integration is done, the SharePoint site’s security and access rules i.e. Authentication and Authorization (is) are in place without any additional work.

Solutions

1.   Custom built Web Parts

       A good use of web parts would be where you want to build a widget/mini-application that could be put on many/different web part pages across sites.

            With this option you need to build your UI using the Web Part framework, where your logic can be within other .Net assemblies or in a web service, just like in any other .Net application.

Pros:

• Built using ASP.Net Web Part framework
• Deployed via “Web Part install package” or the “new Feature/Solution Deployment” mechanism
• SharePoint application provides hosting framework for putting these Web Parts on Web Part pages
• Communications framework for talking with/to other Web Parts
• Designed to be highly re-usable across many sites with minimal effort

Cons:

• No drag and drop UI functionality for laying out your UI i.e. no design time surface
• A framework that developers must learn to work within.
• Developing many web parts is not feasible and also raises performance issues.

   2.   User Controls and the SmartPart

In this method the developer can develop/create a user control and drop it in the smart part. This method is similar to creating web parts but here the developer has the privilege of drag-drop functionality This approach has the limitations of custom built web parts

The application UI can be built using ASP.Net user controls or by converting the aspx and aspx.cs pages to user controls, and then use SmartPart to deliver these User Controls via a web part

      To get a detailed description on how to convert Web Forms Pages into ASP.NET User Controls click   here .

The Son of SmartPart is a Web Part that is able to "host" an ASP.Net 2.0 User Control.

Pros:

• Simple development experience.
• You get a design surface to build you UI
• Deployment is reasonably straight forward
• Can use Web Part connection framework if desired

Cons:

• Deployment not managed via Solution deployment mechanism Out of the Box (you could build a solution to deploy the Son of Smart Part)
• Slightly different deployment of User Control files and assemblies (a .bat file can be used for easy deployment) during development.

  3.   _Layouts folder approach:

 4.   ASPX pages added to SharePoint Site

This option allows you to add your ASP.Net application pages into your SharePoint Site.  It also provides for compiling all the code behind of your pages into a DLL. In a nutshell this option allows you to build your ASP.Net application outside of SharePoint, build it, test it & then add it to SharePoint. 

Here is how to do it:

1. Install the Visual Studio 2005 Web Application Projects extension.  This gives you the 'old style' web    projects in Visual Studio, so you can compile down to a single DLL

2. START -> File -> New Project -> ASP.NET Web Application - Name it "ASPtoSP"

3. Add reference to Microsoft. SharePoint

4. In the Solution Explorer create a folder "~masterurl" and add master page "default.Master" inside it

5. Replace code behind for the master page with:

using System;
using Microsoft.SharePoint;
namespace ASPtoSP._masterurl
{
public partial class _default : System.Web.UI.MasterPage
{
protected void Page_Load(object sender, EventArgs e)
{
}
}
}

7. Delete Default.aspx, and add new page – “SamplePage.aspx”

After adding all your files right click on the project in solution explorer and choose convert to web application project. This will create partial class for all your aspx pages i.e. designer.cs.

8. Replace source content with the following:

<%@ Page Language="C#" MasterPageFile="~masterurl/default.master" CodeBehind="SamplePage.aspx" Inherits="ASPtoSP.SamplePage" Title="Untitled Page" %> 
<asp:Content ID="Content5" ContentPlaceHolderID="PlaceHolderMain" runat="server"> 
Testing Page... 
<asp:Label ID="Label1" runat="server" Text="Label"></asp:Label> 
</asp:Content> 

Give the namespace as ASPtoSP to both aspx.cs and designer.cs file.

10. Project properties -> Build -> Output path:

Point it to \BIN folder of our SharePoint Web application.

E.g. C:\Inetpub\wwwroot\wss\VirtualDirectories\moss.litwareinc.com80\bin

You can also manually copy your projects DLL into the \BIN folder each time.

11. Compile your project.

12. Open the web.config file for the SharePoint Web Applicaiton

E.g.C:\Inetpub\wwwroot\wss\VirtualDirectories\moss.litwareinc.com80\web.config

13. Add the following line to the SafeControls section (change to suit your assembly and namespace

<SafeControl Assembly="ASPtoSP" Namespace="ASPtoSP" TypeName="*" />

14. Change the

<trust level="WSS_Minimal" originUrl="" /> line to <trust level="WSS_Medium" originUrl="" />

Add the following line under the <PageParserPath> section:

<PageParserPath VirtualPath="/*" CompilationMode="Always" AllowServerSideScript="true" IncludeSubFolders="true" />

Change MaxControls value from 200 to 800

For viewing the errors set

       debug=”on”

       callStack=”true”

       customErrors mode=”off”

15. Open your site in SharePoint Designer and drag and drop your SamplePage.aspx page into a folder in your site.

Or you can also deploy these pages to one of the SharePoint web application as a feature.

For this you need to write one feature.xml and module.xml and install using stsadm utility.

16. Browse to your page E.g.

http://moss.litwareinc.com/TestApp/TestPages.aspx

17. You should now have your aspx page running in SharePoint.

One great thing about this option is that you could build your applicaiton outside of SharePoint with any old MasterPage, then deploy to SharePoint and swap out the masterpage string for the correct one.  Thus being able to develop and debug outside of SharePoint and then deploy and test inside SharePoint. 

A note on debugging:  If you want to debug your code once it is running inside SharePoint then all you need to do is attach the Visual Studio debugger to the correct w3wp.exe process (Debug -> Attach to process), set your break points and then hit your page in a browser.

Pros:

• Simple development experience. Develop outside SharePoint first if desired.
• You get a design surface to build you UI.
• Deployment reasonably straight forward, can be deployed as a feature packaged in a solution package.

Cons:

• Slightly different deployment of User Control files and assemblies ( a .bat file can be used for easy deployment) during development.

 5.     Using Page Viewer Web part:

We can use Page viewer Web part available out of box with SharePoint.

In this approach, the asp.net application runs independent of SharePoint, so we can’t/cannot get current logged in user for SharePoint.

The only way to get currently logged in user is to capture this user in web part and pass it as query string to asp.net page, and parse this query string in aspx pages.

The out of box Web part does not allow us to pass logged in user in query string, for this you need to create a wrapper for page viewer web part. The details can be found at following link.

http://weblogs.asp.net/mnissen/articles/147457.aspx

Pros:   

·         Easier development.

·         Web part can be deployed as a solution package.

·         No need to make any change in existing ASP.NET application.

             Cons:

·         The pages don’t inherit the security and access rules from SharePoint.

·         Asp.Net application runs independent of SharePoint, needs to be hosted on a web server.

Conclusion

The best approach to be used depends upon your requirements. In our experience the best way is to add aspx pages to sharepoint uasing asp.net web application. In this way it can be easily deployed and removed as and when required.

If you like this article, subscribe to our RSS Feed. You can also subscribe via email to our Interview Questions, Codes and Forums section.