GiftCertificate Class

A gift certificate control.

Remarks

The GiftCertificate control allows a shopper to input a Promotion Code to use toward an order. You can choose to display this control during the Payment Methods Selection, step three, of the checkout process.

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.

There are two properties which can be edited to customize this control. They include the CertificateNumberText property which gets the certificate number text and the Label property which sets the Certificate Number Label.

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.

Example

See an example of how to configure this control in SitePages.config.

<Control src="GiftCertificate.ascx" />

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.

GiftCertificate.ascx

<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="GiftCertificate.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.GiftCertificate" %>
<asp:Label ID="messageLabel" runat="server" CssClass="InfoMessage" Visible="false"
    Enabled="false"></asp:Label><br>
<table id="Table1" style="width: 510px" cellspacing="1" cellpadding="1" width="510"
    border="0">
    <tr>
        <td style="width: 201px" valign="top" align="right">
            <asp:Label ID="CertificateNumberLabel" runat="server" CssClass="FormLabel">Promotion Code:</asp:Label>
        </td>
        <td>
            <asp:TextBox CssClass="FormTextArea" ID="CertificateNumberTextBox" runat="server"
                Width="138px"></asp:TextBox>
            <asp:Button ID="CertificateButton" runat="server" Text="GO" Visible="false"></asp:Button>
        </td>
    </tr>
</table>

Inheritance Hierarchy

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

Reference

GiftCertificate Members
Dovetail.Ecommerce.Controls Namespace