CyberStore Documentation
CatalogItemVerticleListingControl Class
Members  Example 


Dovetail.Ecommerce.Controls Namespace : CatalogItemVerticleListingControl Class

A catalog Item vertical listing control. 

Remarks

The CatalogItemVerticleListingControl displays a listing of approved Items filtered by Category and/or search criteria. The current user can only view approved Items within the Categories that their View List permits them to access. 

The listing is paged, and you can choose to order it by the Items' names, prices, or stock codes.

An example of the CatalogItemVerticleListingControl in use is below:

 

Note: Use the CatalogItemVerticleListingControl for normal control. Use CatalogItemVerticleListingControlMultiAdd for multi-add ability.

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.

The Item Verticle Listing Control can be personalized using multiple properties which include the ShowCategoryResults property which gets a value indicating whether the category results are shown. When the category results are shown the CurrentSortOrder will set the current sort order by the Item_ID.

If you wish for photos to also be displayed with this control you can use the UsePhoto property which is used to determine which photo to display. Supported values: Photo1 or Photo2. In order for the aforementioned property to work the photoLocation property must be correctly set to the photo location. If the photo width is not desirable this can be changed using the PhotoWidth property.

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.

Sub Controls

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

Sub Control Description
CatalogItemImageControl Displays the featured image and Item detail images that have a zoom feature.
CatalogPricingControl Displays the pricing for an Item.
CatalogOnHandQuantityDisplayControl Displays messages regarding available Item quantity and lead time.
Example
See an example of how to configure this control in SitePages.config.
<Control src="CatalogItemVerticleListingControl.ascx"
       Name="Menu List"
       PhotoWidth="55"
       UsePhoto="Photo1"
       ShowCategoryResults="true"
       HideQuantityInput="NO_VALUE_SPECIFIED"
       AddtoCartText="Add to Cart"
       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;"
       EnableOnHandQuantityDisplay="true"
       EnableLeadTimeMessage="true"  />
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="CatalogItemVerticleListingControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogItemVerticleListingControl" %>
<@ Register TagPrefix="uc1" TagName="CatalogItemImageControl" Src="~/Control/CatalogItemImageControl.ascx" >
<@ Register TagPrefix="uc1" TagName="CatalogPricingControl" Src="~/Control/CatalogPricingControl.ascx" >
<@ Register TagPrefix="uc1" TagName="CatalogOnHandQuantityDisplayControl" Src="~/Control/CatalogOnHandQuantityDisplayControl.ascx" >
<%@ Import Namespace="Dovetail.Ecommerce.Base.Module" %>
<asp:Panel runat="server" ID="Results" Visible="true">
    <span class="CatalogListSortLabel">Sort By:
        <asp:DropDownList ID="Sort" CssClass="CatalogListSortSelect" AutoPostBack="true"
            runat="server" OnSelectedIndexChanged="Sort_SelectedIndexChanged">
            <asp:ListItem Selected="true" Value="itemname">Name</asp:ListItem>
            <asp:ListItem Value="StockCode">Stock Code</asp:ListItem>
            <asp:ListItem Value="UnitPrice">Price</asp:ListItem>
        </asp:DropDownList>
    </span>
    <asp:DataGrid ID="ListingGrid" CssClass="DefaultTable" runat="server" GridLines="None"
        HeaderStyle-CssClass="HighlightTableRow" AlternatingItemStyle-CssClass="HighlightTableRow"
        AllowPaging="true" AutoGenerateColumns="false" PagerStyle-Mode="NumericPages">
        <AlternatingItemStyle CssClass="CatalogHighlightTableRow"></AlternatingItemStyle>
        <HeaderStyle CssClass="HighlightTableRow"></HeaderStyle>
        <Columns>
            <asp:TemplateColumn HeaderText="">
                <HeaderStyle CssClass="ColumnLabel"></HeaderStyle>
                <ItemTemplate>
                    <p class="CatalogProductVerticalListStockCode">
                        <%# Eval("StockCode") %>
                    </p>
                </ItemTemplate>
            </asp:TemplateColumn>
            <asp:TemplateColumn>
                <ItemTemplate>
                    <uc1:CatalogItemImageControl ID="ItemImage" runat="server" StockCode='<%# Eval("Stockcode")%>'
                        PhotoAltText='<%# Eval("Stockcode")%>' PhotoCssClass="CatalogProductVerticalListPicture"
                        PictureNotFoundCssClass="CatalogProductVerticalListPictureNotFound" Item_ID='<#Convert.ToInt32(Eval("Item_ID"))>'
                        imageAlign="left" />
                </ItemTemplate>
            </asp:TemplateColumn>
            <asp:TemplateColumn HeaderText="">
                <HeaderStyle CssClass="ColumnLabel"></HeaderStyle>
                <ItemTemplate>
                    <%# String.Format("<a class=\"CatalogListNavTrail\" href=\"{0}\">{1}</a>",
                        Dovetail.Ecommerce.BusinessLogic.Catalog.FriendlyUrl.ItemDetailPage(DataBinder.Eval(Container.DataItem, "StockCode").ToString(),DataBinder.Eval(Container.DataItem, "Name").ToString()),
                        DataBinder.Eval(Container.DataItem, "Name").ToString()) %>
                    <br />
                    <p class="CatalogProductVerticalListShortDescription">
                        <%# DataBinder.Eval(Container.DataItem, "ShortDescription")%>
                    </p>
                </ItemTemplate>
            </asp:TemplateColumn>
            <asp:TemplateColumn HeaderText="">
                <HeaderStyle CssClass="ColumnLabel" />
                <ItemTemplate>
                    <uc1:CatalogOnHandQuantityDisplayControl ID="OnHandQuantityDisplay" runat="server"
                        Item_ID='<#Convert.ToInt32(Eval("Item_ID"))>'
                        OnHandDisplayCssClass="OnHandQuantityItemVerticleListing" />
                </ItemTemplate>
            </asp:TemplateColumn>
            <asp:TemplateColumn HeaderText="">
                <HeaderStyle CssClass="ColumnLabel"></HeaderStyle>
                <ItemTemplate>
                    <uc1:CatalogPricingControl ID="CatalogaddtocartInput" runat="server" Item_ID='<%#Convert.ToInt32(DataBinder.Eval(Container.DataItem, "Item_ID"))%>'
                        DisableListPrice="true" />
                </ItemTemplate>
            </asp:TemplateColumn>
        </Columns>
        <PagerStyle NextPageText="Next Page" PrevPageText="Previous Page" CssClass="CatalogListPaginationText">
        </PagerStyle>
    </asp:DataGrid>
    <asp:Label ID="PageNumberDisplay" runat="server">Page <%#(ListingGrid.CurrentPageIndex+1).ToString()  %> of <%# ListingGrid.PageCount.ToString() %></asp:Label>
</asp:Panel>
<asp:Panel runat="server" ID="NoSearchResults" Visible="false">
    <div class="ValidationMessage">
        Sorry, no items were found that matched the criteria you specified in your search.
        For more comprehensive results, please browse our catalog below or try again using
        different keywords in the search panel.<!--//UserMessage--></div>
</asp:Panel>
<asp:Panel runat="server" ID="NoItemsInCategory" Visible="false">
</asp:Panel>
<br clear="all">
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.CatalogItemVerticleListingControl
                     Dovetail.Ecommerce.Controls.CatalogItemListingByCategoryControl

See Also

Reference

CatalogItemVerticleListingControl Members
Dovetail.Ecommerce.Controls Namespace