TreeSiteMapProvider Class

Class providing tree site map management.

Inheritance Hierarchy

System.Object
  System.Configuration.Provider.ProviderBase
    System.Web.SiteMapProvider
      System.Web.StaticSiteMapProvider
        CMS.DocumentEngine.TreeSiteMapProvider

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 12.0.0

Syntax

public class TreeSiteMapProvider : StaticSiteMapProvider

The TreeSiteMapProvider type exposes the following members.

Constructors

	Name	Description
Public method	TreeSiteMapProvider

Properties

	Name	Description
Public property	BindNodeData	Specifies if the node data (TreeNode) should be bound to the nodes.
Public property	CheckPermissions	Indicates if the permissions should be checked.
Public property	ClassNames	Property to set and get the classnames list (separated by the semicolon).
Public property	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag.
Public property	CultureCode	Property to set and get the CultureCode.
Public property	MaxRelativeLevel	Property to set and get the MaxRelativeLevel.
Public property	MaxTreeNodes	Maximum number of tree nodes displayed within the tree.
Public property	OrderBy	Property to set and get the OrderBy.
Public property	Path	Property to set and get the Path.
Public property	RootNode	Property to get Sitemap root node. (Overrides SiteMapProvider.RootNode.)
Public property	RootNodeLevel	Root node level.
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag.
Public property	SelectPublishedData	If true, the published data.
Public property	SiteName	Property to set and get the SiteName.
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public property	WhereCondition	Property to set and get the WhereCondition.

Methods

	Name	Description
Public method	BuildSiteMap	Performs the sitemap build. (Overrides StaticSiteMapProvider.BuildSiteMap().)
Protected method	Clear	Clean up any collections or other state that an instance of this may hold. (Overrides StaticSiteMapProvider.Clear().)
Public method	GetChildNodes(Int32)	Returns the set of child nodes for the specified node.
Public method	GetChildNodes(Int32, Int32)	Returns the set of child nodes for the specified node.
Public method	GetNodeByAliasPath	Returns the node by its Alias.
Public method	GetNodeById	Returns the node specified by given Node ID.
Protected method	GetRootNodeCore	Returns the the root sitemap node. (Overrides SiteMapProvider.GetRootNodeCore().)
Public method	ReloadData	Reloads the tree data.