Déploiement de contrôles web personnalisés pour SharePoint

Créer un nouveau projet de type Class Library et ajoutez y le code suivant.

using System;
using System.Collections.Generic;
using System.Text;
using System.Web.UI;
using System.Web.UI.WebControls;
using Microsoft.SharePoint;
namespace Coforcert.SharePoint.Controls.CustomControls {
    public class SiteLists : WebControl {
        public override void RenderControl(HtmlTextWriter writer) {
            SPWeb currentWeb = SPContext.Current.Web;
            writer.Write("<-- Listes du Site --><br/>");
            foreach (SPList list in currentWeb.Lists) 
                writer.Write(string.Format("Liste : {0}<br/>Modèle de Base : {1}<br/>Description : {2}<br/><br/>", list.Title, 
					list.BaseType.ToString(), list.Description));
			}
		}
	}

Ce code va nous permettre de récupérer toutes les listes du site ou le contrôle sera déployé.

Ensuite, compilez votre assembly et ajouter la, soit dans le GAC (nécessite de signer l'assembly), soit dans le répertoire bin de votre application web.

Afin de pouvoir utiliser vos contrôles comme vous le faites avec vos webparts, il va falloir les marquer comme sur.

Pour cela, ouvrez le web.config de l'application concerné, qui se situe par défaut dans le répertoire « C:\Inetpub\wwwroot\wss\VirtualDirectories\n°dePort », et ajoutez-y la ligne suivante, sous réserve que vous ayez utilisé le même namespace et que votre assembly s'appelle CustomControl.dll. A défaut, remplacez par vos valeurs.

<SafeControls>
< !-- Les autres Safe Control sont déjà présents -->
  <SafeControl Assembly="CustomControl" Namespace="Coforcert.SharePoint.Controls.CustomControls" TypeName="*" Safe="True"/>
</SafeControls>

Une fois le contrôle déployé, il suffit maintenant de l'intégrer au sein d'une page quelconque, ou alors dans toutes les pages via les master pages.

Dans notre cas, nous allons le déployer au sein d'une seule page.

Pour cela, nous allons utiliser SharePoint Designer, pour éditer cette page.

Une fois la page ouverte, il nous suffit de déclarer notre contrôle dans l'une des zones de contenu à notre disposition.

Dans notre exemple, nous déployons notre contrôle dans le PlaceHolderMain.

<%@ Page Language="C#" masterpagefile="~masterurl/default.master" 
			title="Page de Test des Composants" inherits="Microsoft.SharePoint.WebPartPages.WebPartPage, 
		Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" 
			meta:webpartpageexpansion="full" meta:progid="SharePoint.WebPartPage.Document" %>
<%@ Register Assembly="CustomControl" Namespace="Coforcert.SharePoint.Controls.CustomControls" TagPrefix="MySPControls" %>
<asp:Content id="Content1" runat="server" contentplaceholderid="PlaceHolderMain">
  <MySPControls:SiteLists id="sl01" runat="server"/>
</asp:Content>

Et voici le résultat.

Comme vous avez pu le constater, il est extrêmement facile de créer des pages en y déployant des contrôles entièrement custom.

Nous allons à présent voir le 2^ème type de contrôle asp.net, les user controls.

Cette étape va se dérouler en 2 phases.

Durant la 1^ère phase, nous allons créer visuellement notre contrôle.

Pour cela, ajoutez à l'interface 2 labels, 2 textbox et 1 bouton ; configurer l'une des textbox pour un affichage multiligne.

Vous devriez obtenir un rendu comme ci-dessous.

Une fois cette étape réalisé, nous allons passer en affichage html, afin de rajouter le code exécuté lors du click sur le bouton.

Nous allons également importer la dll Microsoft.SharePoint.dll et le namespace using Microsoft.SharePoint, étant donné que nous allons utiliser le modèle objet de SharePoint.

Voici le code html de notre contrôle.

<%@ Control Language="C#" %>
<%@ Assembly Name="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Import Namespace="Microsoft.SharePoint" %>

<script runat="server">
    protected void Button1_Click(object sender, EventArgs e)
    {
        SPContext.Current.Web.Lists.Add(this.TextBox1.Text, this.TextBox2.Text, SPListTemplateType.DocumentLibrary);
    }
</script>

<asp:Label ID="Label1" runat="server" Text="Label">Nom : </asp:Label>
<asp:TextBox ID="TextBox1" runat="server"></asp:TextBox><br />
<asp:Label ID="Label2" runat="server" Text="Label">Description : </asp:Label>
<asp:TextBox ID="TextBox2" runat="server" TextMode="MultiLine"></asp:TextBox><br />
<asp:Button ID="Button1" runat="server" Text="Ajouter" 
    onclick="Button1_Click" />

Ceci étant fait, nous allons à présent déployer notre contrôle.

Le code de notre contrôle étant embarqué dans notre fichier ascx, nous n'avons pas d'assembly à déployer dans le GAC ou dans le bin.

Pour déployer notre contrôle, il nous suffit de copier le fichier .ascx dans un répertoire prévu à l'effet, le répertoire ControlTemplates : « C:\Program Files\Fichiers communs\Microsoft Shared\web server extensions\12\TEMPLATE\CONTROLTEMPLATES ».

Ceci étant fait, passons à l'étape suivante.

L'étape suivante devrait donc être l'enregistrement de notre contrôle comme sur dans le web.config ; cependant, comme je vous l'ai dit précédemment, le répertoire ControlTemplate est prévu à cet effet, à tel point qu'il est déjà marqué comme sur dans le web.config.

Si vous ouvrez le fichier web.config, vous y trouverez la ligne

<SafeControl Src="~/_controltemplates/*" IncludeSubFolders="True" Safe="True" AllowRemoteDesigner="True" />

_controltemplates correspond au répertoire virtuel qui est mappé sur le répertoire physique ControlTemplate. Donc cette ligne approuve tous les ascx stockés dans les sous répertoires de ce dossiers.

Nous allons à nouveau éditer une page avec SharePoint Designer afin d'intégrer notre contrôle dans une page SharePoint.

Une fois la page .aspx ouverte avec SD, il nous suffit de rajouter les lignes ci-dessous pour intégrer notre contrôle dans la zone de contenu PlaceHolderLeftNavBartTop.

<%@ Page Language="C#" masterpagefile="~masterurl/default.master" 
			title="Page de Test des Composants" inherits="Microsoft.SharePoint.WebPartPages.WebPartPage,
		 Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" 
		 	meta:webpartpageexpansion="full" meta:progid="SharePoint.WebPartPage.Document" %>
<%@ Register TagPrefix="MySPControls" TagName="AddDocLib" src="~/_controltemplates/AddDocLib.ascx" %>
<asp:Content id="Content2" runat="server" contentplaceholderid="PlaceHolderLeftNavBarTop">
<MySPControls:AddDocLib id="adl01" runat="server"/>
</asp:Content>

Et voici le résultat.