System.Web.SiteMapProvider Members

The members of System.Web.SiteMapProvider are listed below.

See Also: Inherited members from System.Configuration.Provider.ProviderBase

Protected Constructors

Initializes a new instance of the System.Web.SiteMapProvider class.

Public Properties

[read-only]
CurrentNodeSiteMapNode.

Gets the System.Web.SiteMapNode object that represents the currently requested page.

EnableLocalizationbool.

Gets or sets a Boolean value indicating whether localized values of System.Web.SiteMapNode attributes are returned.

ParentProviderSiteMapProvider.

Gets or sets the parent System.Web.SiteMapProvider object of the current provider.

ResourceKeystring.

Get or sets the resource key that is used for localizing System.Web.SiteMapNode attributes.

[read-only]
RootNodeSiteMapNode.

Gets the root System.Web.SiteMapNode object of the site map data that the current provider represents.

[read-only]
RootProviderSiteMapProvider.

Gets the root System.Web.SiteMapProvider object in the current provider hierarchy.

[read-only]
SecurityTrimmingEnabledbool.

Gets a Boolean value indicating whether a site map provider filters site map nodes based on a user's role.

Public Methods

abstract
FindSiteMapNode(string) : SiteMapNode

When overridden in a derived class, retrieves a System.Web.SiteMapNode object that represents the page at the specified URL.

FindSiteMapNode(HttpContext) : SiteMapNode

Retrieves a System.Web.SiteMapNode object that represents the currently requested page using the specified System.Web.HttpContext object.

FindSiteMapNodeFromKey(string) : SiteMapNode

Retrieves a System.Web.SiteMapNode object based on a specified key.

abstract
GetChildNodes(SiteMapNode) : SiteMapNodeCollection

When overridden in a derived class, retrieves the child nodes of a specific System.Web.SiteMapNode.

GetCurrentNodeAndHintAncestorNodes(int) : SiteMapNode

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.

GetCurrentNodeAndHintNeighborhoodNodes(int, int) : SiteMapNode

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.

abstract
GetParentNode(SiteMapNode) : SiteMapNode

When overridden in a derived class, retrieves the parent node of a specific System.Web.SiteMapNode object.

GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(int, int) : SiteMapNode

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.

GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, int, int) : SiteMapNode

Provides an optimized lookup method for site map providers when retrieving an ancestor node for the specified System.Web.SiteMapNode object and fetching its child nodes.

HintAncestorNodes(SiteMapNode, int)

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 System.Web.SiteMapNode object.

HintNeighborhoodNodes(SiteMapNode, int, int)

Provides a method that site map providers can override to perform an optimized retrieval of nodes found in the proximity of the specified node.

override
Initialize(string, System.Collections.Specialized.NameValueCollection)

Initializes the System.Web.SiteMapProvider implementation, including any resources that are needed to load site map data from persistent storage.

IsAccessibleToUser(HttpContext, SiteMapNode) : bool

Retrieves a Boolean value indicating whether the specified System.Web.SiteMapNode object can be viewed by the user in the specified context.

Protected Methods

AddNode(SiteMapNode)

Adds a System.Web.SiteMapNode object to the node collection that is maintained by the site map provider.

AddNode(SiteMapNode, SiteMapNode)

Adds a System.Web.SiteMapNode object to the node collection that is maintained by the site map provider and specifies the parent System.Web.SiteMapNode object.

abstract
GetRootNodeCore() : SiteMapNode

When overridden in a derived class, retrieves the root node of all the nodes that are currently managed by the current provider.

static
GetRootNodeCoreFromProvider(SiteMapProvider) : SiteMapNode

Retrieves the root node of all the nodes that are currently managed by the specified site map provider.

RemoveNode(SiteMapNode)

Removes the specified System.Web.SiteMapNode object from the node collection that is maintained by the site map provider.

ResolveSiteMapNode(HttpContext) : SiteMapNode

Raises the SiteMapProvider.SiteMapResolve event.

Public Events

SiteMapResolve

Occurs when the SiteMapProvider.CurrentNode property is called.