Table of Contents

Class EditableAreaTagHelper

Namespace
Kentico.Content.Web.Mvc
Assembly
Kentico.Content.Web.Mvc.dll

Renders editable area markup.

public class EditableAreaTagHelper : HtmlHelperAsyncExtensionTagHelper
Inheritance
object
TagHelper
HtmlHelperAsyncExtensionTagHelper
EditableAreaTagHelper
Extension Methods

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.

Constructors

EditableAreaTagHelper(IHtmlHelper)

Initializes a new instance of the EditableAreaTagHelper class.

public EditableAreaTagHelper(IHtmlHelper htmlHelper)

Parameters

htmlHelper IHtmlHelper

The HTML helper.

Properties

AllowWidgetOutputCache

A flag indicating whether the output of the individual widgets within the editable area can be cached. The default value is false.

public bool AllowWidgetOutputCache { get; set; }

Property Value

bool

Remarks

The system combines the value with the AllowCache flag of the corresponding widget.

See Also

AreaIdentifier

Area identifier.

public string AreaIdentifier { get; set; }

Property Value

string

AreaOptions

Options object configuring the editable area.

public EditableAreaOptions AreaOptions { get; set; }

Property Value

EditableAreaOptions

AreaOptionsAllowedSections

Identifiers of allowed sections in the area. All sections are allowed by default. Use NONE or System.Linq.Enumerable.Empty<TResult>() if no sections are allowed; or ALL if all sections are allowed.

public IEnumerable<string> AreaOptionsAllowedSections { get; set; }

Property Value

IEnumerable<string>

AreaOptionsAllowedWidgets

Identifiers of allowed widgets in the area. All widgets are allowed by default. Use NONE or System.Linq.Enumerable.Empty<TResult>() if no widgets are allowed; or ALL if all widgets are allowed.

public IEnumerable<string> AreaOptionsAllowedWidgets { get; set; }

Property Value

IEnumerable<string>

AreaOptionsDefaultSectionIdentifier

Identifier of a section to be used as an initial one for the area.

public string AreaOptionsDefaultSectionIdentifier { get; set; }

Property Value

string

WidgetOutputCacheExpiresAfter

The length of time from the first request to cache the output of the individual widgets.

public TimeSpan? WidgetOutputCacheExpiresAfter { get; set; }

Property Value

TimeSpan?
See Also

WidgetOutputCacheExpiresOn

An absolute expiration date for the cached output of the individual widgets.

public DateTimeOffset? WidgetOutputCacheExpiresOn { get; set; }

Property Value

DateTimeOffset?
See Also

WidgetOutputCacheExpiresSliding

The time after which the cached output of the individual widgets should be evicted if it has not been accessed.

public TimeSpan? WidgetOutputCacheExpiresSliding { get; set; }

Property Value

TimeSpan?
See Also

Methods

CallHtmlHelper()

Used to call Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper Kentico extension point methods.

protected override Task<IHtmlContent> CallHtmlHelper()

Returns

Task<IHtmlContent>