Web part internals and API

Database tables

Database tableDescription
CMS_WebPartCategory

Stores records representing web part categories.

CMS_WebPartStores records representing web parts, their configuration, and properties.
CMS_WebPartLayoutStores custom layouts for web parts.
CMS_WebPartContainerStores records representing web part containers.
CMS_WebPartContainerSiteStores relationships between web part containers and sites. Each entry indicates that a specific container can be used on a given site.

Web part instance storage

Web part zones, web part instances, and their configuration are part of the content of page templates. The system stores the data in XML format inside the PageTemplateWebParts column of the CMS_PageTemplate table.

API classes

ClassNamespaceDescription
CMS_WebPartCategory table API
WebPartCategoryInfoCMS.PortalEngineRepresents web part categories.
WebPartCategoryInfoProviderProvides management functionality for web part categories.
CMS_WebPart table API
WebPartInfoCMS.PortalEngineRepresents individual web part objects.
WebPartInfoProviderProvides management functionality for web part objects.
CMS_WebPartLayout table API
WebPartLayoutInfoCMS.PortalEngineRepresents custom web part layouts.
WebPartLayoutInfoProviderProvides management functionality for web part layouts.
CMS_WebPartContainer table API
WebPartContainerInfoCMS.PortalEngine

Represents web part containers.

WebPartContainerInfoProviderProvides management functionality for web part containers.
CMS_WebPartContainerSite table API
WebPartContainerSiteInfoCMS.PortalEngineRepresents relationships between web part containers and sites.
WebPartContainerSiteInfoProviderProvides management functionality for container-site relationships.
Other classes
WebPartInstanceCMS.PortalEngineAllows you to work with web part instances.
WebPartZoneInstanceAllows you to work with web part zones.

Was this page helpful?