Click or drag to resize
ShoppingCart Class
Summary description for ShoppingCart.
Inheritance Hierarchy

Namespace: CMS.Ecommerce.Web.UI
Assembly: CMS.Ecommerce.Web.UI (in CMS.Ecommerce.Web.UI.dll) Version: 12.0.0
Syntax
C#
public class ShoppingCart : CMSAdminControl

The ShoppingCart type exposes the following members.

Constructors
  NameDescription
Public methodShoppingCart
Top
Fields
  NameDescription
Public fieldStatic memberDEFAULT_CHECKOUT_PROCESS
Default checkout process XML definition.
Public fieldStatic memberDEFAULT_REQUIRED_FIELDS_MARK
Default required field marker. Contains html code with styled asterisk.
Protected fieldmAddToShoppingCartConversionValue
Conversion track value used after added to shopping cart.
Protected fieldmAddToShoppingCartTrackConversionName
Conversion track name used after added to shopping cart.
Protected fieldmAssignToRoles
Roles the new user should be assign to after his registration.
Protected fieldmAssignToSites
Sites the new user should be assign to after his registration.
Protected fieldmCheckoutProcess
Checkout process.
Protected fieldmCheckoutProcessSteps
Checkout process steps.
Protected fieldmCheckoutProcessType
Type of the checkout process.
Protected fieldmCurrentStepControl
Shopping cart current step control.
Protected fieldmEnablePasswordRetrieval
Indicates whether password retrieval is enabled.
Protected fieldmEnableProductPriceDetail
Indicates whether product price detail link is displayed.
Protected fieldmImageFolderPath
Relative path to the folder with shopping cart step images.
Protected fieldmImageStepSeparator
HTML code of the image step separator.
Protected fieldmIsControlLoaded
Indicates if current step control is loaded.
Protected fieldmIsCurrentStepPostBack
Indicates whether current step control is loaded after postback.
Protected fieldmLocalShoppingCart
Local shopping cart object.
Protected fieldmNextStepIndex
Next step index.
Protected fieldmOrderConversionValue
Conversion track value used after new order is saved.
Protected fieldmOrderTrackConversionName
Conversion track name used after new order is saved.
Protected fieldmPaymentGatewayProvider
Payment gateway provider.
Protected fieldmPreviousStepIndex
Previous step index.
Protected fieldmRedirectAfterPurchase
Redirect after purchase.
Protected fieldmRegistrationConversionValue
Conversion track value used after successful registration.
Protected fieldmRegistrationTrackConversionName
Conversion track name used after successful registration.
Protected fieldmRequiredFieldsMark
HTML code which is attached as postfix to the shopping cart step form required fields.
Protected fieldmSendNewRegNotificationToAddress
Email address the new registration notification should be sent to.
Protected fieldmShoppingCartContainer
Shopping cart container.
Protected fieldmShoppingCartObj
Shopping cart object.
Top
Properties
  NameDescription
Public propertyAssignToRoles
Roles the new user should be assign to after his registration.
Public propertyAssignToSites
Sites the new user should be assign to after his registration.
Public propertyButtonBack
Button 'Back' - you need to override this property to get access to shopping cart 'Back' button in shopping cart steps.
Public propertyButtonNext
Button 'Next' - you need to override this property to get access to shopping cart 'Next' button in shopping cart steps.
Protected propertyCheckoutProcess
Checkout process.
Public propertyCheckoutProcessSteps
Checkout process steps.
Public propertyCheckoutProcessType
Checkout process type.
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyControlContext
Control context.
(Inherited from CMSUserControl.)
Public propertyCurrentContactID
Current contact ID. Shared across shopping cart steps.
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentResolver
Control's resolver
(Inherited from CMSUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentStepControl
Shopping cart current step control.
Public propertyCurrentStepIndex
Shopping cart current step index.
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDisplayMode
Gets or sets display mode of the control.
(Inherited from CMSUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from CMSUserControl.)
Public propertyEnablePasswordRetrieval
Indicates whether password retrieval is enabled.
Public propertyEnableProductPriceDetail
Indicates whether product price detail link is displayed.
Public propertyErrorMessage
Error message.
(Inherited from CMSAdminControl.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyImageFolderPath
Relative path to the folder with shopping cart step images.
Public propertyImageStepSeparator
HTML code of the image step separator.
Public propertyInfoMessage
Information message.
(Inherited from CMSAdminControl.)
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.)
Public propertyIsCurrentStepPostBack
Indicates whether current step control is loaded after postback.
Public propertyIsInternalOrder
Indicates whether it is an internal order made from administration.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyLocalShoppingCart
Local shopping cart object.
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyNextStepIndex
Next step index. (Set it if you want to load another step with index different from CurrentStepIndex + 1).
Public propertyOrderTrackConversionName
Conversion track name used after new order is saved.
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Public propertyPaymentGatewayProvider
Payment gateway provider instance.
Public propertyPreviousPageUrl
Page url, we should return to after "Continue shopping" button is clicked.
Public propertyPreviousStepIndex
Previous step index. (Set it if you want to load another step with index different from CurrentStepIndex - 1).
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyRedirectAfterPurchase
Redirect after purchase.
Public propertyRedirectToAccessDeniedPage
Redirect to access denied if the access is not allowed.
(Inherited from CMSAdminControl.)
Public propertyRegistrationTrackConversionName
Conversion track name used after successful registration.
Public propertyRequiredFieldsMark
HTML code which is attached as postfix to the shopping cart step form required fields.
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertySendNewRegistrationNotificationToAddress
Email address the new registration notification should be sent to.
Public propertyShoppingCartContainer
Shopping cart container.
Public propertyShoppingCartInfoObj
Shopping cart object.
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyUIContext
Control's UI Context
(Inherited from CMSUserControl.)
Public propertyUseCMSDeskAccessDeniedPage
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.)
Public propertyUserInfo
User info - returns shopping cart user, if not specified returns current user.
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Top
Methods
  NameDescription
