CyberStore Documentation
CatalogItemImageControl Class
Members  Example 

Dovetail.Ecommerce.Controls Namespace : CatalogItemImageControl Class

A catalog Item image control.


The CatalogItemImageControl displays the featured image and Item detail images that have a zoom feature.

It displays one or more images of an Item.


By design, the control searches in the corresponding featured photo folder. It searches for a PNG, JPG, or GIF file that uses the stock code of the Item as the filename base (for example, A100.png). If no filenames use the stock code, the Item's Category photo is used. If no Category image is specified or found, an empty photo image is shown. 

The control can also display Item detail images with a zoom user interface. Be sure to enable the zoom feature if desired.

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.

Automatically, the control provides the zoom user interface by searching in the Item-detail/STOCKCODE folder and including all images found. When you want to display the Item's featured photo, specify a photo by setting the UsePhoto property to the folder name of the images sub folder (e.g.,"Photo1" uses the ../YourSiteFolder/Images/Photo1 folder). The image is then sized using the value of the PhotoWidth property and aligned using the Align property. You can override such information using the PhotoCssClass property by changing the formatting applied by the CSS class.

To override default behavior that uses the Category photo as a fallback, set the FallbackToCategoryPhoto property to false.

When no image can be found, the control loads the image from the path in the PictureNotFoundImageUrl property. It then applies the CSS style specified by the PictureNotFoundCssClass property to the image.

Customize the HTML alternate text (ALT text) using the PhotoAltText property.

To allow for the use of Item Detail images rather than featured photos, set the EnableZoom property to true. This causes the control to use the CatalogItemImageZoomControl for rendering.

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.

Sub Controls

The following are sub controls used by the CatalogItemImageControl

Sub Control Description
CatalogItemImageZoomControl Displays an Item's detail images with a thumbnail slider and zoom user interface.
See an example of how to configure this control in SitePages.config.
<Control src="CatalogItemDetailControl.ascx"
PhotoAltText="Performance Bicycle"
ZoomWindowText="A100 - 15 Speed Racing Bike - Boys"
ExpandedWindowText="A100 - 15 Speed Racing Bike - Boys - Perormance bicycles have never been so affordable"
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="CatalogItemImageControl.ascx.cs"
    Inherits="Dovetail.Ecommerce.Controls.CatalogItemImageControl" %>
<dx:ASPxImage ID="PhotoImage" runat="server" />
Inheritance Hierarchy


See Also


CatalogItemImageControl Members
Dovetail.Ecommerce.Controls Namespace