..:: LoLoFx ::..: 2009

Ces derniers temps, je me suis penché sur l’intégration des pages/application Asp.NET dans un portail Sharepoint.
En effet, à un certain moment, l’utilisation de webparts pour une application plus poussée devient vite laborieux

Au final, j’ai relevé 3 possibilités :

Une page aspx dans la bibliothèque de pages d’un site
Une page aspx provisionnée dans le site
Une page aspx dans le répertoire LAYOUTS

Les contraintes :

Hérité de la masterpage du site web
Avoir un menu correspondant à mon application
Travailler de façon (presque) classique d’application Asp.Net

Je vais donc présenter les 3 possibilités dans un seul projet. J’utilise les templates WSPBuilder pour gagner du temps.

Etape 1 : Création du projet/solution

Créer un projet de type bibliothèque de classes nommé WebAppInMoss
Utilisation du framework 3.5
Ajouter les références suivantes :

Signer l’assembly (car déploiement dans le GAC)
Préparer l’arborescence du projet

L’arborescence du 12 pour organiser et packager le déploiement
CodeBehind pour le code des pages et classes nécessaires
DeploymentFiles contient les batch de création de la solution et de déploiement (nous ne verrons pas ce dossier dans le détail)
FeatureCode pour les classes nécessaire à l’activation/installation de Features(FeautureReceiver par exemple)

Voilà, notre base est prête, nous pouvons commencer le développement de l’application.

Etape 2 : Application basique dans le LAYOUTS

Créer un dossier appelé WebAppTest dans le dossier LAYOUTS du projet
Créer une page nommé Test.aspx (sans le codeBehind)
Créer un fichier de configuration web.config (ce fichier nous montrera juste que Sharepoint n’est rien d’autre qu’une application asp.Net et donc l’héritage de fichier de config fonctionne)
Ensuite, dans le dossier “Codebehind”, créer un dossier nommé “Pages” dans lequel nous mettrons le codeBehind de nos pages.
Dans ce dossier “Pages”, ajouter une classe nommée : Test.aspx.cs
A la racine du dossier “CodeBehind” , ajouter une classe nommée : BasePage.cs

Le fichier web.config

xml version="1.0" encoding="utf-8" ?>

<configuration>

    <appSettings>

        <add key="monTest" value="value contenu dans appSettings node"/>

    appSettings>

configuration>

Juste pour vérifier que ça fonctionne ;)

Le fichier Test.aspx

<%@ Page Language="C#" MasterPageFile="/_layouts/application.master"

AutoEventWireup="true" CodeBehind="~/CodeBehind/Pages/Test.aspx.cs"

Inherits="WebAppInMoss.Pages.Test,WebAppInMoss, Version=1.0.0.0, Culture=neutral, PublicKeyToken=243730ef052a1703" %>



"Content2"

ContentPlaceHolderId="PlaceHolderPageTitleInTitleArea" runat="server">





"Content1" ContentPlaceHolderId="PlaceHolderMain" runat="server">

    toto

    "server" ID="PContainer">

        

        "lbAddSection" runat="server">Ajoute la section au menu

        "lbRemoveSection" runat="server" >Supprime la section au menu

        

    



Le Inherits de notre page fait référence à notre classe Test (Test.aspx.cs) mais avec son nom fort

Par défaut, dans la propriété MasterPageFile, je mets la masterpage de Sharepoint application.master.

Or, comme nous voulons que notre page ait la même mpasterpage que notre site, la classe BasePage va nous y aider.

Le fichier BasePage.cs

using System;

using System.Collections.Generic;

using System.Text;

using System.Web.UI;

using Microsoft.SharePoint;

using Microsoft.SharePoint.WebControls;



namespace WebAppInMoss

{

    /// 

    /// Classe de base pour les pages contenu dans le dossier layouts

    /// 

    public class BasePage : Page

    {

        protected override void OnPreInit(EventArgs e)

        {



            base.OnPreInit(e);

            ForceWebSiteMP();





        }



        /// 

        /// Forece la masterPage de la page courant avec celle par défaut du website de Sharepoint

        /// 

        private void ForceWebSiteMP()

