razorengine Wiki Rss Feed

New Comment on "Building Custom Base Templates"

xps — Tue, 30 Apr 2013 02:23:29 GMT

The Razor.SetTemplateBase() method no longer seem to exist?

Updated Wiki: Home

BuildStarted — Wed, 09 Jan 2013 17:55:49 GMT

RazorEngine has been moved to Github

http://github.com/Antaris/RazorEngine

Update - An early look at RazorEngine v3
New blog post - http://www.fidelitydesign.net/?p=473

Project Description
A templating engine built upon Microsoft's Razor parsing technology. The RazorEngine allows you to use Razor syntax to build robust templates. Currently we have integrated the vanilla Html + Code support, but we hope to support other markup languages in future.

Using the templating engine couldn't be easier, using a simple syntax, we can do the following:

  string template = "Hello @Model.Name! Welcome to Razor!";
  string result = Razor.Parse(template, new { Name = "World" });

The templating engine supports strict and anonymous types, as well as customised base templates, for instance:

  Razor.SetTemplateBase(typeof(HtmlTemplateBase<>));
  
  string template = 
  @"<html>
      <head>
        <title>Hello @Model.Name</title>
      </head>
      <body>
        Email: @Html.TextBoxFor(m => m.Email)
      </body>
    </html>";
    
  var model = new PageModel { Name = "World", Email = "someone@somewhere.com" };
  string result = Razor.Parse(template, model);

NuGet Distribution

The Razor Templating Engine is available through Nuget (http://nuget.codeplex.com/) in Visual Studio. Simply search for RazorEngine in the package manager, or:

    Install-Package RazorEngine

Support Us

Donations are always welcome and very appreciated :-), please send donations via Paypal

Hope you enjoy, feedback is welcome!

Updated Wiki: Home

BuildStarted — Wed, 09 Jan 2013 17:55:29 GMT

