This documentation is archived and is not being maintained.

StaticSiteMapProvider Members

Serves as a partial implementation of the abstract SiteMapProvider class and serves as a base class for the XmlSiteMapProvider class, which is the default site map provider in ASP.NET.

The following tables list the members exposed by the StaticSiteMapProvider type.

  Name Description
Protected method StaticSiteMapProvider Initializes a new instance of the StaticSiteMapProvider class.
Top

  Name Description
Public property CurrentNode  Gets the SiteMapNode object that represents the currently requested page.(inherited from SiteMapProvider)
Public property Description  Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).(inherited from ProviderBase)
Public property EnableLocalization  Gets or sets a Boolean value indicating whether localized values of SiteMapNode attributes are returned.(inherited from SiteMapProvider)
Public property Name  Gets the friendly name used to refer to the provider during configuration.(inherited from ProviderBase)
Public property ParentProvider  Gets or sets the parent SiteMapProvider object of the current provider.(inherited from SiteMapProvider)
Public property ResourceKey  Get or sets the resource key that is used for localizing SiteMapNode attributes. (inherited from SiteMapProvider)
Public property RootNode  Gets the root SiteMapNode object of the site map data that the current provider represents.(inherited from SiteMapProvider)
Public property RootProvider  Gets the root SiteMapProvider object in the current provider hierarchy.(inherited from SiteMapProvider)
Public property SecurityTrimmingEnabled  Gets a Boolean value indicating whether a site map provider filters site map nodes based on a user's role.(inherited from SiteMapProvider)
Top

(see also Protected Methods )
  Name Description
Public method BuildSiteMap When overridden in a derived class, loads the site map information from persistent storage and builds it in memory.
Public method Equals  Overloaded. Determines whether two Object instances are equal. (inherited from Object)
Public method FindSiteMapNode Overloaded. Retrieves a SiteMapNode object that represents a page.
Public method FindSiteMapNodeFromKey Overridden. Retrieves a SiteMapNode object based on a specified key.
Public method GetChildNodes Overridden. Retrieves the child site map nodes of a specific SiteMapNode object.
Public method 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)
Public method 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)
Public method GetHashCode  Serves as a hash function for a particular type. (inherited from Object)
Public method GetParentNode Overridden. Retrieves the parent site map node of a specific SiteMapNode object.
Public method 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)
Public method 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)
Public method GetType  Gets the Type of the current instance. (inherited from Object)
Public method 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)
Public method 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)
Public method Initialize  Initializes the SiteMapProvider implementation, including any resources that are needed to load site map data from persistent storage. (inherited from SiteMapProvider)
Public method IsAccessibleToUser  Retrieves a Boolean value indicating whether the specified SiteMapNode object can be viewed by the user in the specified context. (inherited from SiteMapProvider)
Public method Static ReferenceEquals  Determines whether the specified Object instances are the same instance. (inherited from Object)
Public method ToString  Returns a String that represents the current Object. (inherited from Object)
Top

  Name Description
Protected method AddNode Overloaded. Adds a site map node to the collections that are maintained by the current StaticSiteMapProvider object.
Protected method Clear Removes all elements in the collections of child and parent site map nodes that the StaticSiteMapProvider tracks as part of its state.
Protected method Finalize  Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object)
Protected method GetRootNodeCore  When overridden in a derived class, retrieves the root node of all the nodes that are currently managed by the current provider. (inherited from SiteMapProvider)
Protected method Static GetRootNodeCoreFromProvider  Retrieves the root node of all the nodes that are currently managed by the specified site map provider. (inherited from SiteMapProvider)
Protected method MemberwiseClone  Creates a shallow copy of the current Object. (inherited from Object)
Protected method RemoveNode Overridden. Removes the specified SiteMapNode object from all site map node collections that are tracked by the site map provider.
Protected method ResolveSiteMapNode  Raises the SiteMapResolve event. (inherited from SiteMapProvider)
Top

  Name Description
Public event SiteMapResolve  Occurs when the CurrentNode property is called. (inherited from SiteMapProvider)
Top
Show: