CyberStore Ecommerce 2023 Documentation
CatalogItemZoomControl Class
Members  Example 


Dovetail.Ecommerce.Controls Namespace : CatalogItemZoomControl Class

A catalog Item zoom control.

Remarks

The CatalogItemZoomControl displays zoomable images associated with an Item. Below these images, the control also displays a normal-sized image and all associated thumbnail-sized images.

If there is a zoomed image of the normal-sized one, the "zoom" display instead appears upon mouse-over. Upon clicking any of the thumbnails, the normal-sized and zoom-sized (if available) images shift.

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 ItemLinkName gets or sets the name of the item link. If the main photo is not found the mainPhotoNotFound value indicates that finding.

The thumbnailSizePath gets or sets the full pathname of the thumbnail size file. If the thumbnail photo is not found the thumbnailPhotoNotFound value indicated that finding.

The normalSizePath gets or sets the full pathname of the normal size file and the zoomSizePath gets or sets the full pathname of the zoom size file.

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.

Example
See an example of how to configure this control in SitePages.config.
<Control src="CatalogItemZoomControl.ascx"
       thumbnailSizePath="/ECommerce/Site/images.ItemPhoto_Thumb/"
       normalSizePath="/ECommerce/Site/images/ItemPhoto_Normal/"
       zoomSizePath="/ECommerce/Site/images/ItemPhoto_Zoom/"
       mainPhotoNotFound="true"
       thumbnailPhotoNotFound="true"
       ItemLinkName=""
       />
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 AutoEventWireup="True" CodeBehind="CatalogItemZoomControl.ascx.cs" Inherits="Dovetail.Ecommerce.Controls.CatalogItemZoomControl"
    Language="c#" %>
<!--  ###### JQuery Zoom used for zooming galleries - from here: http://mind-projects.it/projects/jqzoom/ ###### -->
<div class="photogallerydiv">
    <div class="zoomphotoimage">
        <asp:Literal ID="ltrMainPhoto" runat="server"></asp:Literal>
    </div>
    <div class="zoomphotothumbs">
        <asp:Literal ID="ltrPhotoGallery" runat="server"></asp:Literal>
    </div>
</div>
Inheritance Hierarchy

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

See Also

Reference

CatalogItemZoomControl Members
Dovetail.Ecommerce.Controls Namespace