CyberStore Documentation
CustomerChangePasswordControl Class
Members  Example 

Dovetail.Ecommerce.Controls Namespace : CustomerChangePasswordControl Class
An Account change password control. Introduced in v2.15.

The CustomerChangePasswordControl provides a user with the ability to modify their login password. It can be used directly without requiring the user to go through the multi-step edit Account process. 


When the user visits a page with the control on it, they must be already logged in to use the feature. Then to change their password, they will be required to enter their current password, the new desired password and confirm the changed password before they can submit. Validation will be performed to ensure that the user has entered the correct current password and that the minimum password requirements are met.

Once the user has entered the desired information without validation errors, they may click the Submit button to save the update. They will then be sent a change password verification email to the address of the account. The message contains a 6 digit code that must be used to complete the process. 



The password will only change once the confirmation code has been confirmed. The previous password will stay in effect until the process completes. If the verification code is not confirmed within 24 hours of the change password submission, it will expire erasing the new password and leaving the existing password in tact until it can be successfully changed. 

To confirm the change request, return to the site's change password page and submit the verification code in your email. 

After successfully entering the code, the password update is complete. The SuccessMessageText is displayed and then the user is redirected to the SuccessRedirectUrl

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.

Button, Instruction and Label Text Properties

The buttons used in the control can be customized using the SubmitButtonTextCancelButtonText, and ConfirmButtonText properties.

Instructions are displayed to users when using the control. These messages can be modified using the ChangePasswordInstrucitonText and VerficationCodeInstrucitonText properties.

All of the field labels for inputs within the control can be changed as desired using the CurrentPasswordLabelTextNewPasswordLabelTextConfirmNewPasswordLabelText, and VerificationCodeLabelText properties.

Messaging Text Properties

Messages seen in the process of requesting and verifying a password change can be customized using the ConfirmNewPasswordMismatchMessageTextCurrentPasswordMismatchMessageTextSuccessMessageTextVerificationCodeExpirationMessageText, and VerificationCodeMismatchMessageText properties.

URL Properties

The page URLs used by the control can be customized using the LoginPageUrl and SuccessRedirectUrl properties.

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="CustomerChangePasswordControl.ascx" Name="Change Password"
    CurrentPasswordLabelText="Current Password"
    NewPasswordLabelText="New Password"
    ConfirmNewPasswordLabelText="Confirm New Password"
    VerificationCodeLabelText="Verification Code"
    CurrentPasswordMismatchMessageText="The password input is incorrect"
    NewPasswordInvalidMessageText="The new password must be at least 5 characters long"
    ConfirmNewPasswordMismatchMessageText="The confirm new password does not match the new password"
    VerificationCodeMismatchMessageText="The entered verification code is incorrect"
    VerificationCodeExpirationMessageText="Verification code expiration"
    SuccessMessageText="Your password has been successfully changed."
    ChangePasswordInstructionText="To change your password, enter your current password followed by 
        entering your new password twice. After submitting, a verification code will be sent to 
        the email address on file to confirm the request."
    VerificationCodeInstructionText="Before we change your password, you must confirm the request. 
        Type the change password verification code that has been sent to the email address on file 
        for your account. This change password request will remain valid for 24 hours from the time 
        it was first submitted. Until verified your original password will remain in effect."
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="CustomerChangePasswordControl.ascx.cs" Inherits="Dovetail.Ecommerce.Controls.CustomerChangePasswordControl" %>