        {

            using (SPWeb currentWeb = SPControl.GetContextSite(Context).OpenWeb())

            {

                this.MasterPageFile = currentWeb.MasterUrl;

            }

        }

    }

}

Ainsi au PreInit des pages héritant de cette classe, nous lui affecterons l’url du site web courant.

Le fichier Test.aspx.cs

using System;

using System.Collections.Generic;

using System.Text;

using System.Web.UI.WebControls;

using Microsoft.SharePoint;

using Microsoft.SharePoint.WebControls;

using Microsoft.SharePoint.Navigation;

using System.Web;

using System.Web.UI;



namespace WebAppInMoss.Pages

{

    public partial class Test : BasePage

    {

        protected Panel PContainer;

        protected LinkButton lbAddSection;

        protected LinkButton lbRemoveSection;



        protected override void OnLoad(EventArgs e)

        {

            base.OnLoad(e);

            EnsureChildControls();



            TreeView Tree = new TreeView();



            using (SPWeb currentWeb = SPControl.GetContextSite(Context).OpenWeb())

            {

                    SPControl.SetContextWeb(this.Context, currentWeb);

                    SPSiteMapProvider MapProvider =

                      (SPSiteMapProvider)SiteMap.Providers["SPSiteMapProvider"];

                    SiteMapDataSource SiteData =

                      new SiteMapDataSource();

                    SiteData.Provider = MapProvider;

                    Tree.DataSource = SiteData;

                    Tree.DataBind();

                }



            PContainer.Controls.Add(new LiteralControl("Layouts"));

            PContainer.Controls.Add(

                    new LiteralControl(

                           String.Format("Value de monTest (web.config) : {0}",

                                         System.Configuration.ConfigurationManager.AppSettings["monTest"]

                                         )

                                       )

                                    );

            PContainer.Controls.Add(new LiteralControl("
Treeview de la collection de site"));

            PContainer.Controls.Add(Tree);











        }



        protected override void CreateChildControls()

        {

            base.CreateChildControls();



            lbAddSection.Click += new EventHandler(lbAddSection_Click);

            lbRemoveSection.Click += new EventHandler(lbRemoveSection_Click);



        }



        void lbRemoveSection_Click(object sender, EventArgs e)

        {

            MenuQuickLaunch.Menu.RemoveMenu(SPContext.Current.Web);

        }



        void lbAddSection_Click(object sender, EventArgs e)

        {

            MenuQuickLaunch.Menu.CreateMenu(SPContext.Current.Web);

        }

    }

}

Les linkButton ne seront utilisé que plus tard quand nous nous attaquerons à la création d’un menu pour notre application.

L’affichage de la page nous montrera donc :

Les linkButtons
La valeur contenu dans le web.config
Un treeview nous montrant l’arborescence de la collection de site

Cette étape est donc terminée. Cette page est donc utilisable dans toute la collection de site avec l’url relative : _layouts/WebAppTest/Test.aspx

Etape 3 : Le provisionning de pages dans la bibliothèque “Pages” d’un site

Pour ce faire, nous allons créer une feature (nommée WebAppGhostable) qui nous permettra de déployer notre page.

Le scope de celle-ci sera Web

Voici les fichiers à créer

Plus une classe à ajouter dans le répertoire “CodeBehind\Pages” : GhostableInLib.aspx.cs, il s’agit bien évidemment du code-behind de la page.

Ma page GhostableInLib.aspx

<%@ Page Language="C#" MasterPageFile="~masterurl/default.Master"

AutoEventWireup="true" CodeBehind="~/CodeBehind/Pages/GhostableInLib.aspx.cs"

Inherits="WebAppInMoss.Pages.GhostableInLib,WebAppInMoss, Version=1.0.0.0, Culture=neutral, PublicKeyToken=243730ef052a1703"

meta:progid="SharePoint.WebPartPages.Document" %>





<asp:Content ID="Content2"

ContentPlaceHolderId="PlaceHolderPageTitleInTitleArea" runat="server">

asp:Content>



<asp:Content ID="Content1" ContentPlaceHolderId="PlaceHolderMain" runat="server">

