CanonicalCategoryPath Property

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Gets the CanonicalCategoryPath property that gets the names of the categories that for a canonical path to this category.

Namespace:  Microsoft.CommerceServer.Catalog
Assembly:  Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)

Syntax

'Declaration
Public ReadOnly Property CanonicalCategoryPath As ReadOnlyStringCollection
'Usage
Dim instance As CatalogItem
Dim value As ReadOnlyStringCollection

value = instance.CanonicalCategoryPath
public ReadOnlyStringCollection CanonicalCategoryPath { get; }
public:
property ReadOnlyStringCollection^ CanonicalCategoryPath {
    ReadOnlyStringCollection^ get ();
}
public function get CanonicalCategoryPath () : ReadOnlyStringCollection

Property Value

Type: Microsoft.CommerceServer.Runtime..::.ReadOnlyStringCollection
A ReadOnlyStringCollection that contains the categories.

Remarks

The first element in the array is a child of the root category. The canonical path of any CatalogItem is formed by looking up the primary parent of this category, the primary parent of that category, and so on until the root of the hierarchy is reached. If the category does not have a primary parent category, then an arbitrary parent is chosen as the parent. If this category is a root category, the retuned array is empty.

This list is cached. Call the Refresh method to explicitly refresh this cached data.

Permissions

See Also

Reference

CatalogItem Class

CatalogItem Members

Microsoft.CommerceServer.Catalog Namespace