General tab

General tab

General tab

On the General tab, you can specify the following properties of the web part:

Display name

The name of the web part displayed to users in the administration interface (e.g. in the web part toolbar or selection dialog).

Code name

This name serves as a unique identifier for the web part (e.g. in the API).

Category

The category in the web part catalog where the web part will be placed.

Type

Sets the type of the web part, which affects its behavior and properties. Different web part types are also marked with different colors and icons on the Design tab of CMS Desk. The following web part types are available:

•Standard - typical web parts displaying some content.

•Data source - do not display any content, only provide data to be displayed by a connected web part.

•Filter - can be connected to a data source and enable users to limit the data provided by it.

•Placeholder - used for the General -> Layout -> Page placeholder web part; specifies the area where the content of sub-pages should be displayed.

•Invisible - are not displayed on the page at all and usually perform some type of background task.

•Layout - these web parts can be used to generate a specific layout for page content by defining additional web part zones. For more information, please see the Development -> Web parts -> Layout web parts chapter in the Kentico CMS Developer's Guide.

•Widget only - these web parts are only intended to serve as base templates for widgets and are not available in the web part selection dialog on the Design tab of CMS Desk. Please keep in mind that changing a web part that is already on some page template to this type will not remove it or prevent it from functioning.

•Wireframe - special type of web parts used when defining wireframe schematics for pages. They are only for internal purposes and are not displayed on the live site. Wireframes can be created for pages on the Wireframe tab in the Edit mode of CMS Desk, either for dedicated wireframe documents or other document types that contain a wireframe definition.

File name

Contains the relative path to the user control that implements the web part. The path starts from the CMSWebParts folder. For example: AbuseReport/AbuseReport.ascx

It is recommended to organize web part source files on the file system in a way that matches the web part category structure.

Description

Text describing the web part, which will be displayed in the web part catalog and as a tooltip in the web part toolbar.

Thumbnail

Specifies an image that will represent the web part in the selection catalog and web part toolbar.

When a file is uploaded in the field, two icons are displayed next to it:

•Edit () - if the file is an image, clicking the icon opens it in the built-in image editor. If the file is not an image (which would not make sense as no thumbnail could be displayed), the metadata editor is opened after clicking the icon.

•Delete () - removes the file from the field.

Skip initial configuration

If checked, new instances of this web part will be placed directly onto the page without opening the property configuration dialog. This can be convenient, particularly in the case of web parts that are typically used with their default property values.