CyberStore Documentation
CommonStateDropDownControl Class

Dovetail.Ecommerce.Controls Namespace : CommonStateDropDownControl Class

A common state drop down control.


The CommonStateDropDownControl displays a list of available states in a drop-down.

An example of the CommonStateDropDownControl 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 SelectOneText property sets the select one text.

State Properties

This control features a few customizable state properties which include the PreSelectedState property which sets a preselected state. The StateDropDownList property which is the actual DropDownList control containing the states. If you do not deliver to Florida this state can be excluded from that list. Lastly, the stateindex which gets the state index and the statelongname which gets the State Long Name.

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="CommonStateDropDownControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CommonStateDropDownControl" %>
<asp:DropDownList ID="stateDropDownList" runat="server" CssClass="FormSelect" />
Inheritance Hierarchy


See Also


CommonStateDropDownControl Members
Dovetail.Ecommerce.Controls Namespace