Blog de Philippe Vialatte

16
janvier
2009

[Sharepoint] Création de web parts avec l’API de Sharepoint

Un article de Philippe Vialatte Comments

Question a 5 centimes, que se passe t’il quand, pour des sites Sharepoint déjà déployés, un client demande a ce que des web parts soient ajoutées sur n sites déjà existants ?

Réponse : c’est pas grave, on utilise l’API de Sharepoint pour ouvrir les n pages des n sites et ajouter une web part…

Oui, mais comment faire ?

Déjà, un peu d’explications:

Dans un site Sharepoint , on a des WebPartPages, qui contiennent un gestionnaire de web part. Ce WebPartManager contient toutes les informations nécessaires pour créer, supprimer ou récupérer les web parts se trouvant sur la page.

Avec Sharepoint v3, ce gestionnaire de web part porte le doux nom de SPLimitedWebPartManager.

Récupérer le SPLimitedWebPartManager d’une page Sharepoint est assez simple, il suffit d’appeler la méthode GetLimitedWebPartManager de notre page. Pour le récupérer, on a deux possibilités, la première étant de demander au site web le manager pour une page donnée, la seconde, de demander a la page web en elle-même son manager.

On aura donc, soit :

web.GetLimitedWebPartManager(« default.aspx », PersonalizationScope.Shared)

soit:

file.GetLimitedWebPartManager(PersonalizationScope.Shared)

Le scope permets de choisir soit les web part partagées, soit les web part personnelles.

Une fois que ce SPLimitedWebPartManager est récupéré, on peut créer notre nouvelle web part.

Pour une web part Sharepoint standard, c’est assez simple, il suffit de faire un new, et de la configurer.
Pour mon problème personnel, les web parts en questions étaient des web part de type Content Editor et Page Viewer.

Configurer un page viewer est très simple, vu que la seule chose dont cette web part a besoin pour fonctionner, c’est l’url d’une autre page.

PageViewerWebPart webpart = new PageViewerWebPart();

webpart.ContentLink = pageToView;
webpart.Title = title;

Le Content Editor est a peine plus complique. En effet, il demande comme contenu un XMLDocument. Pour le configurer, on va donc faire:

ContentEditorWebPart webpart = new ContentEditorWebPart();

XmlElement xlElem = new XmlDocument().CreateElement(« MyElement »);
xlElem.InnerText = content;

webpart.Content = xlElem;
webpart.Title = title;

Une fois les web part configurées, il ne nous restera plus qu’a les ajouter a notre SPLimitedWebPartManager, en spécifiant l’Id de la zone dans laquelle on veut les ajouter.

limitedWebPartManager.AddWebPart(webpart, _zoneID, 0);

_zoneId, ici, doit être une chaine de caractères. Mieux vaut connaitre l’id de la zone avant, car je n’ai pour l’instant pas trouve de moyen de trouver les zone Id valides sur la page.

Maintenant, on mets tout dans le shaker, on secoue très fort, et on sort une classe qui ressemble a ca:

public class WebPartManager {

private SPLimitedWebPartManager _limitedWebPartManager;
private string _zoneID;

    public WebPartManager(SPWeb web, string pageUrl, string zoneId) {
        _zoneID = zoneId;
        System.Web.UI.WebControls.WebParts.PersonalizationScope scope;
        scope = System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared;

_limitedWebPartManager = web.GetFile(web.Url + pageUrl).GetLimitedWebPartManager(scope);
}

public void CreatePageViewerWebPart(string title, string pageToView) {

PageViewerWebPart webpart = new PageViewerWebPart();

webpart.ContentLink = pageToView;
webpart.Title = title;

_limitedWebPartManager.AddWebPart(webpart, _zoneID, 0);
}

public void CreateContentEditorWebPart(string title, string content) {

ContentEditorWebPart webpart = new ContentEditorWebPart();

XmlElement xlElem = new XmlDocument().CreateElement(« MyElement »);
xlElem.InnerText = content;

webpart.Content = xlElem;
webpart.Title = title;

_limitedWebPartManager.AddWebPart(webpart, _zoneID, 0);
}
}

Et qui s’utilise comme ca:

new WebPartManager(web, « /Pages/Page1.aspx », « FullPage »)
.CreatePageViewerWebPart(« Users », « http://localhost/Users.aspx »);

string content = « juste un test« ;

new WebPartManager(web, « /Pages/Page2.aspx », « Left »)
.CreateContentEditorWebPart(« Test », content);

Identifiez-vous

Créer un compte

Blog de Philippe Vialatte

Laisser un commentaire

Articles récents

Archives

Commentaires récents

Catégories

Méta

Identifiant
Mot de passe

Mot de passe oublié ?