ShoppingCart Class

Summary description for ShoppingCart.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.Base.Web.UI.InlineUserControl
            CMS.UIControls.CMSUserControl
              CMS.UIControls.CMSAdminControl
                CMS.Ecommerce.Web.UI.ShoppingCart

Namespace: CMS.Ecommerce.Web.UI
Assembly: CMS.Ecommerce.Web.UI (in CMS.Ecommerce.Web.UI.dll) Version: 10.0.0

Syntax

public class ShoppingCart : CMSAdminControl

The ShoppingCart type exposes the following members.

Constructors

	Name	Description
Public method	ShoppingCart

Fields

	Name	Description
Public field Static member	DEFAULT_CHECKOUT_PROCESS	Default checkout process XML definition.
Public field Static member	DEFAULT_REQUIRED_FIELDS_MARK	Default required field marker. Contains html code with styled asterisk.
Protected field	mAddToShoppingCartConversionValue	Conversion track value used after added to shopping cart.
Protected field	mAddToShoppingCartTrackConversionName	Conversion track name used after added to shopping cart.
Protected field	mAssignToRoles	Roles the new user should be assign to after his registration.
Protected field	mAssignToSites	Sites the new user should be assign to after his registration.
Protected field	mCurrentStepControl	Shopping cart current step control.
Protected field	mEnablePasswordRetrieval	Indicates whether password retrieval is enabled.
Protected field	mEnableProductPriceDetail	Indicates whether product price detail link is displayd.
Protected field	mCheckoutProcess	Checkout process.
Protected field	mCheckoutProcessSteps	Checkout process steps.
Protected field	mCheckoutProcessType	Type of the checkout process.
Protected field	mImageFolderPath	Relative path to the folder with shopping cart step images.
Protected field	mImageStepSeparator	HTML code of the image step separator.
Protected field	mIsControlLoaded	Indicates if current step control is loaded.
Protected field	mIsCurrentStepPostBack	Indicates whether current step control is loaded after postback.
Protected field	mLocalShoppingCart	Local shopping cart object.
Protected field	mNextStepIndex	Next step index.
Protected field	mOrderConversionValue	Conversion track value used after new order is saved.
Protected field	mOrderTrackConversionName	Conversion track name used after new order is saved.
Protected field	mPaymentGatewayProvider	Payment gateway provider.
Protected field	mPreviousStepIndex	Previsou step index.
Protected field	mRedirectAfterPurchase	Redirect after purchase.
Protected field	mRegistrationConversionValue	Conversion track value used after successful registration.
Protected field	mRegistrationTrackConversionName	Conversion track name used after successful registration.
Protected field	mRequiredFieldsMark	HTML code which is attached as postfix to the shopping cart step form required fields.
Protected field	mSendNewRegNotificationToAddress	Email address the new registration notification should be sent to.
Protected field	mShoppingCartContainer	Shopping cart container.
Protected field	mShoppingCartObj	Shopping cart object.

Properties

	Name	Description
Public property	AssignToRoles	Roles the new user should be assign to after his registration.
Public property	AssignToSites	Sites the new user should be assign to after his registration.
Public property	ButtonBack	Button 'Back' - you need to override this property to get access to shopping cart 'Back' button in shopping cart steps.
Public property	ButtonNext	Button 'Next' - you need to override this property to get access to shopping cart 'Next' button in shopping cart steps.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ControlContext	Control context. (Inherited from CMSUserControl.)
Public property	ControlGUID	Unique ID of the control within the given request. (Inherited from CMSUserControl.)
Public property	CurrentContactID	Current contact ID. Shared across shopping cart steps.
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentResolver	Control's resolver (Inherited from CMSUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentStepControl	Shopping cart current step control.
Public property	CurrentStepIndex	Shopping cart current step index.
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DisplayMode	Gets or sets display mode of the control. (Inherited from CMSUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from CMSUserControl.)
Public property	EnablePasswordRetrieval	Indicates whether password retrieval is enabled.
Public property	EnableProductPriceDetail	Indicates whether product price detail link is displayed.
Public property	ErrorMessage	Error message. (Inherited from CMSAdminControl.)
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Protected property	CheckoutProcess	Checkout process.
Public property	CheckoutProcessSteps	Checkout process steps.
Public property	CheckoutProcessType	Checkout process type.
Public property	ImageFolderPath	Relative path to the folder with shopping cart step images.
Public property	ImageStepSeparator	HTML code of the image step separator.
Public property	InfoMessage	Information message. (Inherited from CMSAdminControl.)
Public property	IsCMSDesk	Determines whether the current control lies on the page that is currently located under the CMS Desk. (Inherited from CMSUserControl.)
Public property	IsCurrentStepPostBack	Indicates whether current step control is loaded after postback.
Public property	IsInternalOrder	Indicates whether it is an internal order made from administration.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Public property	LocalShoppingCart	Local shopping cart object.
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	NextStepIndex	Next step index. (Set it if you want to load another step with index different from CurrentStepIndex + 1).
Public property	OrderTrackConversionName	Conversion track name used after new order is saved.
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Public property	PaymentGatewayProvider	Payment gateway provider instance.
Public property	PreviousPageUrl	Page url, we should return to after "Continue shopping" button is clicked.
Public property	PreviousStepIndex	Previous step index. (Set it if you want to load another step with index different from CurrentStepIndex - 1).
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	RedirectAfterPurchase	Redirect after purchase.
Public property	RedirectToAccessDeniedPage	Redirect to access denied if the access is not allowed. (Inherited from CMSAdminControl.)
Public property	RegistrationTrackConversionName	Conversion track name used after successful registration.
Public property	RelativePath	Page relative path. (Inherited from CMSUserControl.)
Public property	RequiredFieldsMark	HTML code which is attached as postfix to the shopping cart step form required fields.
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	SendNewRegistrationNotificationToAddress	Email address the new registration notification should be sent to.
Public property	ShoppingCartContainer	Shopping cart container.
Public property	ShoppingCartInfoObj	Shopping cart object.
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	TypeName	Returns the object type name. (Inherited from CMSUserControl.)
Public property	UIContext	Control's UI Context (Inherited from CMSUserControl.)
Public property	UseCMSDeskAccessDeniedPage	Gets or sets the value that indicates whether CMSDesk access denied page should be used. (Inherited from CMSUserControl.)
Public property	UserInfo	User info - returns shopping cart user, if not specified returns current user.
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)

