Class RenderingEngineOptions

Version: 21.x

The options to configure the Sitecore Rendering Engine.

Inheritance

System.Object

RenderingEngineOptions

Namespace: Sitecore.AspNet.RenderingEngine.Configuration

Assembly: Sitecore.AspNet.RenderingEngine.dll

Syntax
public class RenderingEngineOptions : Object

Constructors

RenderingEngineOptions()

Declaration
public RenderingEngineOptions()

Properties

DefaultRenderer

Gets or sets the default ComponentRendererDescriptor object for handling component rendering.

Declaration
public ComponentRendererDescriptor DefaultRenderer { get; set; }
Property Value
TypeDescription
ComponentRendererDescriptor

PostRenderingActions

Gets collection of actions to be executed right after RenderingEngine middleware logic.

Declaration
public ICollection<Action<HttpContext>> PostRenderingActions { get; }
Property Value
TypeDescription
System.Collections.Generic.ICollection

<

System.Action

<

Microsoft.AspNetCore.Http.HttpContext

>>

RendererRegistry

Gets or sets the list of ComponentRendererDescriptor objects for handling component rendering.

Declaration
public SortedList<int, ComponentRendererDescriptor> RendererRegistry { get; set; }
Property Value
TypeDescription
System.Collections.Generic.SortedList

<

System.Int32

,

ComponentRendererDescriptor

>

RequestMappings

Gets or sets the action list to configure the SitecoreLayoutRequest handler for incoming HTTP requests.

Declaration
public ICollection<Action<HttpRequest, SitecoreLayoutRequest>> RequestMappings { get; set; }
Property Value
TypeDescription
System.Collections.Generic.ICollection

<

System.Action

<

Microsoft.AspNetCore.Http.HttpRequest

,

SitecoreLayoutRequest

>>

Extension Methods

RenderingEngineOptionsExtensions.AddPartialView(RenderingEngineOptions, String)

RenderingEngineOptionsExtensions.AddPartialView(RenderingEngineOptions, String, String)

RenderingEngineOptionsExtensions.AddPartialView(RenderingEngineOptions, Predicate, String)

RenderingEngineOptionsExtensions.AddDefaultPartialView(RenderingEngineOptions, String)

RenderingEngineOptionsExtensions.AddViewComponent(RenderingEngineOptions, String)

RenderingEngineOptionsExtensions.AddViewComponent(RenderingEngineOptions, String, String)

RenderingEngineOptionsExtensions.AddViewComponent(RenderingEngineOptions, Predicate, String)

RenderingEngineOptionsExtensions.AddModelBoundView(RenderingEngineOptions, String)

RenderingEngineOptionsExtensions.AddModelBoundView(RenderingEngineOptions, String, String)

RenderingEngineOptionsExtensions.AddModelBoundView(RenderingEngineOptions, Predicate, String)

RenderingEngineOptionsExtensions.AddDefaultComponentRenderer(RenderingEngineOptions)

RenderingEngineOptionsExtensions.AddDefaultComponentRenderer(RenderingEngineOptions)

RenderingEngineOptionsExtensions.MapToRequest(RenderingEngineOptions, Action<HttpRequest, SitecoreLayoutRequest>)

RenderingEngineOptionsExtensions.AddPostRenderingAction(RenderingEngineOptions, Action)

If you have suggestions for improving this article, let us know!