CheckOutOrderDisplayControl Class

A checkout order display control.

Remarks

The CheckOutOrderDisplayControl displays a summary of the information for an order. This includes the billing, shipping, payment method, and shipping options information.

It uses the CheckOutDisplayOrderTotals and CheckOutItemList controls to show order totals and line Items.

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

Address Properties

The Address1LineLabel gets or sets the first address line label.

The Address2LineLabel gets or sets the second address line label.

The Address3LineLabel gets or sets the third address line label.

The CityAddressLineLabel gets or sets the city address line label.

The CountryAddressLineLabel gets or sets the country address line label.

The PhoneAddressLineLabel gets or sets the phone address line label.

The StateAddressLineLabel gets or sets the state address line label.

The ZipCodeAddressLineLabel gets or sets the zip code address line label.

General Properties

The CurrencyCode the currency of the Order.

The ItemDetails sets the item details.

The NameLabel the text of the label for the Name Field.

The OrderDisplayName gets or sets the name of the order display.

The OrderTotals gets or sets the order totals.

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.

Sub Controls

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

Sub Control	Description
CheckOutItemList	Displays a list of checkout Items.
CheckOutDisplayOrderTotals	Displays the OrderTotal, GiftCertificateValue, ShippingCost, Tax, SubTotal, and Discount values for an order.

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.

CheckOutOrderDisplayControl.ascx

<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="CheckOutOrderDisplayControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CheckOutOrderDisplayControl" %>
<@ Register TagPrefix="uc1" TagName="CheckOutItemList" Src="~/Control/CheckOutItemList.ascx" >
<@ Register TagPrefix="uc1" TagName="CheckOutDisplayOrderTotals" Src="~/Control/CheckOutDisplayOrderTotals.ascx" >
<table id="Table2" cellspacing="0" cellpadding="0" width="100%" align="center">
    <tr class="CheckOutOrderSummaryTableRowHighlight">
        <td align="center" colspan="4" class="CheckOutOrderSummaryLabel">
            <%# OrderDisplayName %>
            Information
        </td>
    </tr>
    <tr>
        <td colspan="4" class="CheckoutSummaryOrderNumber" height="50">
            <table cellpadding="10" width="90%" align="center" border="0">
                <tr>
                    <td class="CheckoutSummaryLabelShippingOptions" align="left" width="50%">
                        <span class="CheckoutSummaryLabel">Account:</span>
                    </td>
                    <td align="center" width="50%">
                        <span class="CheckoutSummaryField">
                            <%# EmailAddress%></span>
                    </td>
                </tr>
                <span id="spnPODisplay" runat="server">
                    <tr>
                        <td class="CheckoutSummaryLabelShippingOptions" align="left" width="50%">
                            <span class="CheckoutSummaryLabel">
                                <%# PurchaseOrderLabelText %>:</span>
                        </td>
                        <td align="center" width="50%">
                            <span class="CheckoutSummaryField">
                                <%# PONum%></span>
                        </td>
                    </tr>
                </span><span class="CheckoutSummaryField">
                    <tr>
                        <td class="CheckoutSummaryLabelShippingOptions" align="left" width="50%">
                            <asp:Label ID="alternateKeyLabel2" runat="server" CssClass="CheckoutSummaryLabelShippingOptions"><%# AlternateKey %>:</asp:Label>
                        </td>
                        <td align="center" width="50%">
                            <asp:Label ID="AlternateKeyLabel" runat="server" CssClass="CheckoutSummaryField"><%# AlternateKey %></asp:Label>
                        </td>
                    </tr>
                </span>
            </table>
        </td>
    </tr>
