TemplateInstanceAttribute dans les custom WebControl sur un ITemplate
Lorsque l'on créé des Custom Control avec un système de Template, il se peut que parfois on ne répète pas notre template. Par défaut un template étant répétable, ASP.net ne déclare pas de variable au niveau de la page, il n'est donc pas accessible dans le code behind.
Par exemple :
<test:testtemplate runat="server" id="tt">
<MyTemplate>
<asp:label id="lblTest" runat="server" Text="Coucou du template" />
</MyTemplate>
</test:testtemplate>
Dans le code behind, lblTest n'est pas directement accessible puisqu'il peut être répèté. Mais dans certains cas, on sait que le Template ne sera pas repeté, il est donc intéressant que les contrôles du template soit accessible dans le code behind. C'est l'attribut TemplateInstanceAttribute qui permet ça :
<TemplateInstance(TemplateInstance.Single)> _
<PersistenceMode(PersistenceMode.InnerProperty)> _
Public Property MyTemplate() As ITemplate
A quoi est-ce utile ? On pourrait penser qu'un Template qui ne se répète pas est inutile, qu'il est plus simple d'utiliser l'attribut PersistChildren qui indique au parseur ASP.net de parser le contenu du contrôle comme étant ses enfants. cet attribut est utile si vous avez des propriétés complexes que vous avez décoré avec l'attribut PersistenceMode, les propriétés portant cet attribut peuvent être définit dans le contenu du contrôle.
Le contrôle UpdatePanel est un exemple typique de ce scénario, sa propriété ContentTemplate est décorée de l'attribut TemplateInstance, les propriétés ContentTemplate et Triggers possèdent l'attribut PersistenceMode :
[ParseChildren(true)]
[PersistChildren(false)]
public class UpdatePanel : Control
{
[PersistenceMode(PersistenceMode.InnerProperty)]
public UpdatePanelTriggerCollection Triggers { get; }
[TemplateInstance(TemplateInstance.Single)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public ITemplate ContentTemplate { get; set; }
}
C'est pour ça que lorsque nous utilisons le code ci-dessous, lblTest est accessible au niveau du code behind
<asp:UpdatePanel runat="server" UpdateMode="Conditional">
<ContentTemplate>
<asp:Label ID="lblTest" runat="server" />
</ContentTemplate>
<Triggers>
<asp:AsyncPostBackTrigger ControlID="btnTest" />
</Triggers>
</asp:UpdatePanel>
Si vous utilisez cet attribut, attention à bien faire le InstantiateIn relativement tôt pour qu'il soit accessible dans les événements load, init & co de la page. Je vous conseille de faire le InstantiateIn dans le CreateChildControls et d'appeler la méthode EnsureChildControls() au niveau de l'événement init du contrôle.
Pour en savoir plus sur les ITemplate et comment cela fonctionne au niveau de la compilation : Explication de l'interface ITemplate pendant la compilation ASP.net