Public methodAccessDenied(String)
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.)
Public methodAccessDenied(Int32, String)
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.)
Public methodAccessDenied(String, String)
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.)
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodButtonBackClickAction
Standard action after the 'Back button' is clicked - Loads previous step.
Public methodButtonNextClickAction
Standard action after the 'Next button' is clicked - 1. Validates current step, 2. Process current step information, 3. Loads next step.
Public methodCheckPermissions(String, String)
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.)
Public methodCheckPermissions(String, String, Int32)
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.)
Public methodCheckPermissions(String, String, String)
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.)
Public methodCleanUpShoppingCart
Removes current shopping cart data from database and from session.
Public methodClearForm
Clears control.
(Inherited from CMSAdminControl.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodGetAccessDeniedPageUrl
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetRedirectAfterPurchaseUrl
Returns url the customer should be redirected to after purchase.
Public methodGetShoppingCartStepControl(Int32)
Returns initialized shopping cart step control.
Public methodGetShoppingCartStepControl(String)
Returns initialized shopping cart step control.
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodGetTempValue
Returns the value from the ShoppingCart viewstate.
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Public methodLoadCheckoutProcess
Loads checkout process from external source.
Public methodLoadCurrentStep
Loads current step - you need to override this method to load current step control.
Public methodLoadStep(Int32)
Loads step control with specified index and set current step index to control index.
Public methodLoadStep(String)
Loads step control with specified name and set current step index to control index.
Public methodLoadStep(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 methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event handler.
(Inherited from AbstractUserControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Public methodRaiseOnCheckPermissions(String, CMSAdminControl)
Raises the OnCheckPermissions event, returns true when event was fired.
(Inherited from CMSAdminControl.)
Public methodRaiseOnCheckPermissions(String, String, CMSAdminControl)
Raises the OnCheckPermissions event, returns true when event was fired.
(Inherited from CMSAdminControl.)
Public methodRaiseOnNotAllowed
Raises the OnNotAllowed event.
(Inherited from CMSAdminControl.)
Public methodRaiseOrderCompletedEvent
Raises order completed event - after the order is completed (all its data are saved in database).
Public methodRaisePaymentCompletedEvent
Raises payment completed event - after the order payments is completed.
Public methodRaisePaymentSkippedEvent
Raises payment skipped event - after the order payments is skipped.
Public methodRedirectToAccessDenied(String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(Int32, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(String, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToUIElementAccessDenied
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSUserControl.)
Public methodReloadData
Reloads control data without force reload.
(Inherited from CMSAdminControl.)
Public methodReloadData(Boolean)
Reloads control data.
(Inherited from CMSAdminControl.)
Public methodReloadShoppingCartInfo
Reloads shopping cart items and settings from database.
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetContext
Sets the control context.
(Inherited from CMSUserControl.)
Public methodSetTempValue
Sets the value to the ShoppingCart viewstate.
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodTrackActivityAllProductsRemovedFromShoppingCart
Logs activity "product removed from shopping cart" for all items in shopping cart.
Public methodTrackActivityProductAddedToShoppingCart
Logs activity "product added to shopping cart".
Public methodTrackActivityPurchase
Logs activity "purchase".
Public methodTrackActivityPurchasedProducts
Logs activity "purchase" for all items.
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
Top
Extension Methods
  NameDescription
Public Extension MethodCallHandled
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventOnCheckPermissions
On check permissions event.
(Inherited from CMSAdminControl.)
Public eventOnCheckPermissionsExtended
On check permissions event.
(Inherited from CMSAdminControl.)
Public eventOnNotAllowed
On not allowed event.
(Inherited from CMSAdminControl.)
Public eventOnOrderCompleted
Fires after the order is completed - all its data are saved in database.
Public eventOnPaymentCompleted
Fires after the order payment completed.
Public eventOnPaymentSkipped
Fires after the order payment is skipped.
Top
See Also