Table of Contents

Class WidgetMetadata

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

Metadata of a widget definition.

public sealed class WidgetMetadata
Inheritance
object
WidgetMetadata
Extension Methods

Properties

DefaultPropertiesUrl

URL of the widget definition to retrieve the default properties.

[JsonProperty("defaultPropertiesUrl")]
public string DefaultPropertiesUrl { get; }

Property Value

string

Description

Description of the registered widget.

[JsonProperty("description")]
public string Description { get; }

Property Value

string

HasEditableProperties

Indicates whether the widget has at least one property which is editable in the properties dialog.

[JsonProperty("hasEditableProperties")]
public bool HasEditableProperties { get; set; }

Property Value

bool

HasProperties

Indicates that registered widget has properties (properties editable via a dialog or an inline editor).

[JsonProperty("hasProperties")]
public bool HasProperties { get; }

Property Value

bool

IconClass

Icon CSS class of the registered widget.

[JsonProperty("iconClass")]
public string IconClass { get; }

Property Value

string

MarkupUrl

URL of the widget definition to retrieve the markup.

[JsonProperty("markupUrl")]
public string MarkupUrl { get; }

Property Value

string

Name

Name of the registered widget.

[JsonProperty("name")]
public string Name { get; }

Property Value

string

PropertiesFormMarkupUrl

URL of the widget definition to retrieve the properties form markup.

[JsonProperty("propertiesFormMarkupUrl")]
public string PropertiesFormMarkupUrl { get; }

Property Value

string

TypeIdentifier

Type widget identifier.

[JsonProperty("typeIdentifier")]
public string TypeIdentifier { get; }

Property Value

string

UseAdminFormComponents

Indicates whether the widget properties form should be opened from the administration UI using admin form components or from the page builder using MVC form components.

[JsonProperty("useAdminFormComponents")]
public bool UseAdminFormComponents { get; set; }

Property Value

bool