Methods

	Name	Description
Public method	AccessDenied(String)	Ensure access denied actions due to settings. (Inherited from CMSAdminControl.)
Public method	AccessDenied(Int32, String)	Ensure access denied actions due to settings. (Inherited from CMSAdminControl.)
Public method	AccessDenied(String, String)	Ensure access denied actions due to settings. (Inherited from CMSAdminControl.)
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	ButtonBackClickAction	Standard action after the 'Back button' is clicked - Loads previous step.
Public method	ButtonNextClickAction	Standard action after the 'Next button' is clicked - 1. Validates current step, 2. Process current step information, 3. Loads next step.
Public method	CleanUpShoppingCart	Removes current shopping cart data from database and from session.
Public method	ClearForm	Clears control. (Inherited from CMSAdminControl.)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Protected method	GetAccessDeniedPageUrl	Returns access denied page with dependence on current setting. (Inherited from CMSUserControl.)
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetRedirectAfterPurchaseUrl	Returns url the customer should be redirected to after purchase.
Public method	GetShoppingCartStepControl(Int32)	Returns initialized shopping cart step control.
Public method	GetShoppingCartStepControl(String)	Returns initialized shopping cart step control.
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	GetTempValue	Returns the value from the ShoppingCart viewstate.
Public method	GetValue(String)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Public method	CheckPermissions(String, String)	Check permissions for specified resource and permission type, return false is user doesn't have permissions. (Inherited from CMSAdminControl.)
Public method	CheckPermissions(String, String, Int32)	Check permissions for specified resource and permission type, return false is user doesn't have permissions. (Inherited from CMSAdminControl.)
Public method	CheckPermissions(String, String, String)	Check permissions for specified resource and permission type, return false is user doesn't have permissions. (Inherited from CMSAdminControl.)
Public method	LoadCurrentStep	Loads current step - you need to override this method to load current step control.
Public method	LoadCheckoutProcess	Loads checkout process from external source.
Public method	LoadStep(Int32)	Loads step control with specified index and set current step index to control index.
Public method	LoadStep(String)	Loads step control with specified name and set current step index to control index.
Public method	LoadStep(ShoppingCartStep)	Loads specified shopping cart step control and set current step index to control index (step is included in current checkout process) or leave current step index as is (when loading external control which is not defined in current checkout process).
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	OnLoad override, setup access denied page with dependence on current usage. (Inherited from CMSUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Public method	RaiseOnCheckPermissions(String, CMSAdminControl)	Raises the OnCheckPermissions event, returns true when event was fired. (Inherited from CMSAdminControl.)
Public method	RaiseOnCheckPermissions(String, String, CMSAdminControl)	Raises the OnCheckPermissions event, returns true when event was fired. (Inherited from CMSAdminControl.)
Public method	RaiseOnNotAllowed	Raises the OnNotAllowed event. (Inherited from CMSAdminControl.)
Public method	RaiseOrderCompletedEvent	Raises order completed event - after the order is completed (all its data are saved in database).
Public method	RaisePaymentCompletedEvent	Raises payment completed event - after the order payments is completed.
Public method	RaisePaymentSkippedEvent	Raises payment skipped event - after the order payments is skipped.
Public method	RedirectToAccessDenied(String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(Int32, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(String, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToUIElementAccessDenied	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Public method	ReleaseContext	Releases the control context. (Inherited from CMSUserControl.)
Public method	ReloadData()	Reloads control data without force reload. (Inherited from CMSAdminControl.)
Public method	ReloadData(Boolean)	Reloads control data. (Inherited from CMSAdminControl.)
Public method	ReloadShoppingCartInfo	Reloads shopping cart items and settings from database.
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SetContext	Sets the control context. (Inherited from CMSUserControl.)
Public method	SetTempValue	Sets the value to the ShoppingCart viewstate.
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	TrackActivityAllProductsRemovedFromShoppingCart	Logs activity "product removed from shopping cart" for all items in shopping cart.
Public method	TrackActivityProductAddedToShoppingCart(SKUInfo, Int32)	Logs activity "product added to shopping cart".
Public method	TrackActivityProductAddedToShoppingCart(Int32, String, Int32, String, String, Int32)	Obsolete. Logs activity "product added to shopping cart".
Public method	TrackActivityPurchase	Logs activity "purchase".
Public method	TrackActivityPurchasedProducts	Logs activity "purchase" for all items.
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)

Extension Methods

	Name	Description
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnCheckPermissions	On check permissions event. (Inherited from CMSAdminControl.)
Public event	OnCheckPermissionsExtended	On check permissions event. (Inherited from CMSAdminControl.)
Public event	OnNotAllowed	On not allowed event. (Inherited from CMSAdminControl.)
Public event	OnOrderCompleted	Fires after the order is completed - all its data are saved in database.
Public event	OnPaymentCompleted	Fires after the order payment completed.
Public event	OnPaymentSkipped	Fires after the order payment is skipped.