TreeSiteMapProvider Class

Class providing tree site map management.

Inheritance Hierarchy

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

Namespace: CMS.CMSSiteMapProvider
Assembly: CMS.CMSSiteMapProvider (in CMS.CMSSiteMapProvider.dll) Version: 8.2.23

Syntax

public class TreeSiteMapProvider : StaticSiteMapProvider

The TreeSiteMapProvider type exposes the following members.

Constructors

	Name	Description
Public method	TreeSiteMapProvider

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.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mAlternativePath	Alternative path.
Protected field	mBindNodeData	Bind the node data to the nodes.
Protected field	mClassNames	Class names.
Protected field	mCombineWithDefaultCulture	Combine with default culture.
Protected field	mCultureCode	Culture code.
Protected field	mCheckPermissions	Indicates if the permissions should be checked.
Protected field	mMaxRelativeLevel	Maximum relative level.
Protected field	mMaxTreeNodes	Maximum number of the nodes in a level.
Protected field	mOrderBy	Order by.
Protected field	mPath	Path.
Protected field	mRootNodeLevel	Root node level.
Protected field	mSelectOnlyPublished	Select only published.
Protected field	mSelectPublishedData	Select the published data.
Protected field	mSiteName	Site name.
Protected field	mTreeProvider	Tree provider.
Protected field	mUsedPath	Used path.
Protected field	mWhereCondition	Where condition.

Properties

	Name	Description
Public property	AlternativePath	Property to set and get the alternative path.
Public property	BindNodeData	Specifies if the node data (TreeNode) should be bound to the nodes.
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	CheckPermissions	Indicates if the permissions should be checked.
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	UsedPath	Used alias path.
Public property	WhereCondition	Property to set and get the WhereCondition.