RegisterWidgetAttribute Constructor (String, String, Type, String)

Creates an instance of the RegisterWidgetAttribute class.

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

Syntax

public RegisterWidgetAttribute(
	string identifier,
	string name,
	Type propertiesType = null,
	string customViewName = null
)

Parameters

identifier

Type: System.String
Unique identifier of the widget definition.

name

Type: System.String
Name of the registered widget.

propertiesType (Optional)

Type: System.Type
Type of the registered widget properties model. The type needs to implement the IWidgetProperties interface.

customViewName (Optional)

Type: System.String
Custom view name for the registered widget. If not specified, the default system view name in format '~/Shared/Widgets/_{identifier}' is used.

Remarks

Make sure to provide unique identifier for the widget definition from the start. This identifier is used within the page configuration and any further change can lead to incorrect configuration load. Consider specifying identifier in format 'CompanyName.ModuleName.WidgetName', e.g. 'Kentico.Content.ArticlesListWidget'. Use this attribute when simple widget is being developed and no custom controller is needed.