The CatalogCategoryListControl displays a listing of sibling Categories and the number of Items within each, inclusive of all Sub Categories. It only displays Categories or Sub Categories that contain one or more Items.

The control displays only approved Categories for the current shopper's View List. In a Category listing page, it displays the children of the current Category.

An example of the CatalogCategoryListControl in use is below:

By changing the values of the control's properties in the SitePages.config file for your Site, you can enable or disable certain behaviors, set certain defaults, alter aspects of the display or otherwise cusomtize your site's implementaion of the control.

The following describes properties pertaining to key functional areas of the control that can be configured to suit your needs.

General Properties

Using the OverrideCategory_ID property it is possible to limit the control to a single Category by inputting that Category's ID. Similarily, the RepeatDirection property is used to specify whether the sub category displays a photo. While editing the PhotoWidth property changes the width of the photo.

Category Properties

The ShowTopLevelCategories gets or sets a value indicating whether the top level categories are shown. While the ShowOnlyCategorieswithPhotos displays a value indicating whether the only categories shown are those with photos. By changing the ShowCategoryItemCount value to "true" the category item count is shown. In regard to child categories the ShowAllChildCategories property sets a value indicating whether all child categories is shown. Likewise, the ShowChildCategoryList sets a value indicating whether the child category list is shown.

Photo Properties

By changing the SubCategoryShowPhoto propety you can set a value indicating whether the sub category photos are shown. Furthermore, you can change the SubCategoryPhotoWidth to customize the width of the sub category photo.

Properties Inherited from the Base ListingControl

The properties contained in the ListingControl base class are available to either include or exclude certain data from the scope of Items being listed in the control.

To expand the scope of Items to be inclusive of all Items in the current Category and all of its child hierarchy, set the IncludeItemsFromAllChildCategories property to true, or conversely to limit scope just to the current Category, set its value to false.

Scope can also be limited, or expanded, based on the type of Item in the listing. Use the IncludeModels, IncludeSKUs, and IncludeStockCodes properties to do this. Set them to true to include, and false to exclude.

The ShowOnStockCodeDetailPage, ShowOnModelDetailPage and ShowonSKUDetailPage properties can each be used to selectively hide or show the control when on it is found on an item page based on the type of item.

The OverrideCategoryList property allows for the ListingControl to ignore the current Category in context and use a specified list of Categories as specified by a comma-separated list of Category_ID values. For example "1,5,7,124,678".

Properties Inherited from the Base CyberStoreBaseControl

Properties specific to the CyberStoreBaseControl can be listed in the following categories:

• Override Properties
• Contextual Properties

Override Properties

When the IgnoreControl property is set to true, all processing of a control is skipped, and the control's Visible property is set to false ensuring that it is not rendered in the resulting CyberStore page.

Contextual Properties

Contextual properties define specific details about the current instance of the control based on context. Context can be set by any number of factors including the log in state of the Shopper, the Site being visited, or the properties that have been established for a control.

The AttributesBag property is used internal to control processing and is the collection of attributes, or properties, and their values based on how the control is configured. The attributes in this property are set by processing the SitePages.config file as well as any specific declared property values in any registered sub controls. It allows for the passing down of all properties to a control and any registered sub controls.

The ComConfig, UserData and Site_ID properties are read-only values made available to all CyberStore controls to aid in processing and establishing context about the Site and Shopper.

The following is the markup for this control.

<%@ Control AutoEventWireup="true" CodeBehind="CatalogCategoryListControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogCategoryListControl" Language="C#" %>
<%@ Import Namespace="Dovetail.Ecommerce.Base.Module" %>
<asp:Repeater ID="rptCategory" EnableViewState="false" runat="server">
    <HeaderTemplate>
        <table border="0" class="ListCategoryTable">
            <tr>
                <td>
                    <p class="ListCategoryHeader">
                        <%# CurrentCatHeadline%></p>
                    <img runat="server" id="CatalogImage" class="ListCategoryPhoto" />
                    <p class="ListCategoryHeaderDescription">
                        <%# CurrentCatDescription%></p>
                </td>
            </tr>
        </table>
        <div border="0" class="ListCategoryTable" style="display:block;">
    </HeaderTemplate>
    <ItemTemplate>
        <asp:PlaceHolder ID="subCategoryVertical" runat="server" Visible="<%# verticalVisible %>">
            <table>
            <tr>
                <td class="ListCategoryName">
                    <%# "<a class=\"ListCategoryName\" href=\"" + Dovetail.Ecommerce.BusinessLogic.Catalog.FriendlyUrl.SubCategoryDetailPage((int)DataBinder.Eval(Container.DataItem, "Category_ID")) + "\">" + DataBinder.Eval(Container.DataItem, "Name") + "</a>"%>
                </td>
                <td valign="bottom" class="ListCategoryItemCount">
                    <# ShowCategoryItemCount ? "(" + DataBinder.Eval(Container.DataItem, "ItemCount") + " items)" >
                </td>
            </tr>
            <tr>
                <td colspan="2" class="ListCategoryDescription">
                    <%# DataBinder.Eval(Container.DataItem, "Description ") %>
                </td>
            </tr>
            </table>
        </asp:PlaceHolder>
        <asp:PlaceHolder ID="subCategoryHorizontal" runat="server" Visible="<%# horizontalVisible %>">
            <table id="ListCategoryIndividual" border="0" style="float:left;">
                <tr>
                    <td>
                        <%# "<a class=\"ListCategoryName\" href=\"" + Dovetail.Ecommerce.BusinessLogic.Catalog.FriendlyUrl.SubCategoryDetailPage((int)DataBinder.Eval(Container.DataItem, "Category_ID")) + "\">" %>
                        <img runat="server" border="0" id="SubCategoryImage" class="ListCategoryPhoto" />
                        <%# "</a>" %>
                    </td>
                </tr>
                <tr>
                    <td class="ListCategoryName">
                        <%# "<a class=\"ListCategoryName\" href=\"" + Dovetail.Ecommerce.BusinessLogic.Catalog.FriendlyUrl.SubCategoryDetailPage((int)DataBinder.Eval(Container.DataItem, "Category_ID")) + "\">" + DataBinder.Eval(Container.DataItem, "Name") + "</a>"%>
                    </td>
                </tr>
                <tr>
                    <td class="ListCategoryDescription">
                        <%# DataBinder.Eval(Container.DataItem, "Description ") %>
                    </td>
                </tr>
                <tr>
                    <td valign="bottom" class="ListCategoryItemCount">
                        <# ShowCategoryItemCount ? "(" + DataBinder.Eval(Container.DataItem, "ItemCount") + " items)" >
                    </td>
                </tr>
            </table>
        </asp:PlaceHolder>
    </ItemTemplate>
    <FooterTemplate>
        </div>

    </FooterTemplate>
</asp:Repeater>
<br clear="all" />

System.Object
   System.Web.UI.Control
      System.Web.UI.TemplateControl
         System.Web.UI.UserControl
            Dovetail.Ecommerce.ControlBases.CyberStoreBaseControl
               Dovetail.Ecommerce.ControlBases.ListingControl
                  Dovetail.Ecommerce.Controls.CatalogCategoryListControl

Reference

CatalogCategoryListControl Members
Dovetail.Ecommerce.Controls Namespace