View Source

Class MacroRenderingController

API controller to deal with Macro data

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

Namespace: Umbraco.Web.Editors

Assembly: Umbraco.Web.dll

Syntax

[PluginController("UmbracoApi")]
public class MacroRenderingController : UmbracoAuthorizedJsonController, IDiscoverable, IRequiresSessionState

Remarks

Note that this implements IRequiresSessionState which will enable HttpContext.Session - generally speaking we don't normally enable this for webapi controllers, however since this controller is used to render macro content and macros can access Session, we don't want it to throw null reference exceptions.

Constructors

MacroRenderingController(IUmbracoComponentRenderer, IVariationContextAccessor, IMacroService, IContentService)

Declaration

public MacroRenderingController(IUmbracoComponentRenderer componentRenderer, IVariationContextAccessor variationContextAccessor, IMacroService macroService, IContentService contentService)

Parameters

Type	Name	Description
IUmbracoComponentRenderer	componentRenderer
IVariationContextAccessor	variationContextAccessor
IMacroService	macroService
IContentService	contentService

Methods

CreatePartialViewMacroWithFile(MacroRenderingController.CreatePartialViewMacroWithFileModel)

Declaration

public HttpResponseMessage CreatePartialViewMacroWithFile(MacroRenderingController.CreatePartialViewMacroWithFileModel model)

Parameters

Type	Name	Description
MacroRenderingController.CreatePartialViewMacroWithFileModel	model

Returns

Type	Description
HttpResponseMessage

GetMacroParameters(Int32)

Gets the macro parameters to be filled in for a particular macro

Declaration

public IEnumerable<MacroParameter> GetMacroParameters(int macroId)

Parameters

Type	Name	Description
System.Int32	macroId

Returns

Type	Description
System.Collections.Generic.IEnumerable<MacroParameter>

Remarks

Note that ALL logged in users have access to this method because editors will need to insert macros into rte (content/media/members) and it's used for inserting into templates/views/etc... it doesn't expose any sensitive data.

GetMacroResultAsHtmlForEditor(String, Int32, IDictionary<String, Object>)

Declaration

public HttpResponseMessage GetMacroResultAsHtmlForEditor(string macroAlias, int pageId, IDictionary<string, object> macroParams)

Parameters

Type	Name	Description
System.String	macroAlias
System.Int32	pageId
System.Collections.Generic.IDictionary<System.String, System.Object>	macroParams

Returns

Type	Description
HttpResponseMessage

GetMacroResultAsHtmlForEditor(MacroRenderingController.MacroParameterModel)

Gets a rendered macro as HTML for rendering in the rich text editor. Using HTTP POST instead of GET allows for more parameters to be passed as it's not dependent on URL-length limitations like GET. The method using GET is kept to maintain backwards compatibility

Declaration

public HttpResponseMessage GetMacroResultAsHtmlForEditor(MacroRenderingController.MacroParameterModel model)

Parameters

Type	Name	Description
MacroRenderingController.MacroParameterModel	model

Returns

Type	Description
HttpResponseMessage