CyberStore Documentation
CatalogItemDiagramListing Class
Members 


Dovetail.Ecommerce.Controls Namespace : CatalogItemDiagramListing Class
A catalog Item diagram listing. Introduced in v2.5.
Remarks

The CatalogItemDiagramListing displays an image. In this case the image displayed on the front end is a Hot Spot diagram. This control can determine the width of the photo and the grid display.

An example of the CatalogItemDiagramListing in use is 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.

General properties

When there is no data the HotSpotDiagramEmptyDisplay sets whether the DataList and GridView controls should be displayed if there is no data. The default value for this property is "false". Similarily, when there is no data the HotSpotDiagramNoDataMessage property sets a message to display. While, when there is data the HotSpotDiagramGridDisplay property sets whether the DataList or GridView is displayed. The Hot Spot Diagram comes with a photo and the HotSpotDiagramPhotoWidth property sets the width of the photo and the HotSpotDiagramURL sets the URL for the Hot Spot Diagram link. Lastly, the HotSpotDiagramFolderLocation property is responsible for getting the hot spot diagram folder location from Paths tab on Site Configuration screen.

Grid Properties

There are multiple properties in this control which dictate how the Hot Spot Diagram Grid is layed out. Below are examples of these properties:

List Properties

There are multiple properties in this control which dictate how the Hot Spot Diagram List is layed out. Below are examples of these properties:

 

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 IncludeModelsIncludeSKUs, and IncludeStockCodes properties to do this. Set them to true to include, and false to exclude.

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

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.

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 Language="C#" AutoEventWireup="true" CodeBehind="CatalogItemDiagramListing.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogItemDiagramListing" %>
<asp:DataList ID="lstItemDiagramListing"  runat="server" BorderWidth="0px"
    HeaderStyle-CssClass="HighlightTableRow">
   
    <ItemTemplate>
    <div class="HotSpotWrap">
        <div class="HotSpotItemHeadline">
            <%# Eval("DiagramHeadline")%>
        </div>

        <div style="text-align:center;padding: 10px 0;"> <asp:ImageButton ID="lstDiagramImageLink" runat="server" Width="<#HotSpotDiagramPhotoWidth>"
            AlternateText='<%# Eval("DiagramName") %>' CssClass="CatalogProductVerticalListPicture"
            ImageUrl='<%# String.Format("{0}{1}",HotSpotDiagramFolderLocation,Eval("DiagramImagePath")) %>' PostBackUrl='<%# String.Format("{0}?HSP={1}", HotSpotDiagramURL, Eval("DiagramID"))%>' /></div>

        <div><span class="CatalogProduct2DListStockCodeLabel">Name:</span> <span class="CatalogProduct2DListStockCode">
            <asp:HyperLink runat="server" ID="lstDiagramTextLink" Text='<%# Eval("DiagramName") %>'
                NavigateUrl='<%# String.Format("{0}?HSP={1}", HotSpotDiagramURL, Eval("DiagramID") ) %>'></asp:HyperLink>
            </span><span class="CatalogProduct2DListStockCodeLabel">
            <%# Eval("DiagramDescription") %></span></div>
    </div>

    </ItemTemplate>

    <HeaderStyle CssClass="HighlightTableRow" />
</asp:DataList>
<asp:DataGrid ID="grdItemDiagramListing"  runat="server" GridLines="None"
    HeaderStyle-CssClass="HighlightTableRow" AlternatingItemStyle-CssClass="HighlightTableRow"
    AllowPaging="true" AutoGenerateColumns="false" PagerStyle-Mode="NumericPages">
    <AlternatingItemStyle CssClass="CatalogHighlightTableRow" />
    <HeaderStyle CssClass="HighlightTableRow" />
    <Columns>
        <asp:TemplateColumn HeaderText="Name">
            <HeaderStyle CssClass="ColumnLabel" />
            <ItemTemplate>
                <p class="CatalogProductVerticalListStockCode">
                    <asp:HyperLink ID="grdDiagramTextLink" runat="server" Text='<%# Eval("DiagramName") %>'
                        NavigateUrl='<%# String.Format("{0}?HSP={1}", HotSpotDiagramURL, Eval("DiagramID"))%>' />
                </p>
            </ItemTemplate>
        </asp:TemplateColumn>
        <asp:TemplateColumn HeaderText="Diagram">
            <HeaderStyle CssClass="ColumnLabel" />
            <ItemTemplate>
                <asp:ImageButton ID="grdDiagramImageLink" runat="server" Width="<#HotSpotDiagramPhotoWidth>"
                    AlternateText='<%# Eval("DiagramName") %>' CssClass="CatalogProductVerticalListPicture"
                    ImageUrl='<%# String.Format("{0}{1}",HotSpotDiagramFolderLocation,Eval("DiagramImagePath")) %>' PostBackUrl='<%# String.Format("{0}?HSP={1}", HotSpotDiagramURL, Eval("DiagramID"))%>' />
            </ItemTemplate>
        </asp:TemplateColumn>
        <asp:TemplateColumn HeaderText="Headline">
            <HeaderStyle CssClass="ColumnLabel"></HeaderStyle>
            <ItemTemplate>
                <p class="CatalogProductVerticalListShortDescription">
                    <%# Eval("DiagramHeadline")%>
                </p>
            </ItemTemplate>
        </asp:TemplateColumn>
        <asp:TemplateColumn HeaderText="Description">
            <HeaderStyle CssClass="ColumnLabel"></HeaderStyle>
            <ItemTemplate>
                <div class="CatalogProductVerticalListShortDescription">
                    <%# Eval("DiagramDescription")%>
                </p>
            </ItemTemplate>
        </asp:TemplateColumn>
    </Columns>
    <PagerStyle NextPageText="Next Page" PrevPageText="Previous Page" CssClass="CatalogListPaginationText" />
</asp:DataGrid>
<asp:Panel runat="server" ID="pnlNoDiagrams" Visible="false">
    <div runat="server" id="msgNoDiagrams" class="ValidationMessage" />
</asp:Panel>
Inheritance Hierarchy

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

See Also

Reference

CatalogItemDiagramListing Members
Dovetail.Ecommerce.Controls Namespace