Ein WebMatrix Helfer für dotnet-kicks.de
Die kleinen Helferlein die in WebMatrix vorhanden sind, sorgen für die Integration E-Mail, Twitter Anzeige oder auch den Datenzugriff. Was ein WebMatrix Helper ist? Die folgende Zeile
@Twitter.Profile(“writeline”)
erstellt das notwendige HTML um die letzten 5 Tweets meines Twitter Accounts als HTML zu rendern und in die Stelle zu integrieren an der ich den Helper benutze. Das Ergebnis sieht dann so aus:

So ein Helfer kann auch selbst geschrieben werden. Doch wo findet man die Dokumentation dazu? Genau das ist das Problem. Meines Wissens gibt es noch keine offizielle, im Web findet man jedoch Einträge von Bloggern die in der Richtung schon experimentiert haben.
Am einfachsten ist es sich den Reflector zu schnappen und die bestehenden Helfer mal zu dekompilieren.
Das Grundprinzip
Ein Helfer ist einfach eine statische Klasse die über eine statische Methode verfügt. Der Rückgabewert der Methode ist ein String und wird beim ausführen mit gerendered.
Beispiel: Die statische Klasse MeinBlog mit der statischen Methode string MeinProfil(string name) lässt sich aus der Razor View Engine entsprechend mit @MeinBlog.MeinProfile(“Dariusz Parys”) aufrufen. Der Rückgabewert wird einfach in den Generierungsprozess der View Engine eingefügt.
Um ein besseres Beispiel für einen Helper zu haben, schreibe ich einen für die Seite http://dotnet-kicks.de. Diese Seite ist ein Bookmarking Portal und jeder Beitrag der dort aufgelistet werden möchte kann es dem Leser mit Hilfe eines Buttons einfacher machen. Wie auch am Ende dieses Blogposts.
Funktionalität und Distribution
Bevor wir zur Implementierung kommen, erst einmal die Überlegung wie der Helper in WebMatrix genutzt werden sollte. Ich habe mich hier an bestehenden Helpern orientiert. Rendern die Helper einfach HTML benutzen diese meist die Methode GetHtml um dieses zu rendern. Für diesen Namen habe ich mich jetzt auch entschieden.
Des Weiteren möchte ich einen optionalen Parameter haben der es mir erlaubt den Permalink zu beeinflußen. Wird dieser nicht angegeben, wird der aktuelle Serverpfad der Seite verwendet.
Die Benutzung aus Razor heraus sieht nun folgendermaßen aus:
@DotnetKicks.GetHtml()
oder
@DotnetKicks.GetHtml(“http://downtocode.net/posts/meinartikel”)
Nachdem ich nun festgelegt habe wie der Helper vom Webentwickler verwendet wird, kommt die zweite Frage, die Distribution. Zum einen kann man den Helper in ein Assembly packen und dieses dann entsprechend aus der CSHTML Datei mittels @using namespace… verwenden, doch ich finde eine Source-Distribution im App_Code Verzeichnis von Vorteil. Erstens kann jeder sich das kurz in seine eigene Anwendung rein kopieren, zweitens können schnell Änderungen vorgenommen werden.
Das heißt die Klasse wird mit im App_Code Verzeichnis abgelegt und ist in der WebMatrix Seite verfügbar.

Was fehlt ist nur noch der Code.
Die Implementierung
Der folgende Code kann einfach per Copy & Paste in ein eigenes WebMatrix Projekt im Verzeichnis App_Code eingebunden werden. Wenn das Verzeichnis noch nicht existiert einfach eines anlegen.
using System;
using System.Text;
using System.Web;
public static class DotnetKicks
{
public static IHtmlString GetHtml
(string url = null)
{
string html = GeneratedCode(url);
return new HtmlString(html);
}
private static string GeneratedCode(string url = null)
{
if( string.IsNullOrEmpty(url) )
{
url = HttpContext.Current.Request.Url.GetComponents(UriComponents.Path | UriComponents.SchemeAndServer, UriFormat.Unescaped);
}
StringBuilder builder = new StringBuilder();
builder.Append("<div style=\"text-align: left; padding-top: 4px; padding-right: 4px; padding-bottom: 4px; padding-left: 4px; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px;\" sizcache=\"10\" sizset=\"138\">");
builder.AppendLine(string.Format("<A href=\"http://dotnet-kicks.de/kick/?url={0}\"><IMG border=0 alt=\"DotNetKicks-DE Image\" src=\"http://dotnet-kicks.de/Services/Images/KickItImageGenerator.ashx?url={0}&bgcolor=3169AD&fgcolor=FFFFFF&border=000000&cbgcolor=D4E1ED&cfgcolor=000000\"></A>", url));
builder.AppendLine("</div>");
return builder.ToString();
}
}
Und sogleich kann man dann entsprechend den Helper benutzen.
@DotnetKicks.GetHtml()
erzeugt den Bekannten Button.
WebMatrix lebt von Helfern
Sprichwörtlich lebt WebMatrix von Helper Klassen. Die verschiedenen Tutorials unter http://www.asp.net/webmatrix zeigen in einzelnen die Einsatzmöglichkeiten der bestehenden Hilfsklassen. Doch so richtig zum Fliegen wird WebMatrix erst kommen wenn es viele solcher Helfer in Form von Sourcecode auf Webseiten zum kopieren gibt. Würde mich freuen über den ein oder anderen Helper in der Zukunft zu lesen.