Export (0) Print
Expand All

SiteMapProvider Members

Provides a common base class for all site map data providers, and a way for developers to implement custom site map data providers that can be used with the ASP.NET site map infrastructure as persistent stores for SiteMap objects.

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

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

  Name Description
Public property CurrentNode Gets the SiteMapNode object that represents the currently requested page.
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.
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.
Public property ResourceKey Get or sets the resource key that is used for localizing SiteMapNode attributes.
Public property RootNode Gets the root SiteMapNode object of the site map data that the current provider represents.
Public property RootProvider Gets the root SiteMapProvider object in the current provider hierarchy.
Public property SecurityTrimmingEnabled Gets a Boolean value indicating whether a site map provider filters site map nodes based on a user's role.
Top

(see also Protected Methods )
  Name Description
Public method Equals  Overloaded. Determines whether two Object instances are equal. (Inherited from Object.)
Public method FindSiteMapNode Overloaded. When overridden in a derived class, retrieves a SiteMapNode object that represents a page.
Public method FindSiteMapNodeFromKey Retrieves a SiteMapNode object based on a specified key.
Public method GetChildNodes When overridden in a derived class, retrieves the child nodes of a specific SiteMapNode.
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.
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.
Public method GetHashCode  Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.)
Public method GetParentNode When overridden in a derived class, retrieves the parent 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.
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.
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.
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.
Public method Initialize Overridden. Initializes the SiteMapProvider implementation, including any resources that are needed to load site map data from persistent storage.
Public method IsAccessibleToUser Retrieves a Boolean value indicating whether the specified SiteMapNode object can be viewed by the user in the specified context.
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 SiteMapNode object to the node collection that is maintained by the site map provider.
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 overidden in a derived class, retrieves the root node of all the nodes that are currently managed by the current provider.
Protected method Static GetRootNodeCoreFromProvider Retrieves the root node of all the nodes that are currently managed by the specified site map provider.
Protected method MemberwiseClone  Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method RemoveNode Removes the specified SiteMapNode object from the node collection that is maintained by the site map provider.
Protected method ResolveSiteMapNode Raises the SiteMapResolve event.
Top

  Name Description
Public event SiteMapResolve Occurs when the CurrentNode property is called.
Top

Community Additions

ADD
Show:
© 2014 Microsoft