RazorEngine has been moved to Github (http://github.com/Antaris/RazorEngine)

  string template = "Hello @Model.Name! Welcome to Razor!";
  string result = Razor.Parse(template, new { Name = "World" });

The templating engine supports strict and anonymous types, as well as customised base templates, for instance:

  Razor.SetTemplateBase(typeof(HtmlTemplateBase<>));
  
  string template = 
  @"<html>
      <head>
        <title>Hello @Model.Name</title>
      </head>
      <body>
        Email: @Html.TextBoxFor(m => m.Email)
      </body>
    </html>";
    
  var model = new PageModel { Name = "World", Email = "someone@somewhere.com" };
  string result = Razor.Parse(template, model);

NuGet Distribution

The Razor Templating Engine is available through Nuget (http://nuget.codeplex.com/) in Visual Studio. Simply search for RazorEngine in the package manager, or:

    Install-Package RazorEngine

Support Us

Donations are always welcome and very appreciated :-), please send donations via Paypal

Hope you enjoy, feedback is welcome!

New Comment on "Documentation"

chill_beer — Wed, 01 Aug 2012 20:17:21 GMT

Thx!! really cool....

New Comment on "Quick Start Guide"

jalalx — Mon, 30 Apr 2012 08:39:18 GMT

is possible to use razor in desktop applications for reporting reasons without referencing to any system.web assembly?

New Comment on "Quick Start Guide"

gichamba — Mon, 30 Jan 2012 20:35:15 GMT

How do you determine whether a compiled template already exist in the cache?

Updated Wiki: Home

AntarisZX — Mon, 07 Nov 2011 10:38:33 GMT

  string template = "Hello @Model.Name! Welcome to Razor!";
  string result = Razor.Parse(template, new { Name = "World" });

The templating engine supports strict and anonymous types, as well as customised base templates, for instance:

  Razor.SetTemplateBase(typeof(HtmlTemplateBase<>));
  
  string template = 
  @"<html>
      <head>
        <title>Hello @Model.Name</title>
      </head>
      <body>
        Email: @Html.TextBoxFor(m => m.Email)
      </body>
    </html>";
    
  var model = new PageModel { Name = "World", Email = "someone@somewhere.com" };
  string result = Razor.Parse(template, model);

NuGet Distribution

The Razor Templating Engine is available through Nuget (http://nuget.codeplex.com/) in Visual Studio. Simply search for RazorEngine in the package manager, or:

    Install-Package RazorEngine

Support Us

Donations are always welcome and very appreciated :-), please send donations via Paypal

Hope you enjoy, feedback is welcome!

Updated Wiki: Home

AntarisZX — Mon, 07 Nov 2011 10:30:30 GMT

  string template = "Hello @Model.Name! Welcome to Razor!";
  string result = Razor.Parse(template, new { Name = "World" });

The templating engine supports strict and anonymous types, as well as customised base templates, for instance:

  Razor.SetTemplateBase(typeof(HtmlTemplateBase<>));
  
  string template = 
  @"<html>
      <head>
        <title>Hello @Model.Name</title>
      </head>
      <body>
        Email: @Html.TextBoxFor(m => m.Email)
      </body>
    </html>";
    
  var model = new PageModel { Name = "World", Email = "someone@somewhere.com" };
  string result = Razor.Parse(template, model);

NuGet Distribution

The Razor Templating Engine is available through Nuget (http://nuget.codeplex.com/) in Visual Studio. Simply search for RazorEngine in the package manager, or:

    Install-Package RazorEngine

Support Us

Donations are always welcome and very appreciated :-), please send donations to Paypal (matt [at] fidelitydesign (dot) net)

Hope you enjoy, feedback is welcome!

Updated Wiki: Home

AntarisZX — Mon, 07 Nov 2011 10:22:29 GMT

  string template = "Hello @Model.Name! Welcome to Razor!";
  string result = Razor.Parse(template, new { Name = "World" });

The templating engine supports strict and anonymous types, as well as customised base templates, for instance:

  Razor.SetTemplateBase(typeof(HtmlTemplateBase<>));
  
  string template = 
  @"<html>
      <head>
        <title>Hello @Model.Name</title>
      </head>
      <body>
        Email: @Html.TextBoxFor(m => m.Email)
      </body>
    </html>";
    
  var model = new PageModel { Name = "World", Email = "someone@somewhere.com" };
  string result = Razor.Parse(template, model);

NuGet Distribution

The Razor Templating Engine is available through Nuget (http://nuget.codeplex.com/) in Visual Studio. Simply search for RazorEngine in the package manager, or:

    Install-Package RazorEngine

Support Us

Donations are always welcome and very appreciated :-)

Hope you enjoy, feedback is welcome!

Updated Wiki: Home

AntarisZX — Thu, 13 Oct 2011 11:10:48 GMT

  string template = "Hello @Model.Name! Welcome to Razor!";
  string result = Razor.Parse(template, new { Name = "World" });

The templating engine supports strict and anonymous types, as well as customised base templates, for instance:

  Razor.SetTemplateBase(typeof(HtmlTemplateBase<>));
  
  string template = 
  @"<html>
      <head>
        <title>Hello @Model.Name</title>
      </head>
      <body>
        Email: @Html.TextBoxFor(m => m.Email)
      </body>
    </html>";
    
  var model = new PageModel { Name = "World", Email = "someone@somewhere.com" };
  string result = Razor.Parse(template, model);

NuGet Distribution

The Razor Templating Engine is available through Nuget (http://nuget.codeplex.com/) in Visual Studio. Simply search for RazorEngine in the package manager, or:

    Install-Package RazorEngine

Hope you enjoy, feedback is welcome!

New Comment on "Configuring RazorEngine for ASP.NET Medium Trust"

AlbertoLeonTis — Wed, 07 Sep 2011 16:56:26 GMT

The element <buildProviders> shoulds be placed within <system.web><compilaton>: See this resource: http://msdn.microsoft.com/en-us/library/h0e51sw9.aspx

New Comment on "Quick Start Guide"

mikechenx — Mon, 08 Aug 2011 03:58:12 GMT

It doesn't work in VB.NET. The error message is as below: Unable to compile template. Check the Errors list for details. Source code: Dim template = "Hello @Model.Name! Welcome to Razor!" Dim myEmp2 = New With {.Name = "World"} Console.WriteLine(Razor.Parse(template, myEmp2))

New Comment on "Quick Start Guide"

manit — Thu, 04 Aug 2011 21:43:48 GMT

this is great, so far really easy to use. and it is fast.

New Comment on "Building Custom Base Templates"

smnbss — Wed, 20 Jul 2011 16:33:14 GMT

I'm having a problem with Razor.SetTemplateBase(typeof(MyCustomTemplateBase<>)); if the template has the following attribute [RequireNamespaces("System.Web.Mvc", "System.Web.Mvc.Html")] but System.Web.Mvc.dll and System.Web.Mvc.Html,dll assembly are never used anywhere else on the hosting process, those dlls are never loaded and the Compilation fail with the following error: {c:\Users\{user}\AppData\Local\Temp\jfha1304.0.cs(15,22) : error CS0234: The type or namespace name 'Mvc' does not exist in the namespace 'System.Web' (are you missing an assembly reference?)}

Updated Wiki: Quick Start Guide

BuildStarted — Mon, 07 Mar 2011 15:24:30 GMT

Quick Start Guide

To get started using the Razor Templating Engine, add a reference to RazorEngine.dll to your project (it requires System.Web.Razor.dll, included in the release). Once you've added the reference, you can start parsing templates.

Simple Template Parsing

  string template = "Hello @Model.Name! Welcome to Razor!"
  string result = Razor.Parse(template, new { Name = "World" });

In the above example, I am using an anonymous object to populate the Model property of the base template.

Inline Helper Support

  string template = 
  @"@helper MyMethod(string name) {
      Hello @name
  }
  @MyMethod(Model.Name)! Welcome to Razor!";
  string result = Razor.Parse(template, new { Name = "World" });

Inline helpers are particularly useful for repeating complex subtemplates within a large template.

Precompiling Templates

You can precompile your templates before use if you have any really nontrivial views to compile.

    string template = "Some really complex template that will take time to parse";
    
    Razor.Compile(template, "complex");
    Razor.Run("complex");

If your template requires a model you can pass in your model type or, if your type is anonymous, you can call the CompileWithAnonymous() method. It is not necessary to pass in your Anonymous type.

    Razor.Compile(template, typeof(SomeModel), "complex");
    Razor.CompileWithAnonymous(template, "complex");

Updated Wiki: Using Configuration

AntarisZX — Fri, 11 Feb 2011 09:49:51 GMT

Using Configuration

RazorEngine supports configuration through the standard .NET configuration framework. This page discuss what can be configured.

Adding the configuration section.

To start using configuration, you need to add the configSection:

<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <configSections>
        <section name="razorEngine" type="RazorEngine.Configuration.RazorEngineConfigurationSection, RazorEngine" requirePermission="false" />
    </configSections>
</configuration>

The <razorEngine> element

The <razorEngine> element is the root of RazorEngine's configuration. The following attributes are supported:

Attribute Name	Required?	Default	Purpose
activator	false	RazorEngine.Templating.DefaultActivator	Sets the default IActivator type for RazorEngine
factory	false	RazorEngine.Compilation.DefaultCompilerServiceFactory	Sets the ICompilerServiceFactory type for RazorEngine

The <razorEngine> element supports for the following elements:

Element Name	Required?	Default	Purpose
namespaces	false		Defines the global namespace imports used for all templates
templateServices	false		Defines configurations for instances of TemplateService

An example configuration could be:

    <razorEngine activator="RazorEngineSamples.Activators.MySampleActivator, RazorEngineSamples"
                 factory="RazorEngine.Web.WebCompilerServiceFactory, RazorEngine.Web">
        <namespaces>
            <add namespace="System.Linq" />
        </namespaces>
        <templateServices>
            <add ...
        </templateServices>
    </razorEngine>

Configuring TemplateService instances.

RazorEngine allows you to pre-configure instances of TemplateService which are then made available to your code. The <add> element supports the following attributes:

Attribute Name	Required?	Default	Purpose
activator	false	RazorEngine.Templating.DefaultActivator	Sets the activator type for the template service
language	false	CSharp	Sets the code language that the template is to support. This is an enum value of CSharp, VisualBasic.
markupParser	false	System.Web.Razor.Parser.HtmlMarkupParser	Sets the markup parser type for the template service. The default is HtmlMarkupParser
name	true		Sets the name of the template service.
namespaces	false		Sets the collection of namespaces imports for this template service.
strictMode	false	false	Sets whether the template will run in strict mode - this will cause parsing exceptions to be thrown for invalid markup.
templateBase	false		Sets the template base type for this template service.

Accessing configured template services

Any template service configured through the <templateServices> element using the Razor.Services property. The Services property is an IDictionarty<string, TemplateService> instance using the configured name as the key.

    <razorEngine>
        <templateServices>
            <add name="myCustomTemplateService" language="CSharp" />
        </templateServices>
    <razorEngine>

var service = Razor.Services["myCustomTemplateService"];
string result = service.Parse("Hello @Model.Name", new { Name = "World" });

Setting the default TemplateService

You can change the default TemplateService instance by using the `default` attribute on the <templateServices> element:

    <razorEngine>
        <templateServices default="myCustomTemplateService">
            <add name="myCustomTemplateService" ...
        </templateServices>
    </razorEngine>

This will enforce that when using calls from the Razor static type, it will use your default template service. If you do not set the default template service, calls to the Razor type methods will use the internal configured default instance, which uses the C# code language and the HtmlMarkupParser.

Updated Wiki: Documentation

AntarisZX — Fri, 11 Feb 2011 09:09:06 GMT

Documentation

Updated Wiki: Home

AntarisZX — Wed, 09 Feb 2011 22:50:23 GMT

Project Description
A templating engine built upon Microsoft's Razor parsing technology. The RazorEngine allows you to use Razor syntax to build robust templates. Currently we have integrated the vanilla Html + Code support, but we hope to support other markup languages in future.

Using the templating engine couldn't be easier, using a simple syntax, we can do the following:

  string template = "Hello @Model.Name! Welcome to Razor!";
  string result = Razor.Parse(template, new { Name = "World" });

The templating engine supports strict and anonymous types, as well as customised base templates, for instance:

  Razor.SetTemplateBase(typeof(HtmlTemplateBase<>));
  
  string template = 
  @"<html>
      <head>
        <title>Hello @Model.Name</title>
      </head>
      <body>
        Email: @Html.TextBoxFor(m => m.Email)
      </body>
    </html>";
    
  var model = new PageModel { Name = "World", Email = "someone@somewhere.com" };
  string result = Razor.Parse(template, model);

NuGet Distribution

The Razor Templating Engine is available through Nuget (http://nuget.codeplex.com/) in Visual Studio. Simply search for RazorEngine in the package manager, or:

    Install-Package RazorEngine

Hope you enjoy, feedback is welcome!

Updated Wiki: Quick Start Guide

AntarisZX — Sun, 23 Jan 2011 17:09:32 GMT

Quick Start Guide

To get started using the Razor Templating Engine, add a reference to RazorEngine.Core.dll to your project (it requires System.Web.Razor.dll, included in the release). Once you've added the reference, you can start parsing templates.

Simple Template Parsing

  string template = "Hello @Model.Name! Welcome to Razor!"
  string result = Razor.Parse(template, new { Name = "World" });

In the above example, I am using an anonymous object to populate the Model property of the base template.

Inline Helper Support

  string template = 
  @"@helper MyMethod(string name) {
      Hello @name
  }
  @MyMethod(Model.Name)! Welcome to Razor!";
  string result = Razor.Parse(template, new { Name = "World" });

Inline helpers are particularly useful for repeating complex subtemplates within a large template.

Precompiling Templates

You can precompile your templates before use if you have any really nontrivial views to compile.

    string template = "Some really complex template that will take time to parse";
    
    Razor.Compile(template, "complex");
    Razor.Run("complex");

If your template requires a model you can pass in your model type or, if your type is anonymous, you can call the CompileWithAnonymous() method. It is not necessary to pass in your Anonymous type.

    Razor.Compile(template, typeof(SomeModel), "complex");
    Razor.CompileWithAnonymous(template, "complex");

Updated Wiki: Architecture

AntarisZX — Sun, 23 Jan 2011 17:08:03 GMT

Framework Architecture

RazorEngine is a simplified templating framework built around Microsoft's new Razor parsing engine, used in both ASP.NET MVC3 and Web Pages. RazorEngine provides a wrapper and additional services built around the parsing engine to allow the parsing technology to be used in other project types.

The core components that make up the templating mechanism are a compiler service and a template service. The compile service is defined as:

public interface ICompilerService
{
    string BuildTypeName(Type templateType, Type modelType);
    Type CompileType(TypeContext context);
}

The compiler service is responsible for transforming a text template (as defined in a TypeContext) into a compiled type using the Razor parser for code generation. When a type has been generated, it is instantiated through an activator:

public interface IActivator
{
    ITemplate CreateInstance(Type type);
}

An activator allows for the custom instantiation of a template instance. This functionality is managed through a TemplateService instance. A TemplateService provides additional functionality, such as templating caching and template resolution. Template resolution is the process of locating additional templates using @Include calls. A template resolver is defined as:

public interface ITemplateResolver
{
    string GetTemplate(string name);
}

A template resolver returns the unparsed template content of the template to include. This allows @Include calls to be resolved at execute time by providing a mechanism to locate named templates that may not have been parsed prior to the parent template executing.