</table>
<table id="Table2" cellspacing="0" cellpadding="0" width="100%" border="0">
    <tr class="CheckOutOrderSummaryTableRowHighlight">
        <td align="center" colspan="2" class="CheckOutOrderSummaryLabel">
            Ship to Information:
        </td>
        <td align="center" colspan="2" class="CheckOutOrderSummaryLabel">
            Bill to Information:
        </td>
    </tr>
    <tr>
        <td class="CheckoutSummaryLabel" style="width: 25%" align="right">
            <%# NameLabel%>
        </td>
        <td style="width: 25%">
            <asp:Label ID="shpnameLabel" CssClass="CheckoutSummaryField" runat="server"><%# ShippingAddress.DefaultView[0]["FIRSTNAME"] + "  " + ShippingAddress.DefaultView[0]["LASTNAME"]  %></asp:Label>
        </td>
        <td class="CheckoutSummaryLabel" style="width: 25%" align="right">
            <%# NameLabel%>
        </td>
        <td style="width: 25%">
            <asp:Label ID="blgnameLabel" CssClass="CheckoutSummaryField" runat="server"><%# BillingAddress.DefaultView[0]["FIRSTNAME"] + "  " + BillingAddress.DefaultView[0]["LASTNAME"]  %></asp:Label>
        </td>
    </tr>
    <tr>
        <td class="CheckoutSummaryLabel" align="right">
            <%# Address1LineLabel%>
        </td>
        <td>
            <asp:Label ID="shpaddress1Label" CssClass="CheckoutSummaryField" runat="server"><%# ShippingAddress.DefaultView[0]["ADDRESS1"]%></asp:Label>
        </td>
        <td class="CheckoutSummaryLabel" align="right">
            <%# Address1LineLabel%>
        </td>
        <td>
            <asp:Label ID="blgaddress1Label" CssClass="CheckoutSummaryField" runat="server"><%# BillingAddress.DefaultView[0]["ADDRESS1"]%></asp:Label>
        </td>
    </tr>
    <tr>
        <td class="CheckoutSummaryLabel" align="right">
            <%# Address2LineLabel%>
        </td>
        <td>
            <asp:Label ID="shpaddress2Label" CssClass="CheckoutSummaryField" runat="server"><%# ShippingAddress.DefaultView[0]["ADDRESS2"]%></asp:Label>
        </td>
        <td class="CheckoutSummaryLabel" align="right">
            <%# Address2LineLabel%>
        </td>
        <td>
            <asp:Label ID="blgaddress2Label" CssClass="CheckoutSummaryField" runat="server"><%# BillingAddress.DefaultView[0]["ADDRESS2"]%></asp:Label>
        </td>
    </tr>
    <tr>
        <td class="CheckoutSummaryLabel" align="right">
            <%# Address3LineLabel%>
        </td>
        <td>
            <asp:Label ID="shpaddress3Label" CssClass="CheckoutSummaryField" runat="server"><%# ShippingAddress.DefaultView[0]["ADDRESS3"]%></asp:Label>
        </td>
        <td class="CheckoutSummaryLabel" align="right">
            <%# Address3LineLabel%>
        </td>
        <td>
            <asp:Label ID="blgaddress3Label" CssClass="CheckoutSummaryField" runat="server"><%# BillingAddress.DefaultView[0]["ADDRESS3"]%></asp:Label>
        </td>
    </tr>
    <tr>
        <td class="CheckoutSummaryLabel" align="right">
            <%# CityAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="shpcityLabel" CssClass="CheckoutSummaryField" runat="server"><%# ShippingAddress.DefaultView[0]["CITY"]%></asp:Label>
        </td>
        <td class="CheckoutSummaryLabel" align="right">
            <%# CityAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="blgcityLabel" CssClass="CheckoutSummaryField" runat="server"><%# BillingAddress.DefaultView[0]["CITY"]%></asp:Label>
        </td>
    </tr>
    <tr>
        <td class="CheckoutSummaryLabel" align="right">
            <%# StateAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="shpstateLabel" CssClass="CheckoutSummaryField" runat="server"><%# ShippingAddress.DefaultView[0]["STATE"]%></asp:Label>
        </td>
        <td class="CheckoutSummaryLabel" align="right">
            <%# StateAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="blgstateLabel" CssClass="CheckoutSummaryField" runat="server"><%# BillingAddress.DefaultView[0]["STATE"]%></asp:Label>
        </td>
    </tr>
    <tr>
        <td class="CheckoutSummaryLabel" align="right">
            <%# ZipCodeAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="shpzipLabel" CssClass="CheckoutSummaryField" runat="server"><%# ShippingAddress.DefaultView[0]["ZIP"]%></asp:Label>
        </td>
        <td class="CheckoutSummaryLabel" align="right">
            <%# ZipCodeAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="blgzipLabel" CssClass="CheckoutSummaryField" runat="server"><%# BillingAddress.DefaultView[0]["ZIP"]%></asp:Label>
        </td>
    </tr>
    <tr runat="server" id="trCountryFieldRow">
        <td class="CheckoutSummaryLabel" align="right">
            <%# CountryAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="shpcountryLabel" CssClass="CheckoutSummaryField" runat="server"><%# ShippingAddress.DefaultView[0]["COUNTRY"]%></asp:Label>
        </td>
        <td class="CheckoutSummaryLabel" align="right">
            <%# CountryAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="blgcountryLabel" CssClass="CheckoutSummaryField" runat="server"><%# BillingAddress.DefaultView[0]["COUNTRY"]%></asp:Label>
        </td>
    </tr>
    <tr>
        <td class="CheckoutSummaryLabel" align="right">
            <%# PhoneAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="shpphoneLabel" CssClass="CheckoutSummaryField" runat="server"><%# ShippingAddress.DefaultView[0]["PHONE"]%></asp:Label>
        </td>
        <td class="CheckoutSummaryLabel" align="right">
            <%# PhoneAddressLineLabel%>
        </td>
        <td>
            <asp:Label ID="blgphoneLabel" CssClass="CheckoutSummaryField" runat="server"><%# BillingAddress.DefaultView[0]["PHONE"]%></asp:Label>
        </td>
    </tr>
