Register a new widget in Sitefinity CMS toolbox

To use newly created widgets on a Sitefinity CMS page, you must register them in the toolbox. Once you do this, the widgets are available for drag-and-drop in the page editor user interface.

There are several ways you can register a widget. All of them require a ControlType parameter. The value of this parameter depends on the type of widget used.

  • When registering a custom widget, built into an assembly, the parameter is the fully qualified type name of the widget.
  • When registering a user widget, the parameter is the virtual URL of the user widget.

Register a widget in Sitefinity CMS backend

You can register a widget through Sitefinity’s advanced settings UI or through Sitefinity’s configuration file. For more information, see Register a new widget in the backend.

Register a widget through code using the configuration manager

You may want to register your custom widget in the toolbox through the API, if, for example, the widget is part of a custom module and must be registered when the module is installed. 

To register a widget with Sitefinity CMS configuration manager, use the following code:

In the snippet above, to reflect your custom widget values, you must change the name of the section, the name of the widget, and the type of the widget.

Increase your Sitefinity skills by signing up for our free trainings. Get Sitefinity-certified at Progress Education Community to boost your credentials.

Get started with Integration Hub | Sitefinity Cloud | Sitefinity SaaS

This free lesson teaches administrators, marketers, and other business professionals how to use the Integration hub service to create automated workflows between Sitefinity and other business systems.

Web Security for Sitefinity Administrators

This free lesson teaches administrators the basics about protecting yor Sitefinity instance and its sites from external threats. Configure HTTPS, SSL, allow lists for trusted sites, and cookie security, among others.

Foundations of Sitefinity ASP.NET Core Development

The free on-demand video course teaches developers how to use Sitefinity .NET Core and leverage its decoupled architecture and new way of coding against the platform.

Was this article helpful?