Layout.IModuleContentRenderer Interface
Namespace: Nucleus.Abstractions.Layout
Assembly: Nucleus.Abstractions.dll
Defines the interface for the module content renderer.
Internal Use
This interface is marked as internal use only. Internal use classes are not intended for use by extensions, and backward and forward compatibility is not guaranteed.
Remarks
A module content renderer renders the modules that make up a "pane" in a page.
Methods
RenderControlPanelExtension (ViewContext, Site, ControlPanelExtensionDefinition) Method
RenderControlPanelExtension (ViewContext viewContext, Site site, ControlPanelExtensionDefinition controlPanelExtension)
Render the specified control panel extension.
Parameters
| Name | Type |
|---|---|
| viewContext | Microsoft.AspNetCore.Mvc.Rendering.ViewContext |
| site | Nucleus.Abstractions.Models.Site |
| controlPanelExtension |
Nucleus.Abstractions.Models.ControlPanelExtensionDefinition
Specifies the control panel extension being rendered. |
RenderModuleEditor (ViewContext, Site, Page, PageModule, LocalPath, Boolean) Method
RenderModuleEditor (ViewContext viewContext, Site site, Page page, PageModule moduleInfo, LocalPath localPath, Boolean renderContainer)
Render a module's "Edit" action.
Parameters
| Name | Type |
|---|---|
| viewContext | Microsoft.AspNetCore.Mvc.Rendering.ViewContext |
| site | Nucleus.Abstractions.Models.Site |
| page | Nucleus.Abstractions.Models.Page |
| moduleInfo |
Nucleus.Abstractions.Models.PageModule
Specifies the module being rendered. |
| localPath | Nucleus.Abstractions.Models.LocalPath |
| renderContainer |
Boolean
Specifies whether to wrap the module output in a container. |
RenderModuleView (ViewContext, Site, Page, PageModule, LocalPath, Boolean) Method
RenderModuleView (ViewContext viewContext, Site site, Page page, PageModule moduleInfo, LocalPath localPath, Boolean renderContainer)
Render a module's "View" action.
Parameters
| Name | Type |
|---|---|
| viewContext | Microsoft.AspNetCore.Mvc.Rendering.ViewContext |
| site | Nucleus.Abstractions.Models.Site |
| page | Nucleus.Abstractions.Models.Page |
| moduleInfo |
Nucleus.Abstractions.Models.PageModule
Specifies the module being rendered. |
| localPath | Nucleus.Abstractions.Models.LocalPath |
| renderContainer |
Boolean
Specifies whether to wrap the module output in a container. |
RenderPaneAsync (ViewContext, Context, String) Method
RenderPaneAsync (ViewContext viewContext, Context context, String paneName)
Render the module instances within the specified pane.
Parameters
| Name | Type |
|---|---|
| viewContext | Microsoft.AspNetCore.Mvc.Rendering.ViewContext |
| context | Nucleus.Abstractions.Models.Context |
| paneName | String |