ASP.NET MVC est un outil puissant pour créer des sites web, basés sur des conventions (Conventions over configurations). Nous allons voir dans cet article les notions de display et editor templates qui permettent la gestion du rendu d’un objet/propriété en mode affichage et édition.
Utilisation
ASP.NET MVC fournit par défaut des méthodes dans le helper Html permettant la gestion de l’affichage (DisplayFor) et l’édition (EditorFor).
@Html.DisplayFor(model => model.Title)
@Html.EditorFor(model => model.Title, new { htmlAttributes = new { @class = "form-control" } })
Par défaut, le helper générera un input en fonction du type des propriétés de votre objet. Ainsi, dans le cas d’une propriété de type string, un input de type text sera généré et dans le cas d’un bool, une case à cocher. Il est possible d’avoir un contrôle plus fin de la génération des input. Pour cela, le helper HTML met à disposition des méthodes pour chaque type de input :
- Html.TextBox
- Html.DropDownList
- …
Cela est très pratique et permet de mieux contrôler le HTML généré mais vous êtes obligé de le faire dans chaque vue. Afin de palier à ce problème, il existe les DisplayTemplates et EditorTemplates. Ils permettent de définir pour chaque type comment il sera rendu en mode affichage (display) ou édition (editor). Pour cela, il faut créer des dossiers DisplayTemplates et EditorTemplates dans le dossier Views/Shared puis placer un fichier par type en le nommant type.cshtml.
Dans les exemples suivant, nous allons utiliser une classe Album (les annotations de validations sont volontairement omises) :
public class Album
{
public int ID { get; set; }
public string Title { get; set; }
public DateTime ReleaseDate { get; set; }
public bool isDoubleDisc { get; set; }
}
Par exemple, pour surcharger le template utilisé pour les types DateTime et bool, on créera respectivement un fichier DateTime.cshtml et Boolean.cshtml.
Nous avons vu que les booléens sont affichés sous la forme de checkbox. Voyons comment rendre votre application un peu plus jolie avec des composants ayant un meilleur rendu.
J’ai parlé dans un article précédent des web components et de polymer.
Polymer fournit une bibliothèque de composant (elements dans le jargon Polymer) prêt à l’emploi, notamment les Paper Elements, composant graphiques Material Design.
Voyons comment utiliser des paper-checkbox (la page de démo) pour les booléens grâce aux display templates.
Afin d’utiliser polymer et les elements, il faut les ajouter à la solution. Voici la documentation de polymer permettant de le faire.
Ajoutons un fichier Boolean.cshtml dans le dossier Views/Shared/DisplayTemplates :
@model System.Boolean
@if(@Model) {
<paper-checkbox disabled checked></paper-checkbox>
} else {
<paper-checkbox disabled></paper-checkbox>
}
L’affichage utilise maintenant un élement paper-checkbox pour les booléens.
Vous avez peut être remarqué que Polymer propose également un élément paper-toggle-button qui convient également pour les booléens.
ASP.NET MVC contient un attribut UIHint qui permet de spécifier un template à appliquer pour une propriété.
Ajoutons l’attribut UIHint avec la valeur Toggle sur la propriété IsDoubleDisc.
[UIHint("Toggle")]
public bool IsDoubleDisc { get; set; }
Définissons maintenant un fichier Toggle.cshtml dans le dossier DisplayTemplates avec le code suivant :
@model System.Boolean
@if(@Model) {
<paper-toggle-button disabled checked></paper-toggle-button>
} else {
<paper-toggle-button disabled></paper-toggle-button>
}
Automatiquement, le champs IsDoubleDisc sera affiché avec un toggle !
Il est également possible de créer des templates pour vos propres modèles.
Voici un exemple avec une classe Address :
@model DemoMVC5.Models.Address
<dl class="dl-horizontal">
<dt>
@Html.DisplayNameFor(model => model.Street)
</dt>
<dd>
@Html.DisplayFor(model => model.Street)
</dd>
<dt>
@Html.DisplayNameFor(model => model.ZipCode)
</dt>
<dd>
@Html.DisplayFor(model => model.ZipCode)
</dd>
<dt>
@Html.DisplayNameFor(model => model.City)
</dt>
<dd>
@Html.DisplayFor(model => model.City)
</dd>
<dt>
@Html.DisplayNameFor(model => model.Country)
</dt>
<dd>
@Html.DisplayFor(model => model.Country)
</dd>
</dl>
Vous pourrez alors utiliser @Html.DisplayForModel et éviter de dupliquer votre code dans plusieurs vues.
@model DemoMVC5.Models.Address
<div>
<h4>Your Address</h4>
Html.DisplayForModel()
</div>
Si un de vos objets a une propriété Address, l’affichage se fera via :
@model DemoMVC5.Models.User
<div>
<h4>Your Information</h4>
Html.DisplayFor(model => model.Name)
Html.DisplayFor(model => model.Address)
</div>
Conclusion
Display et Editor templates sont des fonctionnalités méconnues de ASP.NET MVC. Elle permettent de facilement modifier l’affichage d’une classe dans votre site de manière simple et sans duplication de code.
Liens
- What are Display and Editor Templates?
- ASP.NET MVC DisplayTemplate and EditorTemplates for Entity Framework DbGeography Spatial Types
- Enum and Templates
- ASP.NET MVC Display and editor templates
- Using Templates to Display Boolean Values as Yes/No Options
