The CatalogHotSpotListingControl displays a list of all of the hot spots on an item.

An example of the CatalogHotSpotListingControl 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.

The HotSpotGridPageSize gets or sets the size of the hot spot grid page. The ShowEmptyHotSpotGrid sets a value indicating whether the empty hot spot grid is shown. When the hot spot grid is empty the EmptyHotSpotGridText property displays a message. The default message is "No data to display".

The following properties are responsible for displaying columns in the Hot Spot Listing Table. All of the folowing properties have a default value of "true" and therefore appear in the control. In order to hide these columns you can set the value of the property to "false".

• The ShowHotSpotAddToCartColumn sets a value indicating whether the hot spot add to cart column is shown.
• The ShowHotSpotColumnHeaders sets a value indicating whether the hot spot column headers is shown.
• The ShowHotSpotNameColumn sets a value indicating whether the hot spot name column is shown.
• The ShowHotSpotQtyColumn sets a value indicating whether the hot spot quantity column is shown.
• The ShowHotSpotReferenceColumn sets a value indicating whether the hot spot reference column is shown.
• The ShowHotSpotRequiredColumn sets a value indicating whether the hot spot required column is shown.
• The ShowHotSpotShortDescriptionColumn sets a value indicating whether the hot spot short description column is shown.

The following properties are responsible for displaying columns in the Hot Spot Listing Table. All of the folowing properties have a default value of "false" and therefore do not appear in the control. In order to show these columns you can set the value of the property to "true".

• The ShowHotSpotIDColumn sets a value indicating whether the hot spot identifier column is shown.
• The ShowHotSpotStockCodeColumn sets a value indicating whether the hot spot stock code column is shown.

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 table below lists and describes sub controls used by the default CatalogHotSpotListingControl.

The following is the markup for this control.

<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="CatalogHotSpotListingControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogHotSpotListingControl" %>
<@ 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" >
<dx:ASPxGridView ID="grdHotSpotListingControl" runat="server" KeyFieldName="ID">
    <Columns>
        <dx:GridViewDataColumn FieldName="ID"  />
        <dx:GridViewDataColumn FieldName="Reference" />
        <dx:GridViewDataColumn FieldName="Item.StockCode" Caption="Stock Code" />
        <dx:GridViewDataColumn FieldName="Item.Name" Caption="Name"/>
        <dx:GridViewDataColumn FieldName="Item.ShortDescription" Caption="Short Description" />
        <dx:GridViewDataTextColumn FieldName="" Caption="Quantity in Stock" CellStyle-CssClass="ItemListingQtyinStockCol"
            ReadOnly="true" Settings-AllowSort="False" UnboundType="Object">
            <DataItemTemplate>
                <uc1:CatalogOnHandQuantityDisplayControl ID="OnHandQuantityDisplay" runat="server" Item_ID='<%# Eval("Item_ID") %>' />
            </DataItemTemplate>
        </dx:GridViewDataTextColumn>
        <dx:GridViewDataColumn FieldName="RequiredQuantity" Caption="Required Quantity" />
        <dx:GridViewDataTextColumn FieldName="" Caption=" " CellStyle-CssClass="CatalogItemListingConversionCol"
            ReadOnly="true" Settings-AllowSort="False" UnboundType="Object">
            <DataItemTemplate>
                <uc1:CatalogSimplePricingControl ID="CatalogaddtocartInput" runat="server" Item_ID='<%# Eval("Item_ID") %>' AddToCartMinimumRequired='<%# Eval("RequiredQuantity") %>' />
            </DataItemTemplate>
        </dx:GridViewDataTextColumn>
    </Columns>
</dx:ASPxGridView>

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

Reference

CatalogHotSpotListingControl Members
Dovetail.Ecommerce.Controls Namespace