sabato 19 settembre 2009

ASP.NET : Tag Mapping

Forse non tutti sanno che in ASP.NET è possibile letteralmente “rimappare” i tag ASPX (ovvero i controlli che mettiamo nelle pagine) verso delle nostre classi che ridefiniscono il comportamento dei controlli originali.

Tanto per fare un esempio, supponiamo che non sia di nostro gradimento il modo con cui viene renderizzato il controllo <asp:Label> (ovvero con il tag <span> HTML).

Per fare in modo che il controllo Label si comporti in maniera differente rispetto al comportamento standard, potremmo creare un controllo, magari derivato dalla classe Label, che ridefinisca il modo con cui viene “scritto” sullo stream HTML diretto al client. In pratica ridefinendo il metodo Render().

A questo punto, però, dovremmo sostituire tutti i controlli del nostro sito con il nuovo controllo e, la cosa, non sempre è possibile.

In maniera più semplice e relativamente indolore possiamo adoperare la tecnica del Tag Mapping.

In sostanza, definiamo all’interno del web.config la sezione <tagMapping> (nella sezione <pages>) in cui specifichiamo quale classe deve essere utilizzata dal framework al posto della comune Label.

Per fare un esempio, supponiamo di aver realizzato la classe DivLabel che renderizza una Label come un <div> HTML.

Public Class DivLabel
    Inherits Label

    Protected Overrides Sub Render(ByVal writer As System.Web.UI.HtmlTextWriter)
        With writer
            .WriteBeginTag("div")
            .Write(" id=""" + Me.UniqueID + """")
            .Write(">")
            .Write(Me.Text)
            .WriteEndTag("div")
        End With
    End Sub
End Class

Nella precedente classe ho, per semplicità, tralasciato il render relativo alle proprietà della Label e degli eventuali attributi della stessa (ad esempio quelli di stile).

Supponiamo di avere la seguente pagina ASPX:

<%@ Page Language="VB" AutoEventWireup="false" CodeFile="Label.aspx.vb" Inherits="Label" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="
http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <asp:Label ID="myLabel" runat="server" Text="Label"></asp:Label>
    </form>
</body>
</html>

Questa viene, normalmente, trasformata nella seguente pagina HTML:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>
    </title>
</head>
<body>
    <form name="form1" method="post" action="Label.aspx" id="form1">
        <div>
            <input type="hidden" name="__VIEWSTATE" id="__VIEWSTATE" value="/wEPDwUJOTczNTMyNjI5ZGTKpn/ljpIej9oH+QYRJuImecM++g==" />
        </div>
        <span id="myLabel">Label</span>
    </form>
</body>
</html>

Dove la label myLabel diventa uno <span>.

Per far si che il framework utilizzi la nostra classe DivLabel al posto della Label di sistema, basta inserire la seguente sezione nel file di configurazione web.config:

<pages>
    .
    .
    <tagMapping>
        <add tagType="System.Web.UI.WebControls.Label" mappedTagType="DivLabel" />
    </tagMapping>
    .
    .
</pages>

Aggiunta questa sezione, la precedente pagina viene renderizzata nel seguente modo:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <title>
        </title>
    </head>
<body>
    <form name="form1" method="post" action="Label.aspx" id="form1">
        <div>
            <input type="hidden" name="__VIEWSTATE" id="__VIEWSTATE" value="/wEPDwUKMTYwMzIyMDQ0NWRknusqxujji7odF/YNcMp+fJItZcE=" />
        </div>
        <div id="myLabel">Label</div>
    </form>
</body>
</html>

Il framework, dunque, richiama effettivamente la nostra classe DivLabel al posto della Label nel momento in cui deve interpretare il tag <asp:Label>.

In questo modo la label standard è sostituita con la nostra label e, questo, potenzialmente, senza cambiare le pagine già esistenti.

Questa tecnica è da utilizzare ogni qual volta l’implementazione del render di un controllo del framework non ci soddisfa.

 

Nessun commento: