Custom HTML Helpers In MVC

HTML Custom Helpers

HTML helper is a method that returns a HTML string. Then this string is rendered in view. MVC provides many HTML helper methods. It also provides facility to create your own HTML helper methods. Once you create your helper method you can reuse it many times.

There are two ways in MVC to create custom Html helpers as below.

  1. Adding extension method for HtmlHelper class
  2. Using static method

Adding extension method for HtmlHelper class

We can create our own HTML helper by writing extension method for HTML helper class. These helpers are available to Helper property of class and you can use then just like inbuilt helpers.

Example

Add new class in MVC application and give it meaningful name. In this example we create new folder “CustomHelper” in application and then we add class “CustomHelpers” in that folder. As we are going to create extension method make this class static. Write the following code in class:

  1. using System;  
  2. using System.Collections.Generic;  
  3. using System.Linq;  
  4. using System.Web;  
  5. using System.Web.Mvc;  
  6.   
  7. namespace CustomeHelper.CustomHelper  
  8. {  
  9.     public static class CustomHelpers  
  10.     {  
  11.         public static IHtmlString File(this HtmlHelper helper, string id)  
  12.       {  
  13.             TagBuilder tb = new TagBuilder("input");  
  14.             tb.Attributes.Add("type""file");  
  15.             tb.Attributes.Add("id", id);  
  16.             return new MvcHtmlString(tb.ToString());  
  17.         }  
  18.     }  
  19. }  
In above code we create static method file for HtmlHelper class. In this method we create html tag with the help of TagBulider class. In this code we just use two attributes you can add more html attributes as per your requirement. Now we use this html helper method on view just like inbuilt helpers. As this class resides in “CustomHelper” namespace we should add this namespace in view as below,
  1. @using CustomeHelper.CustomHelper  
  2. @ {  
  3.     ViewBag.Title = "Index";  
  4. }  
  5.   
  6. < h2 > Index < /h2>  
If you want to use these helpers on multiple views then add namespace in web.config file. Once you add that namespace you are ready to use “File” helper like below,

file

Add this method and pass id parameter. And run your view, you will get output as below.

output

Using static method

In this method we don’t create any extension method for HtmlHelper class. We create new class as “CustomHelper”. Write the following code in class:
  1. using System;  
  2. using System.Collections.Generic;  
  3. using System.Linq;  
  4. using System.Web;  
  5. using System.Web.Mvc;  
  6.   
  7. namespace CustomeHelper.CustomHelper  
  8. {  
  9.     public class CustomHelper  
  10.     {  
  11.         public static IHtmlString File(string id)  
  12.       {  
  13.             TagBuilder tb = new TagBuilder("input");  
  14.             tb.Attributes.Add("type""file");  
  15.             tb.Attributes.Add("id", id);  
  16.             return new MvcHtmlString(tb.ToString());  
  17.         }  
  18.     }  
  19. }  
Once you create this you are able to use this helper method on view. As in this method we don’t create extension method for HtmlHelper class, we don’t use like inbuilt helpers. To use this helper we use class name instead of “@Html” (in razor view) like below.

class

Add this method and pass id parameter. And run your view, you will get output as below.

output

Conclusion

In this article we learned to create custom html helpers. By creating custom html helper we can eliminate the repeating html code fragments from application.