Category Class (BCL)

Represents a category in a ProductCatalog object.

System.Object
**** Microsoft.CommerceServer.Runtime.Catalog.Category

Protected Instance Constructor

Constructor Description
Constructor(ProductCatalog, String) Creates a new instance of the Category class representing a category of the specified ProductCatalog object.

 

Public Instance Methods

Method Description
Dispose Disposes of resources early.
GetCategoryProperties Returns properties for this category. Both the properties that are present in the definition of this category, and the built-in properties are returned.
GetChildCategories(CatalogSearchOptions, Boolean, Int32) Gets property data for the immediate child categories of this category using the searchOptions parameter to determine how the results are returned.
GetChildCategories(CatalogSearchOptions, Boolean) Gets property data for the immediate child categories of this category using the searchOptions parameter to determine how the results are returned.
GetChildCategories(CatalogSearchOptions) Gets property data for the immediate child categories of this category using the searchOptions parameter to determine how the results are returned.
GetChildCategories Gets property data for the immediate child categories of this category using the searchOptions parameter to determine how the results are returned.
GetProducts(CatalogSearchOptions, Boolean, Int32) Gets the properties for the products in this category using the searchOptions parameter to determine how the results are returned.
GetProducts(CatalogSearchOptions, Boolean) Gets the properties for the products in this category using the searchOptions parameter to determine how the results are returned.
GetProducts(CatalogSearchOptions) Gets the properties for the products in this category using the searchOptions parameter to determine how the results are returned.
GetProducts Gets the properties for the products in this category.
GetRelatedCategories Gets the category relationships for this category.
GetRelatedProducts Gets the product relationships for this category.

 

Public Instance Properties

Property Description
AncestorCategoryNames Gets the names of all categories that are above this category in the category hierarchy.
CanonicalCategoryPath Gets the names of the categories that form a canonical path to this category. The first element in the array is a child of the root category. The canonical path of any category 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 a category does not have a primary parent category, then an arbitrary parent is chosen as the parent. 
CatalogContext Gets the CatalogContext object that was used to create the ProductCatalog object for the catalog that contains this category.
ChildCategoriesCount Gets the number of categories that are immediate children of this category.
ChildCategoryNames Gets the names of the categories that are immediate children of this category.
ChildProductsCount Gets the number of products that are immediate children of this category.
DebugContext Gets the DebugContext object for the CatalogContext object that was used to create the ProductCatalog object for the catalog that contains this category.
Name Gets the name of the category.
ParentCategoryNames Gets the names of the categories that are immediate parents of this category in the category hierarchy.
PrimaryParentCategoryName Gets the name of the primary parent category of this category.
ProductCatalog Gets the ProductCatalog object for the catalog that contains this category.

 

Protected Instance Methods

Method Description
CheckState Verifies that the object has not already been disposed.
Dispose(Boolean) Releases the unmanaged resources used by this class and optionally releases the managed resources.

 

Remarks

There is no public constructor of Category objects.

A Category object should be referenced only on the page in which it was created.

Requirements

Namespace: Microsoft.CommerceServer.Runtime.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: Microsoft.CommerceServer.Runtime.dll

Copyright © 2005 Microsoft Corporation.
All rights reserved.