CMSPageManager

 

 

Please note:

 

This control is compatible only with ASPX page templates, do not use it on Portal engine templates. For portal pages, use Editable text and editable image web parts instead of CMSEditableRegion and CMSEditableImage controls.

 

The CMSPageManager control is used for pages with editable regions. It ensures loading and saving content to the database. It also displays the "Save" dialog. CMSPageManager manages the flow of data to/from CMSEditableRegions.

 

Data Source

 

Content is loaded from the nearest Page (menu item) document in the alias path specified through URL or through the DefaultPageAliasPath property. The content is stored in the following format:

 

<content>

<region id=ID of the CMSEditableRegion control related to this content section>

<!CDATA[ content of the editable region ]>

</region>

<region id=...>

<!CDATA[ content of the editable region ]>

</region>

</content>

 

Properties

 

Property Name

Description

Sample Value

CacheItemName

Name of the cache item the control will use. By setting this name dynamically, you can achieve caching based on URL parameter or some other variable - simply put the value of the parameter to the CacheItemName property. If no value is set, the control stores its content to the item named "URL|ControlID".

"homepage_pagemanager"

CacheMinutes

Number of minutes the retrieved content is cached for.

 

Zero indicates that the content will not be cached.

-1 indicates the site-level settings should be used.

 

This parameter allows you to set up caching of content so that it's not retrieved from the database each time a user requests the page.

10

CheckPermissionsForUserID

Allows you to specify the UserID of the current user. If the value is 0 (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission are displayed.

126

CmsDeskPath

CMS Desk virtual path.

If no value is provided, it's read from CMSDeskVirtualPath web.config parameter or it uses default value "~/cmsdesk".

"~/cmsdesk"

CombineWithDefaultCulture

Indicates if the results should be combined with default language versions in case the translated version is not available. This property is applied only if you do not set TreeProvider property manually.

False

CurrentPageAliasPath

Alias path that is used for retrieving editable regions content.

"/products/category1"

DefaultPageAliasPath

Default path that is used if no alias path is provided in the query string or through friendly URL.

"/home"

IsEditable

Indicates if the page is in editable mode. (read only)

true

PreferredCultureCode

Code of the preferred culture (en-us, fr-fr, etc.). If it's not specified, it is read from the CMSPreferredCulture session variable and then from the CMSDefaultCultureCode configuration key.

"en-us"

TreeProvider

Tree provider instance. If it's not provided, it's created automatically.


 

CSS Styles

 

Class Name

Description

CMSPageManagerError

Style of the error label.

CMSPageManagerLabel

Style of the standard label.

CMSPageManagerTextLink

Style of the link.

CMSPageManagerTDLabel

Style of the TD element that contains text with save confirmation message.