    <asp:Panel runat="server" ID="PContainer">asp:Panel>

asp:Content>

Page classique héritant de la classe GhostableInLib.aspx.cs.

La masterpage par défaut est celle du site soit : ~masterurl/default.Master

Le fichier element.xml

xml version="1.0" encoding="utf-8" ?>

<Elements xmlns="http://schemas.microsoft.com/sharepoint/">

    <Module Name="Pages" RootWebOnly="FALSE"

    Url="Pages"

    Path="Pages"

    xmlns="http://schemas.microsoft.com/sharepoint/">

        <File Url="GhostableInLib.aspx" Type="GhostableInLibrary"  >

            <Property Name ="Title" Value="Test GhostableInLibrary"/>

        File>

    Module>

    Elements>

Module :

Name : nom du module
Url : chemin relatif au site courant
Path : chemin relatif au dossier de la Feature

File :

Url : chemin relatif au dossier de la feature concernant le fichier. Il est combiné avec l’attribut path du module
Type : le fichier sera provisionné dans une bibliothèque, ici “Pages”

Le fichier Feature.xml

xml version="1.0" encoding="utf-8"?>

<Feature  Id="d64837bf-9af2-4b25-83c5-152cce2f40be"

          Title="WebAppGhostable - Test"

          Description="Test d'une application asp.net ghoster"

          Version="12.0.0.0"

          Hidden="FALSE"

          Scope="Web"

          DefaultResourceFile="core"xmlns="http://schemas.microsoft.com/sharepoint/">

  <ElementManifests>

    <ElementManifest Location="elements.xml"/>

    <ElementFile Location="Pages\GhostableInLib.aspx"/>

  ElementManifests>

Feature>

La classe GhostableInLib.aspx.cs

using System;

using System.Collections.Generic;

using System.Text;

using System.Web.UI.WebControls;

using Microsoft.SharePoint;

using Microsoft.SharePoint.WebControls;

using Microsoft.SharePoint.Navigation;

using System.Web;

using System.Web.UI;



namespace WebAppInMoss.Pages

{

    public partial class GhostableInLib : Page

    {

        protected Panel PContainer;



        protected override void OnLoad(EventArgs e)

