HtmlHelperExtensions.RenderNestedWidget Method

Renders widget markup based on given widget type as part of a different widget.

Namespace: Kentico.PageBuilder.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131

Syntax

public static IHtmlContentProxy RenderNestedWidget(
	this HtmlHelperExtensionPoint htmlHelper,
	string widgetTypeIdentifier,
	IWidgetProperties widgetProperties
)

Parameters

htmlHelper

Type: Kentico.Web.Mvc.HtmlHelperExtensionPoint
HtmlHelper extension.

widgetTypeIdentifier

Type: System.String
Widget type identifier.

widgetProperties

Type: Kentico.PageBuilder.Web.Mvc.IWidgetProperties
Widget properties.

Return Value

Type: IHtmlContentProxy

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type HtmlHelperExtensionPoint. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	Thrown when htmlHelper is null.
NotSupportedException	Thrown when widget type with widgetTypeIdentifier is not found or method is not used for component with properties.

Remarks

The HTML markup of widget is rendered directly to the response. The nested widget reflects the edit mode of the Page builder feature to display the in-line editors if suitable.