Property Name

Description

Sample Value

CacheDependencies

List of the cache keys on which the cached data depends. When the cache item changes, the cache of the control is cleared. Each item (dependency) must be on one line.

If you leave this property empty, default dependencies will be used.

cms.user|all

CacheItemName

Name of the cache item the control will use.

By setting this name dynamically, you can achieve caching based on a URL parameter or some other variable - simply enter the value of the parameter.

If no value is set, the control stores its content in 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 that the site-level settings should be used.

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

CheckPermissions

Allows you to specify whether to check permissions of the current user. If the value is 'false' (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission can be selected.

CMSEditableControls

Returns an array containing the managed editable controls (CMSEditableImage or CMSEditableRegion).

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 the TreeProvider property manually.

CultureCode

Culture code of documents to be selected, such as en-us. If not specified, it's read from the user's session or the default value is used.

"en-us"

DefaultPageAliasPath

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

"/home"

ErrorMessage

Gets or sets the error message string.

InfoMessage

Gets or sets the information message string.

IsAuthorized

Is true if the current user is authorized for the current document.

PageAliasPath

The alias path of the current page.

PreserveContent

Allows you to specify whether the content of non-existing or not visible regions should be preserved when the content is saved.

SaveChanges

Is true if the current changes to the page should be saved.

SiteName

Specifies the site code name.

TagKey

Overrides the generation of the SPAN tag with a custom tag.

TreeProvider

Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created automatically.

ViewMode

Gets or sets the current page mode.

"Edit"

"Preview"

"LiveSite"