        {

            base.OnLoad(e);







            PContainer.Controls.Add(new LiteralControl("GhostableInLibrary"));

            PContainer.Controls.Add(new LiteralControl("Ceci est la page de type GhostableInLibray"));



            PContainer.Controls.Add(new LiteralControl("
"));

            HyperLink hl = new HyperLink()

            {

                NavigateUrl = "Ghostable.aspx",

                Text = "Lien vers la page de type Ghostable"

            };



            PContainer.Controls.Add(hl);

            PContainer.Controls.Add(new LiteralControl("
"));

            hl = new HyperLink()

            {

                NavigateUrl = String.Format("{0}/_layouts/WebAppTest/Test.aspx",

                                            SPContext.Current.Web.ServerRelativeUrl),

                Text = "Lien vers la page Test du repertoire _layouts"

            };



            PContainer.Controls.Add(hl);



        }



        protected override void CreateChildControls()

        {

            base.CreateChildControls();



        }

    }

}

Cette classe ajoute des liens vers la page créée précédemment dans le layouts ainsi que vers les futures pages que nous allons créer juste après.

Etape 4 : Le provisionning de pages dans le site

Pour cette étape, nous allons créer 2 autres pages en suivant le même fonctionnement que celle de l’étape 3.

L’arborescence sera donc la suivante :

Le fichier elements.xml modifié :

xml version="1.0" encoding="utf-8" ?>

<Elements xmlns="http://schemas.microsoft.com/sharepoint/">

    <Module Name="Pages" RootWebOnly="FALSE"

    Url="Pages"

    Path="Pages"

    xmlns="http://schemas.microsoft.com/sharepoint/">

        <File Url="GhostableInLib.aspx" Type="GhostableInLibrary"  >

            <Property Name ="Title" Value="Test GhostableInLibrary"/>

        File>

        <File Url="Ghostable.aspx"  Type="Ghostable"  >

            <Property Name ="Title" Value="Test Ghostable"/>

        File>

        <File Url="Ghostable2.aspx" Type="Ghostable"  >

            <Property Name ="Title" Value="Test Ghostable 2"/>

        File>

    Module>

    Elements>

Le fichier Feature.xml modifié :

xml version="1.0" encoding="utf-8"?>

<Feature  Id="d64837bf-9af2-4b25-83c5-152cce2f40be"

          Title="WebAppGhostable - Test"

          Description="Test d'une application asp.net ghoster"

          Version="12.0.0.0"

          Hidden="FALSE"

          Scope="Web"

          DefaultResourceFile="core"

          xmlns="http://schemas.microsoft.com/sharepoint/">

  <ElementManifests>

    <ElementManifest Location="elements.xml"/>

    <ElementFile Location="Pages\Ghostable.aspx"/>

    <ElementFile Location="Pages\Ghostable2.aspx"/>

    <ElementFile Location="Pages\GhostableInLib.aspx"/>

  ElementManifests>

Feature>

Les pages aspx Ghostable.aspx et Ghostable2.aspx :

J’ai créé 2 pages pour montrer que l’on peut naviguer de l’une à l’autre simplement.

Les mêmes types de liens se trouvent sur la page GhostableInLib.aspx.

<%@ Page Language="C#" MasterPageFile="~masterurl/default.Master"

AutoEventWireup="true" CodeBehind="~/CodeBehind/Pages/Ghostable.aspx.cs"

Inherits="WebAppInMoss.Pages.Ghostable,WebAppInMoss, Version=1.0.0.0, Culture=neutral, PublicKeyToken=243730ef052a1703"

meta:progid="SharePoint.WebPartPages.Document" %>

<asp:Content ID="Content2"

ContentPlaceHolderId="PlaceHolderPageTitleInTitleArea" runat="server">

asp:Content>

<asp:Content ID="Content1" ContentPlaceHolderId="PlaceHolderMain" runat="server">

    <asp:Panel runat="server" ID="PContainer">asp:Panel>

asp:Content>

----------------------------------------------

<%@ Page Language="C#" MasterPageFile="~masterurl/default.Master"

AutoEventWireup="true" CodeBehind="~/CodeBehind/Pages/Ghostable2.aspx.cs"

Inherits="WebAppInMoss.Pages.Ghostable2,WebAppInMoss, Version=1.0.0.0, Culture=neutral, PublicKeyToken=243730ef052a1703"

meta:progid="SharePoint.WebPartPages.Document" %>

<asp:Content ID="Content2"

ContentPlaceHolderId="PlaceHolderPageTitleInTitleArea" runat="server">

asp:Content>

<asp:Content ID="Content1" ContentPlaceHolderId="PlaceHolderMain" runat="server">

    <asp:Panel runat="server" ID="PContainer">asp:Panel>

asp:Content>

Le code-behind de ces pages :

Ghostable.aspx.cs

using System;

using System.Collections.Generic;

using System.Text;

using System.Web.UI.WebControls;

using Microsoft.SharePoint;

using Microsoft.SharePoint.WebControls;

using Microsoft.SharePoint.Navigation;

using System.Web;

using System.Web.UI;

namespace WebAppInMoss.Pages

{

    public partial class Ghostable : Page

    {

        protected Panel PContainer;

        protected override void OnLoad(EventArgs e)

        {

            base.OnLoad(e);

            TreeView Tree = new TreeView();

            PContainer.Controls.Add(new LiteralControl("Ghostable"));

            PContainer.Controls.Add(new LiteralControl("Ceci est la page de type Ghostable"));

            PContainer.Controls.Add(new LiteralControl("
"));

            HyperLink hl = new HyperLink()

            {

                NavigateUrl = "GhostableInLib.aspx",

                Text = "Lien vers la page de type GhostableInLibrary"

            };

            PContainer.Controls.Add(hl);

            PContainer.Controls.Add(new LiteralControl("
"));

            hl = new HyperLink()

            {

                NavigateUrl = "Ghostable2.aspx",

                Text = "Lien vers la page 2 de type Ghostable (elle n'apparait pas dans le menu)"

            };

            PContainer.Controls.Add(hl);

            PContainer.Controls.Add(new LiteralControl("
"));

            hl = new HyperLink()

            {

                NavigateUrl = String.Format("{0}/_layouts/WebAppTest/Test.aspx",

                                            SPContext.Current.Web.ServerRelativeUrl),

                Text = "Lien vers la page Test du repertoire _layouts"

            };

        }

        protected override void CreateChildControls()

        {

            base.CreateChildControls();

        }

    }

}

Ghostabe2.aspx.cs

using System;

using System.Collections.Generic;

using System.Text;

using System.Web.UI.WebControls;

using Microsoft.SharePoint;

using Microsoft.SharePoint.WebControls;

using Microsoft.SharePoint.Navigation;

using System.Web;

using System.Web.UI;

namespace WebAppInMoss.Pages

{

    public partial class Ghostable2 : Page

    {

        protected Panel PContainer;

        protected override void OnLoad(EventArgs e)

        {

            base.OnLoad(e);

            TreeView Tree = new TreeView();

            PContainer.Controls.Add(new LiteralControl("Ghostable"));

            PContainer.Controls.Add(new LiteralControl("Ceci est la page de type Ghostable"));

            PContainer.Controls.Add(new LiteralControl("
"));

            HyperLink hl = new HyperLink()

            {

                NavigateUrl = "GhostableInLib.aspx",

                Text = "Lien vers la page de type GhostableInLibrary"

            };

            PContainer.Controls.Add(hl);

            PContainer.Controls.Add(new LiteralControl("
"));

            hl = new HyperLink()

            {

                NavigateUrl = "Ghostable.aspx",

                Text = "Lien vers la page 1 de type Ghostable"

            };

            PContainer.Controls.Add(hl);

            PContainer.Controls.Add(new LiteralControl("
"));

            hl = new HyperLink()

            {

                NavigateUrl = String.Format("{0}/_layouts/WebAppTest/Test.aspx",

                                            SPContext.Current.Web.ServerRelativeUrl),

                Text = "Lien vers la page Test du repertoire _layouts"

            };

        }

        protected override void CreateChildControls()

        {

            base.CreateChildControls();

        }

    }

}

Après déploiement les pages sont ghoster dans le site mais contrairement à l’étape 3, elles n’apparaissent pas dans la navigation.

Nous avons donc besoin d’un menu et c’est ce que nous verrons à l’étape 5.

Etape 5 : Création d’un menu à l’activation de la feature

J’ai donc décidier de créer un menu au moment de l’activation de la feature, pour ce faire, je vais donc ajouter un featureReceiver.

Dans le dossier FeatureCode, ajouter une classe nommée : WebAppGhostable.cs (en fait le nom de ma feature pour faire simple).

Voici le code :

using System;

using System.Collections.Generic;

using System.Text;

using Microsoft.SharePoint;

using Microsoft.SharePoint.Navigation;

using WebAppInMoss.MenuQuickLaunch;

namespace WebAppInMoss

{

    class WebAppGhostable : SPFeatureReceiver

    {

        public override void FeatureActivated(SPFeatureReceiverProperties properties)

        {

            SPWeb web = properties.Feature.Parent as SPWeb;

            //Instancie le menu de l'application de test

            Menu.CreateMenu(web);

        }

        public override void FeatureDeactivating(SPFeatureReceiverProperties properties)

        {

            SPWeb web = properties.Feature.Parent as SPWeb;

            Menu.RemoveMenu(web);

        }

        public override void FeatureInstalled(SPFeatureReceiverProperties properties)

        {

            throw new Exception("The method or operation is not implemented.");

        }

        public override void FeatureUninstalling(SPFeatureReceiverProperties properties)

        {

            throw new Exception("The method or operation is not implemented.");

        }

    }

}

NB : Les ligne concernant la création et la suppression du menu seront vu dans quelques lignes.

Voici le fichier Feature.xml modifié pour le receiver :

xml version="1.0" encoding="utf-8"?>

<Feature  Id="d64837bf-9af2-4b25-83c5-152cce2f40be"

          Title="WebAppGhostable - Test"

          Description="Test d'une application asp.net ghoster"

          Version="12.0.0.0"

          Hidden="FALSE"

          Scope="Web"

          DefaultResourceFile="core"

          ReceiverAssembly="WebAppInMoss, Version=1.0.0.0, Culture=neutral, PublicKeyToken=243730ef052a1703"

          ReceiverClass="WebAppInMoss.WebAppGhostable"

          xmlns="http://schemas.microsoft.com/sharepoint/">

  <ElementManifests>

    <ElementManifest Location="elements.xml"/>

    <ElementFile Location="Pages\Ghostable.aspx"/>

    <ElementFile Location="Pages\Ghostable2.aspx"/>

    <ElementFile Location="Pages\GhostableInLib.aspx"/>

  ElementManifests>

Feature>

Maintenant, il ne reste plus qu’a générer un pseudo menu.

Voici les fichier à créer :

Et le contenu de ce menu :

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using Microsoft.SharePoint;

using Microsoft.SharePoint.Navigation;

using System.Web;

namespace WebAppInMoss.MenuQuickLaunch

{

    /// 

    /// Menu de l'application de test

    /// 

    public class Menu

    {

        private Menu() { }

        /// 

        /// Creer le menu de l'application

        /// 

        /// 

        public static void CreateMenu(SPWeb web)

        {

            if (web == null)

                throw new SPException("Erreur de récupération de la référence du website pendant l'activation de la feature");

            bool AllowUnSafeUpdates = web.AllowUnsafeUpdates;

            try

            {

                web.AllowUnsafeUpdates = true;

                //Menu du haut

                SPNavigationNodeCollection topNavigation = web.Navigation.TopNavigationBar;

                //menu de gauche

                SPNavigationNodeCollection quickLaunchNavigation = web.Navigation.QuickLaunch;

                //Creer les noeuds pour le menu

                SPNavigationNode sectionNode = new SPNavigationNode("Section", "Pages/Ghostable.aspx",false);

                // ajoute la section à la fin de la topNavBar

                topNavigation.AddAsLast(sectionNode);

                //ajoute la section au debut de QuickLaunch

                quickLaunchNavigation.AddAsFirst(sectionNode);

                SPNavigationNode ghostableNode = new SPNavigationNode("Test Ghostable", "Pages/Ghostable.aspx", false);

                SPNavigationNode layoutsNode = new SPNavigationNode("Test Layouts",

                                                        String.Format("{0}/_layouts/WebAppTest/Test.aspx",web.Url),

                                                        true);

                sectionNode.Children.AddAsLast(layoutsNode);

                sectionNode.Children.AddAsLast(ghostableNode);

                //sectionNode.Children.Add(layoutsNode,ghostableNode);

                web.Update();

            }

            catch (SPException ex)

            {

                throw;

            }

            finally

            {

                //on le remet à sa valeur initiale avant qu'on ne travaille dessus

                web.AllowUnsafeUpdates = AllowUnSafeUpdates;

            }

        }

        public static void RemoveMenu(SPWeb web)

        {

            if (web == null)

                throw new SPException("Erreur de récupération de la référence du website pendant l'activation de la feature");

            bool AllowUnSafeUpdates = web.AllowUnsafeUpdates;

            try

            {

                web.AllowUnsafeUpdates = true;

                //Menu du haut

                SPNavigationNodeCollection topNavigation = web.Navigation.TopNavigationBar;

                //menu de gauche

                SPNavigationNodeCollection quickLaunchNavigation = web.Navigation.QuickLaunch;

                //Supprime les noeuds créés du menu

                if(quickLaunchNavigation.Count>0)

                {

                    quickLaunchNavigation.Cast()

                                                     .Where(c => c.Title == "Section")

                                                     .FirstOrDefault()

                                                     .Delete();

                }

                if (topNavigation.Count > 0)

                {

                    topNavigation.Cast()

                                                     .Where(c => c.Title == "Section")

                                                     .FirstOrDefault()

                                                     .Delete();

                }

                web.Update();

            }

            catch (SPException ex)

            {

                throw;

            }

            finally

            {

                //on le remet à sa valeur initiale avant qu'on ne travaille dessus

                web.AllowUnsafeUpdates = AllowUnSafeUpdates;

            }

        }

    }

}

Il va donc ajouter, au moment de l’activation de lafeature, à la racine du menu du site web Sharepoint ,les liens vers le Ghostable.aspx et vers Test.aspx (page dans le LAYOUTS)

Et les supprimer à la désactivation.

Voici l’arborescence complète du projet :