Export (0) Print
Expand All

XmlSiteMapProvider Members

The XmlSiteMapProvider class is derived from the SiteMapProvider class and is the default site map provider for ASP.NET. The XmlSiteMapProvider class generates site map trees from XML files with the file name extension .sitemap.

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

  Name Description
Public method XmlSiteMapProvider Creates a new, unnamed, instance of the XmlSiteMapProvider 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 Overridden. Gets the root node of the site map.
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 Overridden. Loads the site map information from an XML file and builds it in memory.
Public method Dispose Overloaded. Notifies the file monitor of the Web.sitemap file that the XmlSiteMapProvider object no longer requires the file to be monitored.
Public method Equals  Overloaded. Determines whether two Object instances are equal. (inherited from Object)
Public method FindSiteMapNode Overloaded. Retrieves a site map node based on a search criterion.
Public method FindSiteMapNodeFromKey Overridden. Retrieves a SiteMapNode object based on a specified key.
Public method GetChildNodes  Retrieves the child site map nodes of a specific SiteMapNode object. (inherited from StaticSiteMapProvider)
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  Retrieves the parent site map node of a specific SiteMapNode object. (inherited from StaticSiteMapProvider)
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 Overridden. Initializes the XmlSiteMapProvider object. The Initialize method does not actually build a site map, it only prepares the state of the XmlSiteMapProvider to do so.
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 SiteMapNode object to the collections that are maintained by the current provider.
Protected method AddProvider Links a child site map provider to the current provider.
Protected method Clear Overridden. Removes all elements in the collections of child and parent site map nodes and site map providers that the XmlSiteMapProvider object internally tracks as part of its state.
Protected method Dispose Overloaded. Notifies the file monitor of the Web.sitemap file that the XmlSiteMapProvider object no longer requires the file to be monitored.
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 Overridden. Retrieves the top-level node of the current site map data structure.
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 node collections that are tracked by the provider.
Protected method RemoveProvider Removes a linked child site map provider from the hierarchy for the current 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

Community Additions

ADD
Show:
© 2014 Microsoft