HtmlHelperExtensions.EditableArea Method

Renders editable area markup.

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

Syntax

public static IHtmlString EditableArea(
	this ExtensionPoint<HtmlHelper> instance,
	string areaIdentifier,
	string defaultSectionIdentifier = null,
	params string[] allowedWidgets
)

Parameters

instance

Type: Kentico.Web.Mvc.ExtensionPoint<HtmlHelper>
HtmlHelper extension point.

areaIdentifier

Type: System.String
Area identifier.

defaultSectionIdentifier (Optional)

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: IHtmlString
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 ExtensionPoint<HtmlHelper>. 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 instance 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.