Is it possible to use Razor View Engine outside asp.net

asp.netasp.net MvcCode GenerationTemplatingRazor

asp.net Problem Overview


If I look at the Razor View Engine, then I see a very nice and concise syntax that is not particularly tied to generating html. So I wonder, how easy would it be to use the engine outside asp.net in a "normal" .net environment for example to generate text, code,...

Any pointer, example, comment or explanation is welcome.

asp.net Solutions


Solution 1 - asp.net

There are two issues here:

  1. Yes, you can run the Razor View Engine outside of the context of an ASP.NET app domain, as explained in Andrew's blog: http://vibrantcode.com/blog/2010/11/16/hosting-razor-outside-of-aspnet-revised-for-mvc3-rc.html
  2. However, Razor is still primarily focused on generating xml-like markup (e.g. HTML) in the sense that the Razor parser uses the presence of <tags> to determine the transition between code and markup. You can probably use it to generate any text but you might run into issues when your output doesn't match Razor's assumptions about what your intentions are.

So for example while this is valid Razor code (because of the <div> tag):

@if(printHello) {
   <div>Hello!</div>
}

The following snippet is invalid (because the Hello! is still being treated as code):

@if(printHello) {
   Hello!
}

However there's a special <text> tag that can be used to force a transition for multi-line blocks (the <text> tag will not be rendered):

@if(printHello) {
   <text>Hello!
   Another line</text>
}

There is also a shorter syntax to force a single line to transition using @::

@if(printHello) {
   @:Hello!
}

Solution 2 - asp.net

Check RazorEngine, it's a little framework built on top of Razor that allows you to do this.

Solution 3 - asp.net

Take a look at RazorTemplates library. It's more lightweight than RazorEngine library, it's thread-safe and has very nice minimal interface.

Compiling and rendering a template is as simple as two lines of code:

var template = Template.Compile("Hello @Model.Name!");
Console.WriteLine(template.Render(new { Name = "World" }));

Solution 4 - asp.net

Both RazorEngine and RazorTemplates are already mentioned here, but check out RazorMachine. You can simply point your non-MVC app to a ~/Views folder of (another) existing MVC app, execute with sending proper model and get rendered output on 2 lines of code:

var sb = new StringBuilder();

//RazorMachine magic:
//*tweets* is basically List<TwitterPost> - simple collection of custom POCO
//first param for rm.ExecuteUrl points to ~/Views folder, MVC style
var rm = new RazorMachine(htmlEncode: false);
ITemplate template = rm.ExecuteUrl("~/twitter/twitter", tweets);

//do whatever you want with result
sb.Append(template);

Solution 5 - asp.net

Generate code or text: you mean like T4 Templates: http://msdn.microsoft.com/en-us/library/bb126445.aspx or codesmith tools?

Solution 6 - asp.net

Its May 2022 and I kissed a few frogs before finding this blog: https://soundaranbu.medium.com/render-razor-view-cshtml-to-string-in-net-core-7d125f32c79

VERY easy to use along with a .Net Core Razor Class Library (RCL) and this small library: RazorTemplating

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);

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionThomasView Question on Stackoverflow
Solution 1 - asp.netmarcindView Answer on Stackoverflow
Solution 2 - asp.netArielView Answer on Stackoverflow
Solution 3 - asp.netalexeyView Answer on Stackoverflow
Solution 4 - asp.netAntonin JelinekView Answer on Stackoverflow
Solution 5 - asp.netBrian MainsView Answer on Stackoverflow
Solution 6 - asp.netjenson-button-eventView Answer on Stackoverflow