CanonicalCategories Property

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

Gets a collection containing the canonical categories for the current catalog item.

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

Syntax

'Declaration
Public ReadOnly Property CanonicalCategories As CategoryCollection
'Usage
Dim instance As CatalogItem
Dim value As CategoryCollection

value = instance.CanonicalCategories
public CategoryCollection CanonicalCategories { get; }
public:
property CategoryCollection^ CanonicalCategories {
    CategoryCollection^ get ();
}
public function get CanonicalCategories () : CategoryCollection

Property Value

Type: Microsoft.CommerceServer.Catalog..::.CategoryCollection
A CategoryCollection that contains the categories.

Remarks

The canonical path of any category is formed by looking up the Primary Parent of this catalog item, the primary parent of that category, and so on until the root of the hierarchy is reached. In case of parent ambiguity that arises when a category has multiple parent categories and none of them is a Primary parent, a random parent category will be chosen as the canonical parent. The multilingual information for the canonical categories will be in the current ActiveLanguage of the catalog item. The returned dataset will contain all one row for each canonical category for the catalog item. The dataset will contain all the properties in the catalog. You cannot make any changes to this dataset.

The returned collection contains the following properties:

Permissions

See Also

Reference

CatalogItem Class

CatalogItem Members

Microsoft.CommerceServer.Catalog Namespace