</table>
<table id="Table3" cellspacing="0" cellpadding="0" width="100%" border="0">
    <tr class="CheckOutOrderSummaryTableRowHighlight">
        <td align="center" colspan="3" class="CheckOutOrderSummaryLabel">
            Payment Method:
        </td>
    </tr>
    <tr>
        <td align="center" colspan="3">
            <table cellpadding="10" align="center" border="0">
                <tr align="center">
                    <td width="50%">
                        <asp:Label ID="paymentmethodlabel" CssClass="CheckoutSummaryField" runat="server"></asp:Label>
                    </td>
                    <td width="50%" class="CheckoutSummaryField">
                        <span id="POLabel" runat="server" visible="false">Purchase Order #:&nbsp;&nbsp;</span><asp:Label
                            ID="paymentmethodnumberLabel" CssClass="CheckoutSummaryField" runat="server"></asp:Label>
                    </td>
                </tr>
            </table>
        </td>
    </tr>
    <asp:Panel ID="ShippingLabels" runat="server">
        <tr class="CheckOutOrderSummaryTableRowHighlight">
            <td align="center" colspan="3" class="CheckOutOrderSummaryLabel">
                Shipping Options:
            </td>
        </tr>
        <tr>
            <td align="center" colspan="3">
                <table cellpadding="10" width="90%" align="center" border="0">
                    <tr>
                        <td class="CheckoutSummaryLabelShippingOptions" align="left" width="50%">
                            Special Instructions:
                        </td>
                        <td align="center" width="50%">
                            <asp:Label ID="specialinstructionsLabel" CssClass="CheckoutSummaryField" runat="server">
                            <#SpecialInstructions>
                            </asp:Label>
                        </td>
                    </tr>
                    <tr>
                        <td class="CheckoutSummaryLabelShippingOptions" align="left" width="*">
                            Carrier:
                        </td>
                        <td align="center">
                            <asp:Label ID="carrierLabel" CssClass="CheckoutSummaryField" runat="server">
                            <%# Carrier %>
                            </asp:Label>
                        </td>
                    </tr>
                    <tr runat="server" id="RequestShipDateRow">
                        <td class="CheckoutOrderComments">
                            <asp:Label ID="RequestShippingDateLabel" CssClass="CheckoutSummaryLabelShippingOptions"
                                runat="server">Requested Ship Date: </asp:Label>
                        </td>
                        <td align="center">
                            <asp:Label ID="RequestShippingDateData" CssClass="CheckoutSummaryField" runat="server"></asp:Label>
                        </td>
                    </tr>
                </table>
            </td>
        </tr>
        <tr runat="server" id="CommentRow" visible='<#OrderComments.Trim()!="">'>
            <td colspan="2" class="CheckoutOrderComments">
                <#OrderComments>
            </td>
        </tr>
        <tr runat="server" id="Tr1">
            <td colspan="2">
                <#CustomConfirmation>
            </td>
        </tr>
        <tr>
            <td colspan="2">
                <#CustomShippingMessage>
            </td>
        </tr>
    </asp:Panel>
</table>
<uc1:CheckOutItemList ID="CheckOutItemList1" runat="server"></uc1:CheckOutItemList>
<uc1:CheckOutDisplayOrderTotals ID="CheckOutDisplayOrderTotals1" runat="server">
</uc1:CheckOutDisplayOrderTotals>

Inheritance Hierarchy

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

Reference

CheckOutOrderDisplayControl Members
Dovetail.Ecommerce.Controls Namespace
CheckOutDisplayOrderTotals Class
CheckOutItemLists