CyberStore Documentation
CatalogCategoryNavigationControl Class
Members  Example 

Dovetail.Ecommerce.Controls Namespace : CatalogCategoryNavigationControl Class

A catalog Category navigation control.


The CatalogCategoryNavigationControl displays a menu system for the approved Categories that is filtered according to the current shopper's View List.

When you are on an "Item Detail" page, the CatalogCategoryNavigationControl is aware of the Category to which that Item belongs.

This control gives you the option of displaying Categories via a drop-down list.

An example of the CatalogCategoryNavigationControl in use is below:


Developer's Note:

The control determines the Category for an Item after first evaluating the last known Category page visited. It can identify the Category_ID stored in the CyberStore Session Variable Session["LastCategory_ID"] and check whether that Category contains the Item. If the Item is not a member of that Category, the control defaults to the first Category that contains the Item.


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.

Menu Properties

To determine how the control is displayed you must set the MenuDisplayMode to either "Text" (Default) or "DropDown". The MaxCategoryDepth sets the maximum number of categories which will be displayed in the menu and is set to a default value of "99".

Link Properties

By editing the FirstButtonHyperlinkPage property you can change the first button hyperlink page. Similarily, you can edit the HyperlinkPageFirstLinkPage, and the LinkPage to change the hyperlink location, first link page, and link page, respectively.

Text Properties

The ExpandTextMenuByDefault property sets a value indicating whether to expand the text menu by default when there is no Category_ID up to the MaxCategoryDepth. When "DisplayMode = 'text'," only the current Category and its siblings appear in the navigation list this is configured using the ShowOnlySiblingCategories property. Should you wish to use tiered pages you can set the TieredPages value to "true".

Drop Down Properties

In order to customize the drop down button text, the first hint text, the drop down hint text, and the drop down menu parent you will need to edit the DropDownButtonTextDropDownFirstHintTextDropDownHintText,  and DropDownMenuParentID property, respectively.

Properties Inherited from the Base CyberStoreBaseControl

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

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 ComConfigUserData 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.

See an example of how to configure this control in SitePages.config.
<Control src="CatalogCategoryNavigationControl.ascx"
     TieredPages="False" />
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.


<%@ Control AutoEventWireup="true" CodeBehind="CatalogCategoryNavigationControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogCategoryNavigationControl" Language="C#" %>
    <div class="sidebarControls">
<span class="CategoryNav ControlHeader">PRODUCT SELECTOR<br /></span>

<asp:Label CssClass="FormLabel" ID="CategoryListLabel" runat="server" EnableViewState="false" />

<dx:ASPxCallbackPanel ID="clbkDropDownCatNavigationPanel" runat="server" OnCallback="clbkDropDownCatNavigationPanel_Callback"
    ClientIDMode="Static" ClientInstanceName="clbkDropDownCatNavigationPanel">
            <div id="Div0" runat="server" visible="true">
                <dx:ASPxComboBox ID="Filter0" CssClass="FormSelect" runat="server" Visible="true" TextField="Name" ValueType="System.Int32"
                    ValueField="ID" AutoPostBack="false" ClientIDMode="Static" ClientInstanceName="Filter0"  ClientSideEvents-SelectedIndexChanged="function(s,e){clbkDropDownCatNavigationPanel.PerformCallback('0;' + Filter0.GetValue());}" />
                <dx:ASPxButton ID="btnGoToCategory0" runat="server" ClientInstanceName="btnGoToCategory0" ClientIDMode="Static" OnClick="btnGoToCategory_Click"  />
<div style="margin-top:10px;clear:both"></div>
<div ><a href="default.aspx"  class="btn btn-inverse controlButton ">Refresh</a></div>
Inheritance Hierarchy


See Also


CatalogCategoryNavigationControl Members
Dovetail.Ecommerce.Controls Namespace