Click here to Skip to main content
Click here to Skip to main content

Custom HTML Helper for MVC Application

By , 3 Feb 2014
Rate this:
Please Sign up or sign in to vote.

Introduction

How many times did you wonder how to avoid writing the same chunk of HTML / JavaScript code many times in an MVC Razor view? What if this repetitive task includes some logic?

The solution to avoid this is to build a custom HTML helper to encapsulate everything and make the repetitive task less cumbersome.

Let's say we want to avoid doing this many times inside your views:

<img src="@myModel.MyObject.ImageSource", alt ="@myModel.MyObject.Imagename",
title ="@myModel.MyObject.ImageDescription" />  

And instead, you want something Razor like that may take care of some logic or validations to avoid error because in the previous snippet, the ImageSource or Imagename or again the description may be null:

 @Html.Image(@myModel.MyObject.ImageSource, 
@myModel.MyObject.Imagename, @myModel.MyObject.ImageDescription) 
namespace MyNamespace 
 {  
    public static class MyHeleprs
    { 
        public static MvcHtmlString Image(this HtmlHelper htmlHelper, 
        	string source, string alternativeText)
        {
            //declare the html helper 
            var builder = new TagBuilder("image"); 
            //hook the properties and add any required logic
            builder.MergeAttribute("src", source);
            builder.MergeAttribute("alt", alternativeText);
            //create the helper with a self closing capability
            return MvcHtmlString.Create(builder.ToString(TagRenderMode.SelfClosing));
        } 
    } 
}

To make this helper available in your view, add its namespace as follows:

@namespace MyNamespace 

But if you want it available in all your views, you have to add the namespace not to a specific view but to the collection of namespaces in views' web.config:

<add namespace="MyNamespace" />   

Now, the Image helper is available everywhere in your views.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Mack Ait-Aoudia
Software Developer (Senior) http://www.m2a.ca
Canada Canada
No Biography provided

Comments and Discussions

 
Questionit's all about logic PinmemberMack Ait-Aoudia6-Feb-14 10:54 
QuestionNice Intro to extending HtmlHelper, but I think not necessary for the problem shown Pinmemberigambin5-Feb-14 4:51 
QuestionVery good article Mack Ait! PinprofessionalVolynsky Alex4-Feb-14 9:28 
QuestionMmmm PinmvpSacha Barber4-Feb-14 2:22 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web02 | 2.8.140421.2 | Last Updated 3 Feb 2014
Article Copyright 2014 by Mack Ait-Aoudia
Everything else Copyright © CodeProject, 1999-2014
Terms of Use
Layout: fixed | fluid