Skip to main content

ASP.NET MVC controller actions that return JSON or partial html


I am trying to create controller actions which will return either JSON or partial html depending upon a parameter. What is the best way to get the result returned to an MVC page asynchronously?



Source: Tips4allCCNA FINAL EXAM

Comments

  1. In your action method, return Json(object) to return JSON to your page.

    public ActionResult SomeActionMethod() {
    return Json(new {foo="bar", baz="Blech"});
    }


    Then just call the action method using Ajax. You could use one of the helper methods from the ViewPage such as

    <%= Ajax.ActionLink("SomeActionMethod", new AjaxOptions {OnSuccess="somemethod"}) %>


    SomeMethod would be a javascript method that then evaluates the Json object returned.

    If you want to return a plain string, you can just use the ContentResult:

    public ActionResult SomeActionMethod() {
    return Content("hello world!");
    }


    ContentResult by default returns a text/plain as its contentType.
    This is overloadable so you can also do:

    return Content("<xml>This is poorly formatted xml.</xml>", "text/xml");

    ReplyDelete
  2. NathanD,

    I think you should consider the AcceptTypes of the request. I am using it in my current project to return the correct content type as follows.

    Your action on the controller can test it as on the request object

    if (Request.AcceptTypes.Contains("text/html")) {
    return View();
    }
    else if (Request.AcceptTypes.Contains("application/json"))
    {
    return Json( new { id=1, value="new" } );
    }
    else if (Request.AcceptTypes.Contains("application/xml") ||
    Request.AcceptTypes.Contains("text/xml"))
    {
    //
    }


    You can then implement the aspx of the view to cater for the partial xhtml response case.

    Then in jQuery you can fetch it passing the type parameter as json:

    $.get(url, null, function(data, textStatus) {
    console.log('got %o with status %s', data, textStatus);
    }, "json"); // or xml, html, script, json, jsonp or text


    Hope this helps
    James

    ReplyDelete
  3. Another nice way to deal with JSON data is using the JQuery getJSON function. You can call the

    public ActionResult SomeActionMethod(int id)
    {
    return Json(new {foo="bar", baz="Blech"});
    }


    method from the jquery getJSON method by simply...

    $.getJSON("../SomeActionMethod", {
    id: someId
    },
    function(data) {
    alert(data.foo);
    alert(data.baz);}

    ReplyDelete
  4. To answer the other half of the question, you can call:

    return PartialView("viewname");


    when you want to return partial HTML. You'll just have to find some way to decide whether the request wants JSON or HTML, perhaps based on a URL part/parameter.

    ReplyDelete
  5. You may want to take a look at this very helpful article which covers this very nicely!

    Just thought it might help people searching for a good solution to this problem.

    http://weblogs.asp.net/rashid/archive/2009/04/15/adaptive-rendering-in-asp-net-mvc.aspx

    Paul

    ReplyDelete
  6. For folks who have upgraded to MVC 3 here is a neat way
    Using MVC3 and Json

    ReplyDelete

Post a Comment

Popular posts from this blog

[韓日関係] 首相含む大幅な内閣改造の可能性…早ければ来月10日ごろ=韓国

div not scrolling properly with slimScroll plugin

I am using the slimScroll plugin for jQuery by Piotr Rochala Which is a great plugin for nice scrollbars on most browsers but I am stuck because I am using it for a chat box and whenever the user appends new text to the boxit does scroll using the .scrollTop() method however the plugin's scrollbar doesnt scroll with it and when the user wants to look though the chat history it will start scrolling from near the top. I have made a quick demo of my situation http://jsfiddle.net/DY9CT/2/ Does anyone know how to solve this problem?

Why does this javascript based printing cause Safari to refresh the page?

The page I am working on has a javascript function executed to print parts of the page. For some reason, printing in Safari, causes the window to somehow update. I say somehow, because it does not really refresh as in reload the page, but rather it starts the "rendering" of the page from start, i.e. scroll to top, flash animations start from 0, and so forth. The effect is reproduced by this fiddle: http://jsfiddle.net/fYmnB/ Clicking the print button and finishing or cancelling a print in Safari causes the screen to "go white" for a sec, which in my real website manifests itself as something "like" a reload. While running print button with, let's say, Firefox, just opens and closes the print dialogue without affecting the fiddle page in any way. Is there something with my way of calling the browsers print method that causes this, or how can it be explained - and preferably, avoided? P.S.: On my real site the same occurs with Chrome. In the ex