I'm trying to add theme support to an application by using a custom view engine to dynamically add view search locations based on the theme associated with the current HttpContext.
This works really well for raw views as the locations are searched in order and if a view exists in the relevant theme folder, that is used otherwise it falls back the the default view in the standard location.
However, we make extensive use of nested layouts, typically at least three levels deep (so rewriting just the layout of the current view will not work), and Razor layouts do not use the view engine to resolve as they are typically specified as a full path from root of the application.
For example, if I have the following in a view:
#{ Layout = "~Views/Shared/OneColumn.cshtml"; }
I know I could implement something like this:
#{ Layout = ThemeHelper.GetLayoutPath("OneColumn.cshtml"); }
But what I would much rather do, if possible, is:
#{ Layout = "OneColumn.cshtml"; }
And have the view engine, or any extensibility point really, resolve that to the best match using the same rules as are applied for the main view.
Any ideas?
Related
I had created a module named Orchard.Blogs in my application. Now that blogs view can I make it as a partial view to my other views ? For Ex: http://localhost/Orchard.Web/Orchard.HrCompany/Payroll/GetPay is my url and in my GetPay View can I use Orchard.Blogs view as a partial view ?
In theory you can just use any view you like. However, many views require a view model. For instance, views returned by action methods probably have a view model. If you want to reuse that view, you will have to also provide an instance of that model.
Other views are used by shapes being rendered. If you want to render those views, you will have to actually create an instance of that shape. And if those views expect certain properties to exist on the shape, you will have to set those properties as well.
As you can probably see, this is not very straightforward, as it might potentially involve duplicating a lot of logic to build up the required data (think content part drivers that create shapes, for example).
What I would do instead, is let us know what particular views of the Blogs module you are looking to "reuse". Perhaps there are better ways. For example, there is a BlogArchives widget you might want to use. Or maybe a Projection Widget to render all posts of a particular Blog.
Depending on your exact use case scenario, there is bound to be a proper solution. Blindly reusing views from other modules is not typically done, because of the reasons I just listed.
All the views in orchard called "Shapes", and you can render any shape in any place with "IShapeFactory" interface, you can try the following code:
private readonly dynamic _shapeFactory;
public Constructor(IShapeFactory shapeFactory) {
_shapeFactory = shapeFactory;
}
public void CreateShape(){
dynamic customShape = _shapeFactory.CustomShape(ViewModel: viewModel);
}
This code with search on a view with name "CustomShape", then will render it using the named parameters we send.
On other side, you can display any shape directly in any view like:
#Display.CustomShape(ViewModel: viewModel)
I worked on a project that until recently had no need for areas. Now that I've added an area (TemporaryUser) I'm having difficulty making use of a shared _Error view that is not within its own area.
I know I could just create another area, call it "master" or something, and access its views through typical routing, however it would mean reorganising quite a few files and changing paths.
Is there a way to return a view that is not in an area from within a controller action, that is?
return View("~/Views/Shared/_Error.cshtml", ResponseMessages.TEMP_USER_BATCH_NOT_EXIST);
Where this is in {area}/{controller}/{action} but as you can see the view I'd like to use is in the default shared folder given in MVC 4.
I'm very new to sitecore and just started learning sitecore over at a dev-course held here in town.
The course is WebForms-focused, and since that's not my "patter of choice" I thought I would see how far I can get using MVC in Sitecore.
However, I have a slight problem. I have noticed how there are Controller Renderers, but and how they are bound to a Controller and such. but how about using a Controller for a Layout?
Lets say I have a layout, that for instance might statically render a menu on the top of the site. Then in this case I would like to avoid having a huge amount of code in my view for rendering the menu-items. Instead I would like to have build and populate a custom view model with the menu items and then simply pass down the model to the view and iterate through my menu items within my model.
But I just cant find a way of how to create a controller for a Layout. Any ideas?
Actually, this is possible, you can create a model deriving out of RenderingModel class or implement IRenderingModel interface and assign it to any MVC rendering or layout in Sitecore. Model object will be instantiated by the Sitecore's GetModel pipeline defined in Sitecore.Mvc.Config file.
See Here
Another way to handle this scenario is to create a Menu view rendering and then insert into a placeholder defined within the layout possibly a header placeholder. This can be statically assigned via standard values.
Kevin is right, thats not possible. Actually, Sitecore uses the layout to recognize a view extension and handle the request with MVC (TransferMvcLayout processor in the httpRequestBegin pipeline).
You should consider an approach where you add a placeholder in your layout:
#Html.Sitecore().Placeholder("menu-placeholder")
Then add a Menu Controller Rendering to that placeholder. That way you can utilize the rendering cache as well.
I don't think this is possible. But you can create a Razor view as layout, which works same as a View Rendering. Just just need to specify the path to the Razor view in the Path field and insert a model. In the model you could have simple property, which loads your menu items from whereever you want:
public class MyViewModel
{
public IEnumerable<MenuItem> MenuItems
{
return MyMenuUtil.LoadMenuItems();
}
}
This avoids lot of code in the Razor view and also in the model.
I have a question for the pros and cons on how reusable partial views should be used in a project.
In the first example, I have a layout that is used between all the views. In the layout, I have a partial view that gets called using Html.RenderAction("Index", "Header"). This header changes based on if the user is logged in or not and it renders on every view.
In the second example, I have a static layout that is used between all the views. However, in this layout there are no partial views being called. The Header partial view is being called on each view and basically does the same thing as the first example (changes based on if a user is logged in or not, etc.)
Which approach is better, is one way or another the correct way? Pros and cons of each?
One of the main ideas behind asp.net-mvc is to not reuse code. So with this in mind, you should have your Header code in your _Layout file. This way it is not being retyped in every View, and if you needed to remove it or add route values, etc you do not have to update every View that has it.
An example of this is the _LogOnPartial that is in a default project. In the _Layout it is called by #Html.Partial("_LogOnPartial"), and the _LogOnPartial view contains a logic statement that either displays LogOn or Register or Welcome back....
In my app I have a need to load the same view from two different controllers without placing the view in the shared views directory.
Basically I have this folder structure
Controllers
EventsController.cs
SearchController.cs
Views
Events
Preview.aspx
Search
basically picture it much the same as here on stack overflow. You get a preview of a bunch of questions under the questions link, but you also get an identically formatted page when you do a search in the search bar. The views and viewmodels are presumably identical.
Since the view I need for search is exactly the same as the view I need for events, I'd like to reuse the same view. I would however like to avoid using the shared directory for this specific view.
So my two part question is ---
Is this possible, and if so how?
Is this bad practice?
Yes, you can. Simply return View("~/Views/Events/Preview.aspx").
However, i would advise against it for a number of reasons. The biggest being that this will be non-obvious to anyone trying to modify the code later (maybe even you) and might lead to potential errors.
A better approach might be to create a "Shared" view, or a shared partial view. My preference would be a shared partial view, then in your non-shared view render the partial view functionality you want.
It's possible.
I am not sure if you are using strong-typed views. But suppose it is, then it is a bit weird for me that you have Event search & Search with same View Model. Possibly separate them with two different view models and view would be better IMHO. Moreover, if you specify the name of view to load in controller, it is somehow considered to be coupling view and controller and it certainly not a good idea.