How do you use usercontrols in asp.net mvc that display an "island" of data?

Question

I am trying to find out how to use usercontrols in asp.net mvc. I know how to add a usercontrol to a view and how to pass data to it. What I haven't been able to figure out is how do you do this without having to retrieve and pass the data in every single controller?

For example, if I have a user control that displays the most recent posts on several but not all the pages in the site, how do I write the Controllers so that I get data for that usercontrol and pass it to the user control from only one place in the web site instead of getting and passing data in each of the different controllers that the user control is used in?

I'm not sure if this makes sense or not. Is there a better or recommended way to handle an "island" of data that you want to display on several pages?

I'm coming from web forms where I could just write a user control that got its own data and displayed data independently from the rest of whatever page it is used on.

Delft

Answer 1

There are multiple ways to do it.

The basic approach is

• Populate the data for the view in the BaseController (OnActionExecuting event)
• Writing a custom action filter
• Writing an Application Controller (the eg. is in the below links).

An example of OnActionExecuting will be

   [HandleError]
    public class BaseController : Controller
    {
        CourseService cs = new CourseService();
        protected override void OnActionExecuting(ActionExecutingContext filterContext)
        {
            List<Tag> tags = cs.GetTags();
            ViewData["Tags"] = tags;
        }

    }

You can use the "tags" view data on any view. This is just an example of usercontrol being rendered as side content.

<div id="sidebar_b">
         <asp:ContentPlaceHolder ID="ContentReferenceB" runat="server" >
             <% Html.RenderPartial("Tags"); %>
         </asp:ContentPlaceHolder>
   </div>

I found the following URL to be useful.

http://weblogs.asp.net/stephenwalther/archive/2008/08/12/asp-net-mvc-tip-31-passing-data-to-master-pages-and-user-controls.aspx

http://blog.matthidinger.com/2008/02/21/ASPNETMVCUserControlsStartToFinish.aspx

http://www.aaronlerch.com/blog/2008/01/26/displaying-foo-on-every-page-of-an-aspnet-mvc-application/

http://blog.wekeroad.com/2008/01/07/aspnet-mvc-using-usercontrols-usefully/

Ilse

Any thoughts on how to do this with a strongly typed view? – Simpleton

Nevermind, I just put it in OnActionExecuted, which worked great. – Simpleton

Answer 2

In the MVC Futures, available on codeplex , contains the RenderAction HtmlHelper extensions. This will allow you to create a controller for the ueser control and this controller will populate the ViewData used by the user control without having to resort to a base controller as was suggested.

In the View you would do

<% Html.RenderAction("Index", "UserControlController") %>

or one of the other overloads.

This will create an instance of the controller, execute the method and render the user control view into the main view. The main view controller does not need to know anything about the user control or its model/data.

Edelman

Answer 3

Refactor the code that obtains the view data for this user control into it's own method, maybe even it's own model (class). Call this method from each controller that needs to populate the control and pass the results in the ViewData with a well-known key. You might even want to pass the type of the current controller to your method in case it needs to know what data to retrieve based on the base model for the controller.

 ViewData["RecentPosts"] = RecentPosts.GetRecentPosts( this.GetType() );

In your control, retrieve the data using the well-known key.

Franconia

Is there any way to implement it so that you don't need to make a class/method call in each controller that is going to pass data to a view that holds the user control? – Delft

Not really -- you have to get the data populated in the ViewData somehow. @Rajesh's answer has some suggestions on making it easier by deriving your controller's from a base class that implements this for all of the child controllers. – Franconia

Answer 4

How to Handle "Side Content" in ASP.NET MVC

Yaws

You can check the above approach which I have highlighted for side content. In fact I am using the "Tags" as a side content. You can have a sidecontent "usercontrol" and populate it's data in the base controller so that it's available when required. – Ilse