How to make custom error pages work in ASP NET MVC 4

Question

I want a custom error page shown for 500  404 and 403  Here s what I have done    Enabled custom errors in the web config as follows    lt customErrors mode  On                 defaultRedirect    Views Shared Error cshtml  gt        lt error statusCode  403              redirect    Views Shared UnauthorizedAccess cshtml    gt        lt error statusCode  404              redirect    Views Shared FileNotFound cshtml    gt    lt  customErrors gt   Registered HandleErrorAttribute as a global action filter in the FilterConfig class as follows   public static void RegisterGlobalFilters GlobalFilterCollection filters        filters Add new CustomHandleErrorAttribute         filters Add new AuthorizeAttribute        Created a custom error page for each of the above messages  The default one for 500 was already available out of the box  Declared in each custom error page view that the model for the page is System Web Mvc HandleErrorInfo   For 500  it shows the custom error page  For others  it doesn t   Is there something I am missing   It does look like this is not all there is to displaying custom errors as I read through the code in the OnException method of the HandleErrorAttribute class and it is handling only 500   What do I have to do to handle other errors

User · Answer

It seems i came late to the party  but you should better check this out too   So in system web for caching up exceptions within the application such as return HttpNotFound       lt system web gt       lt customErrors mode  RemoteOnly  gt         lt error statusCode  404  redirect   page-not-found    gt         lt error statusCode  500  redirect   internal-server-error    gt       lt  customErrors gt     lt  system web gt    and in system webServer for catching up errors that were caught by IIS and did not made their way to the asp net framework    lt system webServer gt       lt httpErrors errorMode  DetailedLocalOnly  gt         lt remove statusCode  404   gt         lt error statusCode  404  path   page-not-found  responseMode  Redirect   gt         lt remove statusCode  500   gt         lt error statusCode  500  path   internal-server-error  responseMode  Redirect   gt     lt  system webServer gt    In the last one if you worry about the client response then change the responseMode  Redirect  to responseMode  File  and serve a static html file  since this one will display a friendly page with an 200 response code

User · Answer

I ve done pablo solution and I always had the error  MVC4      The view  Error  or its master was not found or no view engine supports the searched location    To get rid of this  remove the line    filters Add new HandleErrorAttribute       in FilterConfig cs

User · Answer

Building on the answer posted by maxspan  I ve put together a minimal sample project on GitHub showing all the working parts    Basically  we just add an Application Error method to global asax cs to intercept the exception and give us an opportunity to redirect  or more correctly  transfer request  to a custom error page       protected void Application Error Object sender  EventArgs e                   See http   stackoverflow com questions 13905164 how-to-make-custom-error-pages-work-in-asp-net-mvc-4            for additional context on use of this technique          var exception   Server GetLastError            if  exception    null                           This would be a good place to log any relevant details about the exception                 Since we are going to pass exception information to our error page via querystring                 it will only be practical to issue a short message  Further detail would have to be logged somewhere                  This will invoke our error page  passing the exception message via querystring parameter                Note that we chose to use Server TransferRequest  which is only supported in IIS 7 and above                 As an alternative  Response Redirect could be used instead                 Server Transfer does not work  see https   support microsoft com en-us kb 320439               Server TransferRequest    Error Message     exception Message                      Error Controller        lt summary gt      This controller exists to provide the error page      lt  summary gt  public class ErrorController   Controller            lt summary gt          This action represents the error page          lt  summary gt           lt param name  Message  gt Error message to be displayed  provided via querystring parameter - a design choice  lt  param gt           lt returns gt  lt  returns gt      public ActionResult Index string Message                   We choose to use the ViewBag to communicate the error message to the view         ViewBag Message   Message          return View               Error page View    lt  DOCTYPE html gt    lt html gt   lt head gt       lt title gt Error lt  title gt   lt  head gt   lt body gt        lt h2 gt My Error lt  h2 gt       lt p gt  ViewBag Message lt  p gt   lt  body gt   lt  html gt    Nothing else is involved  other than disabling removing filters Add new HandleErrorAttribute    in FilterConfig cs  public class FilterConfig       public static void RegisterGlobalFilters GlobalFilterCollection filters                  filters Add new HandleErrorAttribute         lt    disable remove           While very simple to implement  the one drawback I see in this approach is using querystring to deliver exception information to the target error page

User · Answer

