To render a view with layout, model, viewdata or viewbag, then call the RenderAsync() on the RazorTemplateEngine static class
RenderAsync() method
using Razor.Templating.Core;
var model = new ExampleModel()
{
PlainText = "This text is rendered from Razor Views using Razor.Templating.Core",
HtmlContent = "<em>You can use it to generate email content, report generation and so on</em>"
};
// Both ViewBag and ViewData should be added to the same dictionary.
var viewDataOrViewBag = new Dictionary<string, object>();
// ViewData is same as mvc
viewDataOrViewBag["Value1"] = "1";
// ViewBag.Value2 can be written as below. There's no change on how it's accessed in .cshtml file
viewDataOrViewBag["Value2"] = "2";
var html = await RazorTemplateEngine.RenderAsync("/Views/ExampleView.cshtml", model, viewDataOrViewBag);
In case if there's a need to render a view without layout, use RenderParitalAsync() method.
RenderPartialAsync() method
var html = await RazorTemplateEngine.RenderPartialAsync("/Views/ExampleView.cshtml", model, viewDataOrViewBag);
Render Views Without Throwing Exception
There are TryRenderAsync() and TryRenderPartialAsync methods which will not throw exception if the view doesn't exist.
Instead they return a tuple to indicate whether the view exists and the rendered string.
TryRenderAsync() method
var (viewExists, renderedView) = await engine.TryRenderAsync("~/Views/Feature/ExampleViewWithoutViewModel.cshtml");
TryRenderPartialAsync() method
var (viewExists, renderedView) = await engine.TryRenderPartialAsync("~/Views/_ExamplePartialView.cshtml", model);
Razor Views in Library
We can organize the Razor view files(.cshtml) in a separate shared Razor Class Libary(RCL). Please find a sample library here
The Razor Class Library's .csproj file should look something like below. Whereas, AddRazorSupportForMvc property is mandatory.
Also, RCL should be referenced by the main project or where any of the rendering methods like RazorTemplateEngine.RenderAsync() are invoked.
Dependencies can be injected directly into views using @inject in .csthml file. Refer sample application here
In ASP.NET Core, add dependency like below in Startup.cs -> ConfigureServices
...
services.AddTransient<ExampleService>();
//add after registering all the dependencies
services.AddRazorTemplating();
or in console or other applications, add as below
using Microsoft.Extensions.DependencyInjection;
// Add dependencies to the service collection
var services = new ServiceCollection();
services.AddTransient<ExampleService>();
// Add RazorTemplating after registering all dependencies
// this is important for the razor template engine to find the injected services
services.AddRazorTemplating();
Once the dependencies are registered, we can use either one of these ways:
Using RazorTemplateEngine static class
var html = await RazorTemplateEngine.RenderAsync("~/Views/ExampleViewServiceInjection.cshtml");
Using IRazorTemplateEngine
Instead of using the RazorTemplateEngine static class, it's also possible to use the IRazorTemplateEngine interface to inject dependency directly into the constructor.
public class MyService {
private readonly IRazorTemplateEngine _razorTemplateEngine;
public MyService (IRazorTemplateEngine razorTemplateEngine)
{
_razorTemplateEngine = razorTemplateEngine;
}
public async Task Index()
{
var renderedView = await _razorTemplateEngine.RenderAsync("/Views/Home/Index.cshtml");
// do something with renderedView
}
}
How to render razor views from absolute path
We can make use of ASP.NET Core's inbuilt RazorRuntimeCompilation to render any .cshtml inside or outside of the project.
As of v1.7.0+, we can achieve this as below:
using Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.FileProviders;
using Razor.Templating.Core;
var services = new ServiceCollection();
services.AddMvcCore().AddRazorRuntimeCompilation();
services.Configure<MvcRazorRuntimeCompilationOptions>(opts =>
{
opts.FileProviders.Add(new PhysicalFileProvider(@"D:\PathToRazorViews")); // This will be the root path
});
services.AddRazorTemplating();
var html = await RazorTemplateEngine.RenderAsync("/Views/Home/Rcl.cshtml"); // relative path to the root
Please note this may become slightly better in the future versions of our library.
Note:
Please ensure that the views path is always unique among all the shared template projects.