<script type="text/javascript">

    function ValidateCurrentPassword(password) {
        var Params = { 'passwordInput': password };

        MakeAJAXCall('ValidateCurrentPassword', Params, ValidatePasswordComplete);

    function ValidatePasswordComplete(Data) {

    function EnableSubmitIfValid() {
        //if all fields non empty
        if (txtCurrPass.GetText().length > 0 && txtNewPass.GetText().length > 0 && txtConfirmNewPass.GetText().length > 0) {
            //if all fields valid
            if (txtCurrPass.GetIsValid() && txtNewPass.GetIsValid() && txtConfirmNewPass.GetIsValid()) {
            else {

    function ValidateConfirmNewPassword() {
        if (txtNewPass.GetText() == txtConfirmNewPass.GetText()) { txtConfirmNewPass.SetIsValid(true); } else { txtConfirmNewPass.SetIsValid(false); }

<dx:ASPxLabel ID="lblInstructions" runat="server" ClientIDMode="Static" Visible="true" />
<dx:ASPxPanel ID="pnlStepOne" runat="server" ClientIDMode="Static" CssClass="col-xs-6 changepasswordsteponewrapper" Visible="false">
            <div class="row">
            <div class="col-sm-5 changepasswordlabel changepasswordcurrentpasswordlabel">
                <dx:ASPxLabel ID="lblCurrPass" runat="server" ClientIDMode="Static" ClientInstanceName="lblCurrPass" />
            <div class="col-sm-6 changepasswordfield changepasswordcurrentpasswordtextbox">
                <dx:ASPxTextBox ID="txtCurrPass" runat="server" ClientIDMode="Static" ClientInstanceName="txtCurrPass" CssClass="FormField" Password="true" OnValidation="txtCurrPass_Validation" >
                    <ClientSideEvents Validation="function(s,e){ValidateCurrentPassword(e.value); EnableSubmitIfValid();}" />
                    <ValidationSettings SetFocusOnError="true" ValidateOnLeave="true" EnableCustomValidation="true"/>
            <div class="row">
            <div class="col-sm-5 changepasswordlabel changepasswordnewpasswordlabel">
                <dx:ASPxLabel ID="lblNewPass" runat="server" ClientIDMode="Static" ClientInstanceName="lblNewPass" />
            <div class="col-sm-6 changepasswordfield changepasswordnewpasswordtextbox">
                <dx:ASPxTextBox ID="txtNewPass" runat="server" ClientIDMode="Static" ClientInstanceName="txtNewPass" CssClass="FormField" Password="true" OnValidation="txtNewPass_Validation">
                    <ClientSideEvents Validation="function(s,e){ if (txtNewPass.GetText().length > 4) { e.isValid = true; ValidateConfirmNewPassword(); } else { e.isValid = false; } EnableSubmitIfValid(); }" />
                    <ValidationSettings SetFocusOnError="true" ValidateOnLeave="true" />
            <div class="row">
            <div class="col-sm-5 changepasswordlabel changepasswordconfirmpasswordlabel">
                <dx:ASPxLabel ID="lblConfirmNewPass" runat="server" ClientIDMode="Static" ClientInstanceName="lblConfirmNewPass" />
            <div class="col-sm-6 changepasswordfield changepasswordconfirmpasswordtextbox">
                <dx:ASPxTextBox ID="txtConfirmNewPass" runat="server" ClientIDMode="Static" ClientInstanceName="txtConfirmNewPass" CssClass="FormField" Password="true" OnValidation="txtConfirmNewPass_Validation" >
                    <ClientSideEvents KeyUp="function(s,e){ if (txtNewPass.GetText() == txtConfirmNewPass.GetText()) { txtConfirmNewPass.SetIsValid(true); } else { txtConfirmNewPass.SetIsValid(false); } EnableSubmitIfValid();}" Validation="function(s,e){ if (txtNewPass.GetText() == txtConfirmNewPass.GetText()) { e.isValid = true; } else { e.isValid = false; } EnableSubmitIfValid();}" />
                    <ValidationSettings SetFocusOnError="true" ValidateOnLeave="true"/>
<dx:ASPxPanel ID="pnlStepTwo" runat="server" ClientIDMode="Static" CssClass="col-xs-6 changepasswordsteptwowrapper" Visible="false">
            <div class="col-sm-4 changepasswordlabel changepasswordverificationlabel">
                <dx:ASPxLabel ID="lblVerifCode" runat="server" ClientIDMode="Static" ClientInstanceName="lblVerifCode" />
            <div class="col-sm-6 changepasswordfield changepasswordverificationtextbox">
                <dx:ASPxTextBox ID="txtVerifCode" runat="server" ClientIDMode="Static" ClientInstanceName="txtVerifCode" CssClass="FormField" OnValidation="txtVerifCode_Validation" >
                    <ValidationSettings SetFocusOnError="true" ValidateOnLeave="false" CausesValidation="true"/>

        <div class="col-xs-6 btnWrapper" >
            <dx:ASPxButton ID="btnSubmit" CssClass="btn" runat="server" ClientIDMode="Static" ClientInstanceName="btnSubmit" Visible="false" ClientEnabled="false" AutoPostBack="false" OnClick="btnSubmit_Click" />
            <dx:ASPxButton ID="btnConfirm" CssClass="btn" runat="server" ClientIDMode="Static" ClientInstanceName="btnConfirm" Visible="false" AutoPostBack="false" OnClick="btnConfirm_Click" />
            <dx:ASPxButton ID="btnCancel" CssClass="btn" runat="server" ClientIDMode="Static" ClientInstanceName="btnCancel" Visible="false" OnClick="btnCancel_Click" CausesValidation="false"/>

<dx:ASPxPopupControl ID="popSuccess" runat="server" Modal="True" PopupHorizontalAlign="WindowCenter" PopupVerticalAlign="WindowCenter" CssClass="SuccessModal" ClientInstanceName="popSuccess" ShowHeader="false" PopupAnimationType="None" EnableViewState="False" ShowCloseButton="false" >
        <dx:PopupControlContentControl runat="server">
            <dx:ASPxButton ID="btnOk" CssClass="btn" runat="server" Text="OK" AutoPostBack="false" OnClick="btnOk_Click" />
Inheritance Hierarchy


See Also


CustomerChangePasswordControl Members
Dovetail.Ecommerce.Controls Namespace