Here is my solution  Use  ExportModelStateToTempData     ImportModelStateFromTempData  is uncomfortable in my opinion     Views Home Error cshtml          ViewBag Title    Error       Layout      Views Shared  Layout cshtml       lt h2 gt Error lt  h2 gt   lt hr  gt    lt div style  min-height  400px   gt        Html ValidationMessage  Error         lt br   gt       lt br   gt        lt button onclick  Error goBack    class  k-button  gt Go Back lt  button gt       lt script gt          function Error goBack                 window history back                  lt  script gt    lt  div gt      Controllers HomeController sc   public class HomeController   BaseController       public ActionResult Index                 return View               public ActionResult Error                 return this View                         Controllers BaseController sc   public class BaseController   Controller       public BaseController            protected override void OnActionExecuted ActionExecutedContext filterContext                if  filterContext Result is ViewResult                        if  filterContext Controller TempData ContainsKey  Error                                  var modelState   filterContext Controller TempData  Error   as ModelState                  filterContext Controller ViewData ModelState Merge new ModelStateDictionary     new KeyValuePair lt string  ModelState gt   Error   modelState                      filterContext Controller TempData Remove  Error                                    if   filterContext Result is RedirectResult      filterContext Result is RedirectToRouteResult                         if  filterContext Controller ViewData ModelState ContainsKey  Error                                  filterContext Controller TempData  Error     filterContext Controller ViewData ModelState  Error                                     base OnActionExecuted filterContext               Controllers MyController sc   public class MyController   BaseController       public ActionResult Index                 return View               public ActionResult Details int id                if  id    5                        ModelState AddModelError  Error    Specified row does not exist                 return RedirectToAction  Error    Home                      else                       return View  Specified row exists                         I wish you successful projects  -

User · Answer

My current setup  on MVC3  but I think it still applies  relies on having an ErrorController  so I use    lt system web gt       lt customErrors mode  On  defaultRedirect    Error  gt         lt error redirect    Error NotFound  statusCode  404    gt       lt  customErrors gt   lt  system web gt    And the controller contains the following   public class ErrorController   Controller       public ViewResult Index                 return View  Error              public ViewResult NotFound                 Response StatusCode   404     you may want to set this to 200         return View  NotFound              And the views just the way you implement them  I tend to add a bit of logic though  to show the stack trace and error information if the application is in debug mode  So Error cshtml looks something like this    model System Web Mvc HandleErrorInfo        Layout     Layout cshtml       ViewBag Title    Error      lt div class  list-header clearfix  gt       lt span gt Error lt  span gt   lt  div gt   lt div class  list-sfs-holder  gt       lt div class  alert alert-error  gt          An unexpected error has occurred  Please contact the system administrator       lt  div gt       if  Model    null  amp  amp  HttpContext Current IsDebuggingEnabled                 lt div gt               lt p gt                   lt b gt Exception  lt  b gt   Model Exception Message lt br   gt                   lt b gt Controller  lt  b gt   Model ControllerName lt br   gt                   lt b gt Action  lt  b gt   Model ActionName              lt  p gt               lt div style  overflow scroll  gt                   lt pre gt                       Model Exception StackTrace                  lt  pre gt               lt  div gt           lt  div gt         lt  div gt

User · Answer

There seem to be a number of steps here jumbled together  I ll put forward what I did from scratch    Create the ErrorPage controller  public class ErrorPageController   Controller       public ActionResult Index                 return View               public ActionResult Oops int id                Response StatusCode   id          return View             Add views for these two actions  right click -  Add View   These should appear in a folder called ErrorPage  Inside App Start open up FilterConfig cs and comment out the error handling filter   public static void RegisterGlobalFilters GlobalFilterCollection filters           Remove this filter because we want to handle errors ourselves via the ErrorPage controller       filters Add new HandleErrorAttribute        Inside web config add the following  lt customerErrors gt  entries  under System Web   lt customErrors mode  On  defaultRedirect    ErrorPage Oops  gt       lt error redirect    ErrorPage Oops 404  statusCode  404    gt       lt error redirect    ErrorPage Oops 500  statusCode  500    gt   lt  customErrors gt   Test  of course   Throw an unhandled exception in your code and see it go to the page with id 500  and then use a URL to a page that does not exist to see 404

User · Answer

In web config add this under system webserver tag as below    lt system webServer gt   lt httpErrors errorMode  Custom  existingResponse  Replace  gt     lt remove statusCode  404   gt     lt remove statusCode  500   gt     lt error statusCode  404  responseMode  ExecuteURL  path   Error NotFound   gt     lt error statusCode  500  responseMode  ExecuteURL path   Error ErrorPage   gt   lt  httpErrors gt      and add a controller as   public class ErrorController   Controller                 GET   Error       GET   Error NotFound        public ActionResult NotFound                 Response StatusCode   404           return View                GET   Error ErrorPage        public ActionResult ErrorPage                 Response StatusCode   500           return View              and add their respected views  this will work definitely I guess for all   This solution I found it from  Neptune Century

User · Answer

You can get errors working correctly without hacking global cs  messing with HandleErrorAttribute  doing Response TrySkipIisCustomErrors  hooking up Application Error  or whatever   In system web  just the usual  on off    lt customErrors mode  On  gt     lt error redirect   error 401  statusCode  401    gt     lt error redirect   error 500  statusCode  500    gt   lt  customErrors gt    and in system webServer   lt httpErrors existingResponse  PassThrough    gt    Now things should behave as expected  and you can use your ErrorController to display whatever you need

User · Answer

