CatalogCategoryMenuControl Class

A menu control. Introduced in v2.5.

Remarks

With the CatalogCategoryMenuControl, shoppers can access your categories via the menu. Your categories are automatically configured into your CyberStore with this control.

See the example below of the CatalogCategoryMenuControl in use:

When the shopper navigates to the menu and then the products tab they are shown all of your categories.

The CatalogCategoryMenuControl can be further modified manually to include sub-categories.

Property Usage

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.

Category Menu Configuration

There are a few properties which help define the Category Menu Configuration. These properties include the MaxCategoryDepth which sets the maximum depth to drill down within the Category Menu. The Maximum depth is limited to 3 levels. The MenuTopLevelCategoryID gets or sets the Category Identifier to start the menu at. The default is -1 which is the top of the category tree by design. Furthermore, the MenuTopLevelCategoryPath gets or sets the category path of the desired start level of the menu. The default is "/" which is the top level. Lastly, the ShowCategoryPhotos property sets whether the category photo is shown if it exists in your console.

Note: Any invalid path results in "/" being used.

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.

Control Markup

The following is the markup for this control.

Developer's Note:

To create a custom version of the control, copy all of the code below into a file of the same name and place it into your Site's control folder (e.g., ../YourSiteFolder/Control). The CyberStore page engine will then override the default markup with your customized version.

CatalogCategoryMenuControl.ascx

<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="CatalogCategoryMenuControl.ascx.cs" Inherits="Dovetail.Ecommerce.Controls.CatalogCategoryMenuControl" %>

<div class="col-xs-6 yamm navbar-header">
    <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
        <span class="sr-only">MENU</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
    </button>

</div>
<div class="col-xs-8 navbar-collapse collapse">
    <ul class="nav navbar-nav">
        <li class="active"><a href="/ecommerce/default.aspx">Home</a></li>
        <li class="pipe">|</li>
        <li class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">Products<span class="caret"></span></a>
            <!-- BEGIN: Category Menu - DO NOT DELETE -->
            <ul class="dropdown-menu" id="navigation" runat="server"></ul>
            <!-- END: Category Menu -->
        </li>
        <li class="pipe">|</li>
        <li><a href="/ecommerce/CatalogAbout.aspx">About</a></li>
        <li class="pipe">|</li>
        <li><a href="#contact">Catalog</a></li>
        <li class="pipe">|</li>
        <li><a href="/ecommerce/catalogcontactus.aspx">Contact Us</a></li>
    </ul>
</div>

Inheritance Hierarchy

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

Reference

CatalogCategoryMenuControl Members
Dovetail.Ecommerce.Controls Namespace