CheckOutItemList Class

A checkout Item list control.

Remarks

The CheckOutItemList control displays a list of checkout Items. It formats the Item details within an order.

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

The CurrencyCode the currency code of the order. If not specified, the currency of the logged user is used for displaying.

Price Label Properties

The CustomerPriceLabelText, DefaultPriceLabelText, DiscountPriceLabelText, and WebPriceLabelText properties the customer, default, discount, and web price label text respectively.

Price Display Properties

The ShowCustomerPrice, ShowDefaultPrice, ShowDiscountPrice, and ShowWebPrice properties set a value indicating whether the cutomer, default, discount, and web price is shown respectively.

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.

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.

CheckOutItemList.ascx

<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="CheckOutItemList.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CheckOutItemList" %>

<dx:ASPxGridView ID="grdItemList" runat="server" ClientIDMode="Static" KeyFieldName="OrderDetail_ID" OnCustomColumnDisplayText="grdItemList_CustomColumnDisplayText" width="98%" SettingsPager-PageSize="1000" >
    <Columns>
        <dx:GridViewDataTextColumn Caption="Line" FieldName="LineNumber" Visible="False" SortOrder="Ascending" SortIndex="1" />
        <dx:GridViewDataTextColumn Caption="Product Name" FieldName="Item_Description" />
        <dx:GridViewDataTextColumn Caption="StockCode" FieldName="StockCode" />
        <dx:GridViewDataTextColumn Caption="Default Price" FieldName="DefaultPrice" />
        <dx:GridViewDataTextColumn Caption="Customer Price" FieldName="CustomerPrice" />
        <dx:GridViewDataTextColumn Caption="Discount Price" FieldName="DiscountPrice" />
        <dx:GridViewDataTextColumn Caption="Quantity" FieldName="Quantity" />
        <dx:GridViewDataTextColumn Caption="Web Price" FieldName="UnitPrice" />
        <dx:GridViewDataTextColumn Caption="Unit" FieldName="Unit" />
        <dx:GridViewDataTextColumn Caption="Total" FieldName="Price" />
    </Columns>
</dx:ASPxGridView>

Inheritance Hierarchy

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

Reference

CheckOutItemList Members
Dovetail.Ecommerce.Controls Namespace