HtmlHelperExtensions.EditableArea Method (HtmlHelperExtensionPoint, String, String, String[])

Note: This API is now obsolete.

Renders editable area markup.

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

Syntax

[ObsoleteAttribute("Use @Html.Kentico().EditableArea(string areaIdentifier, EditableAreaOptions options) instead.")]
public static IHtmlContentProxy EditableArea(
	this HtmlHelperExtensionPoint htmlHelper,
	string areaIdentifier,
	string defaultSectionIdentifier,
	params string[] allowedWidgets
)

Parameters

htmlHelper

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

areaIdentifier

Type: System.String
Area identifier.

defaultSectionIdentifier

Type: System.String
Identifier of a section to be used as an initial one for the area.

allowedWidgets

Type: System.String[]
Identifiers of allowed widgets in the area. If none provided all widgets are allowed.

Return Value

Type: IHtmlContentProxy
Returns HTML markup for editable area container for edit mode.

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.
ArgumentNullException	Thrown when areaIdentifier is null.
ArgumentException	Thrown when areaIdentifier is empty or whitespace.

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.