CyberStore Documentation
DistributorSearchControl Class
Members  Example 

Dovetail.Ecommerce.Controls Namespace : DistributorSearchControl Class

A Distributor search control.


The DistributorSearchControl displays an interface for shoppers to search for a Distributor and their listings. The interface displays both stock code and zip code input for filtering.

The control also provides the capability to allow Site visitors to find locations where your product can be bought.


The search function provides the ability to perform a dealer search where the user can enter a US zip code and keyword or stock code information. The control produces a list of dealers within the designated search radius. The list is sorted by distance from the entered zip code.


Within the results returned, when a user clicks on a distributor name, a pop-up loads displaying the location of the distributor using Google maps functionality.


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.

When the EnableStockCodeSearch property is set to its default value of true, the search interface includes the stock code search box, whereas setting the value to false offers only a zip code search.

To control the number of search results contained in a page, use the PageSize property.

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.

See an example of how to configure this control in SitePages.config.
<Control src="DistributorSearchControl.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.


Inheritance Hierarchy


See Also


DistributorSearchControl Members
Dovetail.Ecommerce.Controls Namespace