CyberStore Documentation
CatalogFeaturedItemControl Class
Members  Example 

Dovetail.Ecommerce.Controls Namespace : CatalogFeaturedItemControl Class

A catalog Featured Item control.


The CatalogFeaturedItemControl displays a randomly selected Featured Item from the current Category and its children Categories.

Using this control you can configure the Photo, Photo Width, and how the price is shown.

An example of the CatalogFeaturedItemControl can be seen below:

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.

By changing the value of the NumberOfItemsToDisplay property the inputted value will determine the number of items to display. Input a value to designate as the photo location by using the photoLocation property. To choose a photo to use input a corresponding value in the UsePhoto property. Change the PhotoWidth property to customize the width of the photo.

Properties Inherited from the Base ItemControl 

The properties contained in the ItemControl base class allow for options regarding the type of Item that is in context for the control.

The properties IgnoreWhenModelIgnoreWhenSKU, and IgnoreWhenStockCode properties can be used to case the ItemControl to not process nor render when the appropriate Item type is valid for the Item.

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.

Sub Controls

The table below lists and describes sub controls used by the default CatalogFeaturedItemControl.

Sub Control Description
CatalogPricingControl Displays the pricing for an Item.
CatalogItemImageControl Displays the featured image and Item detail images that have a zoom feature.
CatalogOnHandQuantityDisplayControl Displays messages regarding available Item quantity and lead time.
See an example of how to configure this control in SitePages.config.
<Control src="CatalogFeaturedItemControl.ascx"
   AddtoCartText="Add to Cart"
   AddtoCartStandardText="Add Standard"
   AccessorizeText = "Add with Options"
   ListPriceLabel="List Price:"
   YourPriceLabel="Your Price:"
   PriceLabel="Price Label:"
   LimitedAvailableMessage="&lt;nobr&gt;[QTY] [UOM] In Stock&lt;/nobr&gt;&lt;/br&gt;"
   LimitedUnavaliableMessage="&lt;nobr&gt;Restocking in 2 to 3 days&lt;/nobr&gt;&lt;/br&gt;"
   UnlimitedAvailableMessage="&lt;nobr&gt;[QTY] [UOM] In Stock&lt;/nobr&gt;&lt;/br&gt;"
   UnlimitedUnavailableMessage="&lt;nobr&gt;Ships in 2 weeks&lt;nobr&gt;&lt;/br&gt;"
   LeadTimeMessage="Leadtime: [LEADTIME]&lt;/br&gt;"
   OnHandDisplayCssClass="CatalogOnHandQuantityDisplay" />
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.


<@ Register TagPrefix="uc1" TagName="CatalogSimplePricingControl" Src="~/Control/CatalogSimplePricingControl.ascx" >
<@ Register TagPrefix="uc1" TagName="CatalogItemImageControl" Src="~/Control/CatalogItemImageControl.ascx" >
<@ Register TagPrefix="uc1" TagName="CatalogOnHandQuantityDisplayControl" Src="~/Control/CatalogOnHandQuantityDisplayControl.ascx" >
<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="CatalogFeaturedItemControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogFeaturedItemControl" %>
    <div class="CatalogFeaturedItemHeadlineHighlight" valign="middle">
        <asp:Label ID="Title" runat="server" EnableViewState="true" CssClass="CatalogFeaturedItemHeadline" />
    <div class="span3">
            <uc1:CatalogItemImageControl ID="Photo" runat="server" PictureNotFoundCssClass="CatalogFeaturedItemPictureNotFound"
                PhotoCssClass="CatalogFeaturedItemPicture" PhotoLocation='<%# UsePhoto %>' />
    <div class="span5" style="width: 37%;">
        <br />
        <asp:Label ID="HeadLine" runat="server" CssClass="CatalogFeaturedItemProductHeadline" />
        <asp:Label ID="SubHeadline" runat="server" CssClass="CatalogFeaturedItemProductSubHeadline" />
        <br />
                    <asp:Label ID="Price" runat="server" CssClass="CatalogFeaturedItemPrice" />
        <asp:Label ID="Model" runat="server" CssClass="detailCatalogProductDetailStockCode " />
        <uc1:CatalogOnHandQuantityDisplayControl ID="OnHandQuantity" runat="server" OnHandDisplayCssClass="OnHandQuantityFeaturedItem" />
        <br />
        <asp:Label ID="Description" runat="server" CssClass="CatalogFeaturedItemLongDescription" />
        <span id="ItemSpecificationLink" runat="server"></span>
        <br clear="all" />
    <div id="detailPricingControl">
        <uc1:CatalogSimplePricingControl ID="addToCartBtn" runat="server" />
Inheritance Hierarchy


See Also


CatalogFeaturedItemControl Members
Dovetail.Ecommerce.Controls Namespace