TreeSiteMapProvider Members

Kentico 8.1 API Reference

The TreeSiteMapProvider type exposes the following members.

Constructors

	Name	Description
	TreeSiteMapProvider

Methods

	Name	Description
	AddNode(SiteMapNode)	Adds a SiteMapNode object to the node collection that is maintained by the site map provider. (Inherited from SiteMapProvider.)
	AddNode(SiteMapNode, SiteMapNode)	Adds a SiteMapNode to the collections that are maintained by the site map provider and establishes a parent/child relationship between the SiteMapNode objects. (Inherited from StaticSiteMapProvider.)
	BuildSiteMap	Performs the sitemap build. (Overrides StaticSiteMapProvider BuildSiteMap .)
	Clear	Clean up any collections or other state that an instance of this may hold. (Overrides StaticSiteMapProvider Clear .)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindSiteMapNode(String)	Retrieves a SiteMapNode object that represents the page at the specified URL. (Inherited from StaticSiteMapProvider.)
	FindSiteMapNode(HttpContext)	Retrieves a SiteMapNode object that represents the currently requested page using the specified HttpContext object. (Inherited from SiteMapProvider.)
	FindSiteMapNodeFromKey	Retrieves a SiteMapNode object based on a specified key. (Inherited from StaticSiteMapProvider.)
	GetCurrentNodeAndHintAncestorNodes	Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the parent and ancestor site map nodes for the current page. (Inherited from SiteMapProvider.)
	GetCurrentNodeAndHintNeighborhoodNodes	Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the site map nodes in the proximity of the current node. (Inherited from SiteMapProvider.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetChildNodes(SiteMapNode)	Retrieves the child site map nodes of a specific SiteMapNode object. (Inherited from StaticSiteMapProvider.)
	GetChildNodes(Int32)	Returns the set of child nodes for the specified node.
	GetChildNodes(Int32, Int32)	Returns the set of child nodes for the specified node.
	GetNodeByAliasPath	Returns the node by its Alias.
	GetNodeById	Returns the node specified by given Node ID.
	GetParentNode	Retrieves the parent site map node of a specific SiteMapNode object. (Inherited from StaticSiteMapProvider.)
	GetParentNodeRelativeToCurrentNodeAndHintDownFromParent	Provides an optimized lookup method for site map providers when retrieving an ancestor node for the currently requested page and fetching the descendant nodes for the ancestor. (Inherited from SiteMapProvider.)
	GetParentNodeRelativeToNodeAndHintDownFromParent	Provides an optimized lookup method for site map providers when retrieving an ancestor node for the specified SiteMapNode object and fetching its child nodes. (Inherited from SiteMapProvider.)
	GetRootNodeCore	Returns the the root sitemap node. (Overrides SiteMapProvider GetRootNodeCore .)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HintAncestorNodes	Provides a method that site map providers can override to perform an optimized retrieval of one or more levels of parent and ancestor nodes, relative to the specified SiteMapNode object. (Inherited from SiteMapProvider.)
	HintNeighborhoodNodes	Provides a method that site map providers can override to perform an optimized retrieval of nodes found in the proximity of the specified node. (Inherited from SiteMapProvider.)
	Initialize	Initializes the SiteMapProvider implementation, including any resources that are needed to load site map data from persistent storage. (Inherited from SiteMapProvider.)
	IsAccessibleToUser	Retrieves a Boolean value indicating whether the specified SiteMapNode object can be viewed by the user in the specified context. (Inherited from SiteMapProvider.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReloadData	Reloads the tree data.
	RemoveNode	Removes the specified SiteMapNode object from all site map node collections that are tracked by the site map provider. (Inherited from StaticSiteMapProvider.)
	ResolveSiteMapNode	Raises the SiteMapResolve event. (Inherited from SiteMapProvider.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

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

Fields

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

Properties

	Name	Description
	AlternativePath	Property to set and get the alternative path.
	BindNodeData	Specifies if the node data (TreeNode) should be bound to the nodes.
	ClassNames	Property to set and get the classnames list (separated by the semicolon).
	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag.
	CultureCode	Property to set and get the CultureCode.
	CurrentNode	Gets the SiteMapNode object that represents the currently requested page. (Inherited from SiteMapProvider.)
	Description	Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs). (Inherited from ProviderBase.)
	EnableLocalization	Gets or sets a Boolean value indicating whether localized values of SiteMapNode attributes are returned. (Inherited from SiteMapProvider.)
	CheckPermissions	Indicates if the permissions should be checked.
	MaxRelativeLevel	Property to set and get the MaxRelativeLevel.
	MaxTreeNodes	Maximum number of tree nodes displayed within the tree.
	Name	Gets the friendly name used to refer to the provider during configuration. (Inherited from ProviderBase.)
	OrderBy	Property to set and get the OrderBy.
	ParentProvider	Gets or sets the parent SiteMapProvider object of the current provider. (Inherited from SiteMapProvider.)
	Path	Property to set and get the Path.
	ResourceKey	Get or sets the resource key that is used for localizing SiteMapNode attributes. (Inherited from SiteMapProvider.)
	RootNode	Property to get Sitemap root node. (Overrides SiteMapProvider RootNode.)
	RootNodeLevel	Root node level.
	RootProvider	Gets the root SiteMapProvider object in the current provider hierarchy. (Inherited from SiteMapProvider.)
	SecurityTrimmingEnabled	Gets a Boolean value indicating whether a site map provider filters site map nodes based on a user's role. (Inherited from SiteMapProvider.)
	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag.
	SelectPublishedData	If true, the published data.
	SiteName	Property to set and get the SiteName.
	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
	UsedPath	Used alias path.
	WhereCondition	Property to set and get the WhereCondition.

Events

	Name	Description
	SiteMapResolve	Occurs when the CurrentNode property is called. (Inherited from SiteMapProvider.)