C# Class Rebel.Cms.Web.Macros.AbstractMacroEngine

Abstract class representing a MacroEngine

Show file Open project: RebelCMS/rebelcmsxu5

Public Methods

Method	Description
Execute ( Content currentNode, string>.IDictionary macroParams, MacroDefinition macro, System.Web.Mvc.ControllerContext currentControllerContext, IRoutableRequestContext routableRequestContext ) : System.Web.Mvc.ActionResult	Executes the macro engine to render the macro
GetMacroItems ( IBackOfficeRequestContext backOfficeRequestContext ) : IEnumerable	Returns the macro items that can be used by this Engine Each MacroEngine may render different items, such as PartialViews or ChildActions or Xslt files, Python files, etc... The Value set for each of the select list items will be the value passed into the MacroEngine's Execute method as the SelectedItem property of the MacroDefinition.
GetMacroParameters ( IBackOfficeRequestContext backOfficeRequestContext, MacroDefinition macroDefinition ) : IEnumerable	Gets a list of Macro parameters for the definition

Protected Methods

Method	Description
AbstractMacroEngine ( ) : System

Method Details

AbstractMacroEngine() protected method

protected AbstractMacroEngine ( ) : System
return	System

Execute() public abstract method

Executes the macro engine to render the macro

public abstract Execute ( Content currentNode, string>.IDictionary macroParams, MacroDefinition macro, System.Web.Mvc.ControllerContext currentControllerContext, IRoutableRequestContext routableRequestContext ) : System.Web.Mvc.ActionResult
currentNode	Content
macroParams	string>.IDictionary
macro	MacroDefinition
currentControllerContext	System.Web.Mvc.ControllerContext
routableRequestContext	IRoutableRequestContext
return	System.Web.Mvc.ActionResult

GetMacroItems() public abstract method

Returns the macro items that can be used by this Engine

Each MacroEngine may render different items, such as PartialViews or ChildActions or Xslt files, Python files, etc... The Value set for each of the select list items will be the value passed into the MacroEngine's Execute method as the SelectedItem property of the MacroDefinition.

public abstract GetMacroItems ( IBackOfficeRequestContext backOfficeRequestContext ) : IEnumerable
backOfficeRequestContext	IBackOfficeRequestContext
return	IEnumerable

GetMacroParameters() public abstract method

Gets a list of Macro parameters for the definition

public abstract GetMacroParameters ( IBackOfficeRequestContext backOfficeRequestContext, MacroDefinition macroDefinition ) : IEnumerable
backOfficeRequestContext	IBackOfficeRequestContext
macroDefinition	MacroDefinition
return	IEnumerable