Class CatalogSiteMapProvider
StoreSiteMapProvider implements SiteMapProvider class and communicates with backend web services to return catalog structure.
Inheritance
Namespace: Mediachase.Commerce.Website
Assembly: Mediachase.Commerce.Website.dll
Version: 10.8.0Syntax
[Obsolete("This class should no longer be used. Will remain at least until April 2016.")]
public class CatalogSiteMapProvider : SiteMapProviderConstructors
CatalogSiteMapProvider()
Initializes a new instance of the StoreSiteMapProvider class.
Declaration
public CatalogSiteMapProvider()Properties
CatalogName
Gets or sets the name of the catalog.
Declaration
public string CatalogName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the catalog. |
RootNode
Gets the root System.Web.SiteMapNode object of the site map data that the current provider represents.
Declaration
public override SiteMapNode RootNode { get; }Property Value
| Type | Description |
|---|---|
| System.Web.SiteMapNode |
Methods
FindSiteMapNode(String)
When overridden in a derived class, retrieves a System.Web.SiteMapNode object that represents the page at the specified URL.
Declaration
public override SiteMapNode FindSiteMapNode(string rawUrl)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | rawUrl | A URL that identifies the page for which to retrieve a System.Web.SiteMapNode. |
Returns
| Type | Description |
|---|---|
| System.Web.SiteMapNode | A System.Web.SiteMapNode that represents the page identified by rawURL; otherwise, null, if no corresponding System.Web.SiteMapNode is found or if security trimming is enabled and the System.Web.SiteMapNode cannot be returned for the current user. |
GetChildNodes(SiteMapNode)
When overridden in a derived class, retrieves the child nodes of a specific System.Web.SiteMapNode.
Declaration
public override SiteMapNodeCollection GetChildNodes(SiteMapNode node)Parameters
| Type | Name | Description |
|---|---|---|
| System.Web.SiteMapNode | node | The System.Web.SiteMapNode for which to retrieve all child nodes. |
Returns
| Type | Description |
|---|---|
| System.Web.SiteMapNodeCollection | A read-only System.Web.SiteMapNodeCollection that contains the immediate child nodes of the specified System.Web.SiteMapNode; otherwise, null or an empty collection, if no child nodes exist. |
GetParentNode(SiteMapNode)
When overridden in a derived class, retrieves the parent node of a specific System.Web.SiteMapNode object.
Declaration
public override SiteMapNode GetParentNode(SiteMapNode catalogNode)Parameters
| Type | Name | Description |
|---|---|---|
| System.Web.SiteMapNode | catalogNode | The System.Web.SiteMapNode for which to retrieve the parent node. |
Returns
| Type | Description |
|---|---|
| System.Web.SiteMapNode | A System.Web.SiteMapNode that represents the parent of node; otherwise, null, if the System.Web.SiteMapNode has no parent or security trimming is enabled and the parent node is not accessible to the current user. |
GetRootNodeCore()
When overidden in a derived class, retrieves the root node of all the nodes that are currently managed by the current provider.
Declaration
protected override SiteMapNode GetRootNodeCore()Returns
| Type | Description |
|---|---|
| System.Web.SiteMapNode | A System.Web.SiteMapNode that represents the root node of the set of nodes that the current provider manages. |