I do something that requires less coding than the other solutions posted    First  in my web config  I have the following    lt customErrors mode  On  defaultRedirect    ErrorPage Oops  gt      lt error redirect    ErrorPage Oops 404  statusCode  404    gt      lt error redirect    ErrorPage Oops 500  statusCode  500    gt   lt  customErrors gt    And the controller   Controllers ErrorPageController cs  contains the following   public class ErrorPageController   Controller       public ActionResult Oops int id                Response StatusCode   id           return View              And finally  the view contains the following  stripped down for simplicity  but it can conta    x000D   x000D     ViewBag Title    Oops  Error Encountered     x000D   x000D   lt section id  Page  gt  x000D     lt div class  col-xs-12 well  gt  x000D       lt table cellspacing  5  cellpadding  3  style  background-color  fff width 100    class  table-responsive  gt  x000D         lt tbody gt  x000D           lt tr gt  x000D             lt td valign  top  align  left  id  tableProps  gt  x000D               lt img width  25  height  33  src    Images PageError gif  id  pagerrorImg  gt  x000D             lt  td gt  x000D             lt td width  360  valign  middle  align  left  id  tableProps2  gt  x000D               lt h1 style  COLOR  black  FONT  13pt 15pt verdana  id  errortype  gt  lt span id  errorText  gt  Response Status lt  span gt  lt  h1 gt  x000D             lt  td gt  x000D           lt  tr gt  x000D           lt tr gt  x000D             lt td width  400  colspan  2  id  tablePropsWidth  gt  lt font style  COLOR  black  FONT  8pt 11pt verdana  gt Possible causes  lt  font gt  x000D             lt  td gt  x000D           lt  tr gt  x000D           lt tr gt  x000D             lt td width  400  colspan  2  id  tablePropsWidth2  gt  x000D               lt font style  COLOR  black  FONT  8pt 11pt verdana  id  LID1  gt  x000D                               lt hr gt  x000D                               lt ul gt  x000D                                   lt li id  list1  gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt Baptist explanation   lt  strong gt There x000D                                          must be sin in your life  Everyone else opened it fine  lt br gt  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                                   lt li gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt Presbyterian explanation   lt  strong gt It s x000D                                          not God s will for you to open this link  lt br gt  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                                   lt li gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt  Word of Faith explanation  lt  strong gt  x000D                                          You lack the faith to open this link  Your negative words have prevented x000D                                          you from realizing this link s fulfillment  lt br gt  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                                   lt li gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt Charismatic explanation   lt  strong gt Thou x000D                                          art loosed  Be commanded to OPEN  lt br gt  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                                   lt li gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt Unitarian explanation  lt  strong gt  All x000D                                          links are equal  so if this link doesn t work for you  feel free to x000D                                          experiment with other links that might bring you joy and fulfillment  lt br gt  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                                   lt li gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt Buddhist explanation  lt  strong gt                            lt br gt  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                                   lt li gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt Episcopalian explanation  lt  strong gt  x000D                                          Are you saying you have something against homosexuals  lt br gt  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                                   lt li gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt Christian Science explanation   lt  strong gt There x000D                                          really is no link  lt br gt  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                                   lt li gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt Atheist explanation   lt  strong gt The only x000D                                          reason you think this link exists is because you needed to invent it  lt br gt  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                                   lt li gt  x000D                                       lt span class  infotext  gt  x000D                                           lt strong gt Church counselor s explanation  lt  strong gt  x000D                                          And what did you feel when the link would not open  x000D                                       lt  span gt  x000D                                   lt  li gt  x000D                               lt  ul gt  x000D                               lt p gt  x000D                                   lt br gt  x000D                               lt  p gt  x000D                               lt h2 style  font 8pt 11pt verdana  color black  id  ietext  gt  x000D                                   lt img width  16  height  16  align  top  src    Images Search gif  gt  x000D                                  HTTP  Response StatusCode -  Response StatusDescription  lt br gt  x000D                               lt  h2 gt  x000D                           lt  font gt  x000D             lt  td gt  x000D           lt  tr gt  x000D         lt  tbody gt  x000D       lt  table gt  x000D     lt  div gt  x000D   lt  section gt  x000D   x000D   x000D    It s just as simple as that  It could be easily extended to offer more detailed error info  but ELMAH handles that for me  amp  the statusCode  amp  statusDescription is all that I usually need

User · Answer

I had everything set up  but still couldn t see proper error pages for status code 500 on our staging server  despite the fact everything worked fine on local development servers   I found this blog post from Rick Strahl that helped me   I needed to add Response TrySkipIisCustomErrors   true  to my custom error handling code

User · Answer

I would Recommend to use Global asax cs File     protected void Application Error Object sender  EventArgs e        var exception   Server GetLastError        if  exception is HttpUnhandledException                Server Transfer    Error aspx              if  exception    null                Server Transfer    Error aspx              try                  This is to stop a problem where we were seeing  gibberish  in the            chrome and firefox browsers         HttpApplication app   sender as HttpApplication          app Response Filter   null            catch

[asp.net] How to make custom error pages work in ASP.NET MVC 4

Examples related to asp.net

Examples related to asp.net-mvc

Examples related to asp.net-mvc-4