Class HtmlHelperExtensions

Namespace

Kentico.PageBuilder.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Provides extension methods for HtmlHelperExtensionPoint.

public static class HtmlHelperExtensions

Inheritance

object

HtmlHelperExtensions

Methods

ComponentPropertiesData(HtmlHelperExtensionPoint)

Renders a hidden field to persist the component properties data for a form action. Does not render hidden field in case the widget does not have properties.

public static IHtmlContent ComponentPropertiesData(this HtmlHelperExtensionPoint htmlHelper)

Parameters

htmlHelper HtmlHelperExtensionPoint

HtmlHelper extension.

Returns

IHtmlContent

Returns HTML markup for the hidden field.

EditableAreaAsync(HtmlHelperExtensionPoint, string, EditableAreaOptions)

Renders editable area markup.

public static Task<IHtmlContent> EditableAreaAsync(this HtmlHelperExtensionPoint htmlHelper, string areaIdentifier, EditableAreaOptions options = null)

Parameters

htmlHelper HtmlHelperExtensionPoint

HtmlHelper extension point.

areaIdentifier string

Area identifier.

options EditableAreaOptions

Options object configuring the editable area.

Returns

Task<IHtmlContent>

Returns HTML markup for editable area container for enabled page builder mode.

Remarks

For the live site, null value is returned. The HTML markup of area and widgets included in the zones is rendered directly to the response.

Exceptions

ArgumentNullException

Thrown when htmlHelper is null.

ArgumentNullException

Thrown when areaIdentifier is null.

ArgumentException

Thrown when areaIdentifier is empty or whitespace.

PageBuilderScripts(HtmlHelperExtensionPoint)

Renders necessary scripts for Page builder feature.

public static IHtmlContent PageBuilderScripts(this HtmlHelperExtensionPoint htmlHelper)

Parameters

htmlHelper HtmlHelperExtensionPoint

HtmlHelper extension.

Returns

IHtmlContent

Returns HTML markup with script tags for scripts required by Page builder feature.

Exceptions

ArgumentNullException

htmlHelper is null.

InvalidOperationException

Thrown when the Page builder has not been initialized yet.

PageBuilderStyles(HtmlHelperExtensionPoint)

Renders necessary stylesheet link tags for Page builder feature. In edit mode, both page builder (with inline editors) related styles and form widget styles are included. Otherwise, both page builder (without inline editors) and form widget styles are included.

public static IHtmlContent PageBuilderStyles(this HtmlHelperExtensionPoint htmlHelper)

Parameters

htmlHelper HtmlHelperExtensionPoint

HtmlHelper extension.

Returns

IHtmlContent

Returns HTML markup with link tags for stylesheets.

Exceptions

ArgumentNullException

htmlHelper is null.

PageData(HtmlHelperExtensionPoint)

Renders a hidden field to persist the page data context for a form action.

public static IHtmlContent PageData(this HtmlHelperExtensionPoint htmlHelper)

Parameters

htmlHelper HtmlHelperExtensionPoint

HtmlHelper extension.

Returns

IHtmlContent

Returns HTML markup for the hidden field.

RenderNestedWidgetAsync(HtmlHelperExtensionPoint, string, IWidgetProperties)

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

public static Task<IHtmlContent> RenderNestedWidgetAsync(this HtmlHelperExtensionPoint htmlHelper, string widgetTypeIdentifier, IWidgetProperties widgetProperties)

Parameters

htmlHelper HtmlHelperExtensionPoint

HtmlHelper extension.

widgetTypeIdentifier string

Widget type identifier.

widgetProperties IWidgetProperties

Widget properties.

Returns

Task<IHtmlContent>

Remarks

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

Exceptions

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.

RenderStandaloneWidgetAsync(HtmlHelperExtensionPoint, string, IWidgetProperties)

Renders widget markup based on given widget type and properties.

public static Task<IHtmlContent> RenderStandaloneWidgetAsync(this HtmlHelperExtensionPoint htmlHelper, string widgetTypeIdentifier, IWidgetProperties widgetProperties)

Parameters

htmlHelper HtmlHelperExtensionPoint

HtmlHelper extension.

widgetTypeIdentifier string

Widget type identifier.

widgetProperties IWidgetProperties

Widget properties.

Returns

Task<IHtmlContent>

Remarks

The HTML markup of widget is rendered directly to the response.

Exceptions

ArgumentNullException

Thrown when htmlHelper is null.

NotSupportedException

Thrown when widget type with widgetTypeIdentifier is not found.

WidgetZoneAsync(HtmlHelperExtensionPoint, string, IEnumerable<string>)

Renders widget zone markup.

public static Task<IHtmlContent> WidgetZoneAsync(this HtmlHelperExtensionPoint htmlHelper, string zoneName = null, IEnumerable<string> allowedWidgets = null)

Parameters

htmlHelper HtmlHelperExtensionPoint

HtmlHelper extension.

zoneName string

Widget zone name.

allowedWidgets IEnumerable<string>

Identifiers of allowed widgets in the zone. All widgets are allowed by default.

Returns

Task<IHtmlContent>

Returns HTML markup for widget zone container for page builder mode.

Remarks

For the live site, null value is returned. The HTML markup of widgets included in the zone is rendered directly to the response.

Exceptions

ArgumentNullException

Thrown when htmlHelper is null.