System.Web
2.0.0.0
System.Web.UI.WebControls.Wizard
System.ComponentModel.Bindable(false)
In this topic:
-
Introduction
-
Creating a User
-
Styles and Templates
-
Validation Grouping
-
Formatting Using Layout Templates
-
Accessibility
-
Declarative Syntax
Introduction
The control provides the user interface for the object that communicates with your Web site's user data store to create new user accounts in the data store. The relies on the to create the user and disable them if necessary.
If you are not familiar with ASP.NET login controls, you might find it helpful to read ASP.NET Login Controls Overview before continuing. For a list of other topics related to login controls and membership, see Managing Users By Using Membership.
By default, the control will accept a user name and password from the Web site visitor. Based on the requirements of the site's object, the control will optionally accept an e-mail address, represented by the property, and a password recovery confirmation question and answer, represented by and . For a table showing all required and optional controls for , see .
If is set to true and the property is set in the application's Web.config file, you could potentially generate a password that does not pass the regular expression strength test. In this case, creating a user raises an error that indicates an invalid password.
Creating a User
When a user is created with the , the control interacts with the current to accomplish the following tasks in order.
-
Create a password if is set to true.
-
Create the user in the data store that the represents.
-
Disable the user in the store if the property is set to true.
You can extend the control to accept additional information by adding additional fields, or by adding additional steps before or after the provided templates in the and properties.
The step is the first step within the control, and is a required step. By default, the property is set to false to keep the user from returning to the step and accidentally attempting to create another user account with the same credentials. If is set to false, the property is not maintained in view state and you must include logic in your application to maintain the value.
control properties represented by text boxes, such as , are accessible during all phases of the page life cycle. The control will pick up any changes made by the end user by means of the event raised by the text boxes.
The control can optionally send e-mail messages to new users if you have configured an SMTP mail server to send e-mail. For more information, see the property.
The control uses Internet e-mail services to send login information to users. There are inherent security risks with sending passwords in e-mail. You should determine whether these security risks are acceptable to your site.
Styles and Templates
When the control is not customized with templates, the property of the control applies to the first text box in the control and the property, which is applied to all text boxes of the control. If the control is customized with templates, then the property and the property are ignored. In this case, directly set the property and the property of each template child control.
control properties represented by text boxes, such as and , are accessible during all phases of the page life cycle. The control will pick up any changes made by the end user by means of the event raised by the text boxes.
Setting the , , or property recreates the child controls of the control, and their control state is lost in the process. To avoid this situation, explicitly maintain the control state of the control's child controls, or avoid putting controls inside of templates.
The following table lists the control style properties and explains which UI element each style property affects. For a list of which properties each style applies to, see the documentation for the individual style properties.
-
Style property
UI element affected
-
Continue button.
-
Create User button.
-
Links to other pages.
-
Instructional text on the page that tells users how to use the control.
-
Labels for all input fields, such as text boxes.
-
Text entry input fields.
-
Title text for each view.
-
Text displayed to the user when the password recovery or reset attempt is successful.
-
Error messages when the membership provider fails to create a new user account.
-
The text that describes password requirements.
-
Error messages associated with validation.
Validation Grouping
The control uses a validation group so that other fields on the same page as the control can be validated separately. By default, the property of the control is used as the name of the validation group. For example, a control with the ID "CreateUserWizard1" will use a validation group name of "CreateUserWizard1". If you want to set the validation group that the control is part of, you must template the control and change the validation group name.
Note that the class inherits from the class, which does not support special Microsoft Internet Explorer rendering for non-standard or quirks mode. The does not attempt to optimize rendering for non-standard Internet Explorer mode. To get the best Internet Explorer rendering using the control, use the XHTML doc type, which is added by default in Visual Web Developer and Visual Studio.
Formatting Using Layout Templates
The control lets you specify the layout of the control without requiring you to use an HTML table element. Instead, you can use a LayoutTemplate element to specify the layout. In the layout template, you create placeholder controls to indicate where items should be dynamically inserted into the control. (This is similar to how the template model for the control works.) For more information, see the property.
Accessibility
For information about how to configure this control so that it generates markup that conforms to accessibility standards, see Accessibility in Visual Studio 2010 and ASP.NET 4 and ASP.NET Controls and Accessibility.
Declarative Syntax
<asp:CreateUserWizard
AccessKey="string"
ActiveStepIndex="integer"
Answer="string"
AnswerLabelText="string"
AnswerRequiredErrorMessage="string"
AutoGeneratePassword="True|False"
BackColor="color name|#dddddd"
BorderColor="color name|#dddddd"
BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
Inset|Outset"
BorderWidth="size"
CancelButtonImageUrl="uri"
CancelButtonText="string"
CancelButtonType="Button|Image|Link"
CancelDestinationPageUrl="uri"
CellPadding="integer"
CellSpacing="integer"
CompleteSuccessText="string"
ConfirmPasswordCompareErrorMessage="string"
ConfirmPasswordLabelText="string"
ConfirmPasswordRequiredErrorMessage="string"
ContinueButtonImageUrl="uri"
ContinueButtonText="string"
ContinueButtonType="Button|Image|Link"
ContinueDestinationPageUrl="uri"
CreateUserButtonImageUrl="uri"
CreateUserButtonText="string"
CreateUserButtonType="Button|Image|Link"
CssClass="string"
DisableCreatedUser="True|False"
DisplayCancelButton="True|False"
DisplaySideBar="True|False"
DuplicateEmailErrorMessage="string"
DuplicateUserNameErrorMessage="string"
EditProfileIconUrl="uri"
EditProfileText="string"
EditProfileUrl="uri"
Email="string"
EmailLabelText="string"
EmailRegularExpression="string"
EmailRegularExpressionErrorMessage="string"
EmailRequiredErrorMessage="string"
Enabled="True|False"
EnableTheming="True|False"
EnableViewState="True|False"
FinishCompleteButtonImageUrl="uri"
FinishCompleteButtonText="string"
FinishCompleteButtonType="Button|Image|Link"
FinishDestinationPageUrl="uri"
FinishPreviousButtonImageUrl="uri"
FinishPreviousButtonText="string"
FinishPreviousButtonType="Button|Image|Link"
Font-Bold="True|False"
Font-Italic="True|False"
Font-Names="string"
Font-Overline="True|False"
Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
Large|X-Large|XX-Large"
Font-Strikeout="True|False"
Font-Underline="True|False"
ForeColor="color name|#dddddd"
HeaderText="string"
Height="size"
HelpPageIconUrl="uri"
HelpPageText="string"
HelpPageUrl="uri"
ID="string"
InstructionText="string"
InvalidAnswerErrorMessage="string"
InvalidEmailErrorMessage="string"
InvalidPasswordErrorMessage="string"
InvalidQuestionErrorMessage="string"
LoginCreatedUser="True|False"
MailDefinition-BodyFileName="uri"
MailDefinition-CC="string"
MailDefinition-From="string"
MailDefinition-IsBodyHtml="True|False"
MailDefinition-Priority="Normal|Low|High"
MailDefinition-Subject="string"
MembershipProvider="string"
OnActiveStepChanged="ActiveStepChanged event handler"
OnCancelButtonClick="CancelButtonClick event handler"
OnContinueButtonClick="ContinueButtonClick event handler"
OnCreatedUser="CreatedUser event handler"
OnCreateUserError="CreateUserError event handler"
OnCreatingUser="CreatingUser event handler"
OnDataBinding="DataBinding event handler"
OnDisposed="Disposed event handler"
OnFinishButtonClick="FinishButtonClick event handler"
OnInit="Init event handler"
OnLoad="Load event handler"
OnNextButtonClick="NextButtonClick event handler"
OnPreRender="PreRender event handler"
OnPreviousButtonClick="PreviousButtonClick event handler"
OnSendingMail="SendingMail event handler"
OnSendMailError="SendMailError event handler"
OnSideBarButtonClick="SideBarButtonClick event handler"
OnUnload="Unload event handler"
PasswordHintText="string"
PasswordLabelText="string"
PasswordRegularExpression="string"
PasswordRegularExpressionErrorMessage="string"
PasswordRequiredErrorMessage="string"
Question="string"
QuestionLabelText="string"
QuestionRequiredErrorMessage="string"
RequireEmail="True|False"
runat="server"
SkinID="string"
SkipLinkText="string"
StartNextButtonImageUrl="uri"
StartNextButtonText="string"
StartNextButtonType="Button|Image|Link"
StepNextButtonImageUrl="uri"
StepNextButtonText="string"
StepNextButtonType="Button|Image|Link"
StepPreviousButtonImageUrl="uri"
StepPreviousButtonText="string"
StepPreviousButtonType="Button|Image|Link"
Style="string"
TabIndex="integer"
ToolTip="string"
UnknownErrorMessage="string"
UserName="string"
UserNameLabelText="string"
UserNameRequiredErrorMessage="string"
Visible="True|False"
Width="size"
>
<CancelButtonStyle/>
<CompleteSuccessTextStyle/>
<ContinueButtonStyle/>
<CreateUserButtonStyle/>
<ErrorMessageStyle/>
<FinishCompleteButtonStyle/>
<FinishNavigationTemplate>
<!-- child controls -->
</FinishNavigationTemplate>
<FinishPreviousButtonStyle/>
<HeaderStyle/>
<HeaderTemplate>
<!-- child controls -->
</HeaderTemplate>
<HyperLinkStyle/>
<InstructionTextStyle/>
<LabelStyle/>
<MailDefinition
BodyFileName="uri"
CC="string"
From="string"
IsBodyHtml="True|False"
Priority="Normal|Low|High"
Subject="string"
>
<EmbeddedObjects>
<asp:EmbeddedMailObject
Name="string"
Path="uri"
/>
</EmbeddedObjects>
</MailDefinition>
<NavigationButtonStyle/>
<NavigationStyle/>
<PasswordHintStyle/>
<SideBarButtonStyle/>
<SideBarStyle/>
<SideBarTemplate>
<!-- child controls -->
</SideBarTemplate>
<StartNavigationTemplate>
<!-- child controls -->
</StartNavigationTemplate>
<StartNextButtonStyle/>
<StepNavigationTemplate>
<!-- child controls -->
</StepNavigationTemplate>
<StepNextButtonStyle/>
<StepPreviousButtonStyle/>
<StepStyle/>
<TextBoxStyle/>
<TitleTextStyle/>
<ValidatorTextStyle/>
<WizardSteps>
<asp:TemplatedWizardStep
AllowReturn="True|False"
ContentTemplateContainer="string"
EnableTheming="True|False"
EnableViewState="True|False"
ID="string"
OnActivate="Activate event handler"
OnDataBinding="DataBinding event handler"
OnDeactivate="Deactivate event handler"
OnDisposed="Disposed event handler"
OnInit="Init event handler"
OnLoad="Load event handler"
OnPreRender="PreRender event handler"
OnUnload="Unload event handler"
runat="server"
SkinID="string"
StepType="Auto|Complete|Finish|Start|Step"
Title="string"
Visible="True|False"
>
<ContentTemplate>
<!-- child controls -->
</ContentTemplate>
<CustomNavigationTemplate>
<!-- child controls -->
</CustomNavigationTemplate>
</asp:TemplatedWizardStep>
<asp:WizardStep
AllowReturn="True|False"
EnableTheming="True|False"
EnableViewState="True|False"
ID="string"
OnActivate="Activate event handler"
OnDataBinding="DataBinding event handler"
OnDeactivate="Deactivate event handler"
OnDisposed="Disposed event handler"
OnInit="Init event handler"
OnLoad="Load event handler"
OnPreRender="PreRender event handler"
OnUnload="Unload event handler"
runat="server"
SkinID="string"
StepType="Auto|Complete|Finish|Start|Step"
Title="string"
Visible="True|False"
/>
</WizardSteps>
</asp:CreateUserWizard>
Provides a user interface for creating new Web site user accounts.
Constructor
To be added.
Initializes a new instance of the class.
2.0.0.0
Property
System.Int32
To be added.
The property provides the zero-based index of the step that is currently displayed in the control. You can programmatically set the property to dynamically display a step to the user.
Gets or sets the step that is currently displayed to the user.
2.0.0.0
Property
System.Web.UI.Themeable(false)
System.ComponentModel.Localizable(true)
System.String
To be added.
The membership provider specified in the property will determine whether the question and answer text boxes are displayed at run time.
If an answer is required by the membership provider specified in the property, then the answer text box will appear on the control. Each text box displayed on the control has a object associated with it.
This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the end user's answer to the password recovery confirmation question.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text of the label that identifies the password confirmation answer text box.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the error message shown when the user does not enter an answer to the password confirmation question.
2.0.0.0
Property
System.Web.UI.Themeable(false)
System.Boolean
To be added.
The property makes it possible to create user accounts without entering a password for them. For example, this functionality is useful when an administrator creates a new user's account and then gives a password to the user.
You cannot create users using the if is set to true and the property is set in the application's Web.config. An error message indicating an invalid password will result.
Gets or sets a value indicating whether or not to automatically generate a password for the new user account.
2.0.0.0
Property
System.Web.UI.WebControls.CompleteWizardStep
To be added.
The property defines the final step for creating a user account. This property is read-only; however, you can set the properties of the object that returns.
Gets a reference to the final user account creation step.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
Use the property to change the message that is displayed when a user account is successfully created.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text displayed when a Web site user account is created successfully.
2.0.0.0
Property
System.Web.UI.WebControls.TableItemStyle
To be added.
The defines the appearance of the text displayed when a Web site user account is created successfully in the control. This property is read-only; however, you can set the properties of the object that it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, CompleteSuccessTextStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, CompleteSuccessTextStyle.ForeColor).
The property defines the appearance of the text displayed when a Web site user account is created successfully, after the user has clicked the Continue button on the step.
The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in properties of the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to a collection of properties that define the appearance of the text displayed when a Web site user account is created successfully.
2.0.0.0
Property
System.String
To be added.
The property contains the second password (the confirmation password) entered by the user. By default, a object is provided for the and text box values. Each text box displayed on the control also has a associated with it.
Gets the second password entered by the user.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the error message shown when the user enters two different passwords in the password and confirm password text boxes.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets text of the label for the second password text box.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the error message displayed when the user leaves the confirm password text box empty.
2.0.0.0
Event
System.EventHandler
The event is raised when the Continue button on the control is clicked. Use the event to provide additional processing when the Continue button is clicked.
For more information about handling events, see Consuming Events.
Occurs when the user clicks the Continue button in the final user account creation step.
2.0.0.0
Field
System.String
The field represents the value of the Continue button on the final step for creating a user account.
To assign continue functionality to any control contained in the control, set the property of the button to the string that is contained in the field.
The Continue button appears on the template for the final step for creating a user account, which is represented by the property. Clicking the Continue button redirects the user to the URL that is stored in the property. To add custom functionality to the Continue button, create an event handler for the event.
Represents the value of the Continue button on the final step for creating a user account. The field is read-only.
2.0.0.0
Property
System.String
To be added.
When the property is set to , use the property to specify the image to display for the Continue button.
Gets or sets the URL of an image used for the Continue button on the final user account creation step.
2.0.0.0
Property
System.Web.UI.WebControls.Style
To be added.
The property determines the appearance of the Continue button in the control, but you can override these settings using the property. This property is read-only; however, you can set the properties of the object it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, ContinueButtonStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, ContinueButtonStyle.ForeColor).
Common settings include custom background color, text color, and font properties.
The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to a collection of properties that define the appearance of the Continue button.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The property contains the text displayed for the control's Continue button. Depending on the value of the property, the property can appear as text on a button, as text displayed as an alternative to an image, or as the text of a link. The following table lists property values and their respective effects on the Continue button's text caption.
-
Text appears on the button.
-
Text appears as alternative text for the image.
-
Text appears as a link.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text caption displayed on the Continue button.
2.0.0.0
Property
System.Web.UI.WebControls.ButtonType
To be added.
To be added.
Gets or sets the type of button rendered as the Continue button.
2.0.0.0
Property
System.Web.UI.Themeable(false)
System.String
To be added.
The property contains the URL of the Web page that the user will see after successfully completing registration on your site. By setting the property, you can control the first page that newly registered users see.
When the property is and the user clicks the Continue button, the page is refreshed and any values on the form are cleared.
This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.
Gets or sets the URL of the page that the user will see after clicking the Continue button on the success page.
2.0.0.0
Method
2.0.0.0
System.Void
To be added.
Called by the ASP.NET page framework to notify this control to create any child controls that it contains in preparation for posting back or rendering.
Method
System.Void
To be added.
To be added.
2.0.0.0
Event
System.EventHandler
The event is raised after the membership provider specified in the property creates the new Web site user account. If the property is true, the user is logged on to the Web site after the event.
Use the event to set Web site values, such as personalization values, before the user is logged on to the site for the first time.
For more information about handling events, see Handling and Raising Events.
Occurs after the membership provider has created the new Web site user account.
2.0.0.0
Property
System.String
To be added.
When the property is set to , use the property to specify the image to display for the Create User button.
Gets or sets the URL of an image displayed for the Create User button.
2.0.0.0
Property
System.Web.UI.WebControls.Style
To be added.
The property defines the appearance of the Create User button in the control. This property is read-only; however, you can set the properties of the object it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, CreateUserButtonStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, CreateUserButtonStyle.ForeColor).
Common settings include custom background color, text color, and font properties.
The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to a collection of properties that define the appearance of the Create User button.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The property contains the text displayed for the control's Create User button. Depending on the value of the property, the property can appear as text on a button, as text displayed as an alternative to an image, or as the text of a link. The following table lists property values and their respective effects on the Create User button's text caption.
-
Text appears on the button.
-
Text appears as alternative text for the image.
-
Text appears as a link.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text caption displayed on the Create User button.
2.0.0.0
Property
System.Web.UI.WebControls.ButtonType
To be added.
To be added.
Gets or sets the type of button rendered as the Create User button.
2.0.0.0
Event
System.Web.UI.WebControls.CreateUserErrorEventHandler
The event is raised on the server when the membership provider specified in the property fails to create the specified user account.
The error handler is passed a object that contains the details of the failure from the membership provider. For a list of the possible error conditions, see .
For more information about handling events, see Consuming Events.
Occurs when the membership provider cannot create the specified user account.
2.0.0.0
Property
System.Web.UI.WebControls.CreateUserWizardStep
To be added.
The property defines the account creation step of a control. This property is read-only; however, you can set the properties of the object that returns.
The following table lists the required and optional controls that are supported when using templated content for the .
-
ID or command name
Control type
Required/optional
-
UserName
Any control that implements , including , or a custom or third-party control.
Required
-
Password
Any control that implements , including , or a custom or third-party control.
Required if is set to false.
-
Email
Any control that implements , including , or a custom or third-party control.
Required if is true.
-
ConfirmPassword
Any control that implements , including , or a custom or third-party control.
No requirements
-
Question
Any control that implements , including , or a custom or third-party control.
Optional unless required by membership.
-
Answer
Any control that implements , including , or a custom or third-party control.
Optional unless required by membership.
-
ErrorMessage
Any control that implements .
Optional
-
CreateUser
Any control that causes event bubbling
Optional
-
Cancel
Any
Optional
If the property is set to true and you are using templated content, the control is required; the control throws an exception if the control is not found or is of the wrong type. If is set to false, no exception is thrown if the control is not found. If the control is of the wrong type, it is ignored.
Similarly, if a membership provider requires a question and answer (determined by the property), the and controls are required and the throws an exception if they are not found or are of the wrong type. If they are not required by the membership provider, no exception is thrown if they are not found, and if they are of the wrong type they are ignored.
Gets a reference to the template for the user account creation step.
2.0.0.0
Event
System.Web.UI.WebControls.LoginCancelEventHandler
The event is raised prior to calling the method on the membership provider specified in the property.
Use the event to establish defaults or modify the information entered by the user before passing the information to the membership provider.
For more information about handling events, see Consuming Events.
Occurs before the membership provider is called to create the new Web site user account.
2.0.0.0
Property
System.Web.UI.Themeable(false)
System.Boolean
To be added.
The property determines if the newly created user account will be marked as disabled in the membership data store. When user accounts are marked as disabled, the accounts are not allowed to log on to the Web site. For example, if your Web site allows new users to request an account, but requires administrative approval before allowing access, set the property to true to disable newly created accounts until an administrator approves the account.
When is true, you should set the property to false so that the does not attempt to log on the new user.
This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.
Gets or sets a value indicating whether the new user should be allowed to log on to the Web site.
2.0.0.0
Property
System.Boolean
To be added.
To be added.
Gets or sets a value indicating whether to display the sidebar area of the control.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the error message displayed when the user enters an e-mail address that is already in use in the membership provider.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the error message displayed when the user enters a user name that is already in use in the membership provider.
2.0.0.0
Property
System.String
To be added.
To be added.
Gets or sets the URL of an image to display next to the link to the user profile editing page.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text caption for the link to the user profile editing page.
2.0.0.0
Property
System.String
To be added.
To be added.
Gets or sets the URL of the user profile editing page.
2.0.0.0
Property
System.String
To be added.
If an e-mail address is required by the membership provider specified in the property, then the e-mail address text box appears on the control. Each text box displayed on the control has a object associated with it.
Gets or sets the e-mail address entered by the user.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text of the label for the e-mail text box.
2.0.0.0
Property
System.String
To be added.
Use the property to specify a regular expression that validates the e-mail address entered by the user to confirm that it matches a specific pattern. A common use is to make sure that the user has entered a complete e-mail address, such as user@contoso.com. The regular expression is used in addition to any restrictions placed on the e-mail address by the membership provider specified in the property. If the membership provider rejects the e-mail address for any reason, the text contained in the property is displayed.
The address is only compared to the regular expression if the property is set to true.
If the e-mail address does not pass the regular expression, the text contained in the property is displayed to the user.
Gets or sets a regular expression used to validate the provided e-mail address.
2.0.0.0
Property
System.String
To be added.
Use the property to inform the user that the e-mail address entered did not pass the site's criteria for e-mail addresses.
Gets or sets the error message displayed when the entered e-mail address does not pass the site's criteria for e-mail addresses.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the error message shown to the user when an e-mail address is not entered in the e-mail text box.
2.0.0.0
Property
System.Web.UI.WebControls.TableItemStyle
To be added.
Use the property to change the appearance of error messages that are displayed when the membership provider fails to create a new user account. By default, the is set to display the following messages in red:
-
-
-
-
-
-
-
The property is read-only; however, you can set the properties of the object it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, ErrorMessageStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, ErrorMessageStyle.ForeColor).
Common settings include custom background color, text color, and font properties. The style settings for the property are merged with the style settings for the control. Any settings that are applied in the property override the corresponding settings in the properties of the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to a collection of style properties that define the appearance of error messages.
2.0.0.0
Method
System.Collections.IDictionary
To be added.
Gets design-time data for a control.
None
2.0.0.0
Property
System.String
To be added.
To be added.
Gets or sets the URL of an image to display next to the link to the Help page.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text caption for the link to the Help page.
2.0.0.0
Property
System.String
To be added.
To be added.
Gets or sets the URL of the Help page.
2.0.0.0
Property
System.Web.UI.WebControls.TableItemStyle
To be added.
The property gets a reference to a object that you use to change the appearance of hyperlinks in the control.
The property is read-only; however, you can set the properties of the object it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, HyperLinkStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, HyperLinkStyle.ForeColor).
The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in the properties of the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets or sets a collection of properties that define the appearance of hyperlinks.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The property contains instructions for users creating a new user account. This text is displayed in the control, following the title.
If the property is set to an empty string (""), no instruction text is displayed to the user.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets instructions for creating a new user account.
2.0.0.0
Property
System.Web.UI.WebControls.TableItemStyle
To be added.
The property defines the appearance of instruction text in the control. This property is read-only; however, you can set the properties of the object that it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, InstructionTextStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, InstructionTextStyle.ForeColor).
The property defines the appearance of the property.
The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in properties of the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to a collection of properties that define the appearance of instruction text.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The class membership provider specified in the property can support a question and answer for retrieving or resetting the user's password. The property is displayed when the answer entered by the user does not meet the requirements for the answer set by the membership provider. The actual requirements for the answer are determined by the membership provider, and might be different for different providers.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the message displayed when the password retrieval answer is not valid.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The class membership provider specified in the property can restrict the e-mail addresses that it will accept. The property is displayed when the e-mail address entered by the user does not meet the requirements for the e-mail address set by the membership provider. The actual requirements for the e-mail address are determined by the membership provider, and might be different for different providers.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the message displayed when the entered e-mail address is not valid.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The class membership provider specified in the property can restrict the passwords that it will accept. The property is displayed when the password entered by the user does not meet the requirements for a password set by the membership provider. The actual requirements for the password are determined by the membership provider, and might be different for different providers.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the message displayed when the password entered is not valid.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The class membership provider specified in the property can restrict the password retrieval questions that it will accept. The property is displayed when the question entered by the user does not meet the requirements for the question set by the membership provider. The actual requirements for the question are determined by the membership provider, and might be different for different providers.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the message displayed when the password retrieval question entered is not valid.
2.0.0.0
Property
System.Web.UI.WebControls.TableItemStyle
To be added.
The property defines the appearance of labels in the control. This property is read-only; however, you can set the properties of the object that it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, LabelStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, LabelStyle.ForeColor).
The property defines the appearance of the following properties:
-
-
-
-
-
-
The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in properties of the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to a collection of properties that define the appearance of labels.
2.0.0.0
Method
System.Void
To be added.
To be added.
Restores view-state information from a previous page request that was saved by the SaveViewState method.
2.0.0.0
Property
System.Web.UI.Themeable(false)
System.Boolean
To be added.
The property can be set to false if you want to create a user account but not authenticate the account after it is created. This might be useful if you are an administrator creating user accounts, for example, or if there is a waiting period before users can access the Web site.
When the property is set to true, the user will be created and logged in at the end of the step. If you want the user to be logged in after all the steps have been completed, you can set the property to false until all of the steps of the control are completed.
This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.
Gets or sets a value indicating whether to log in the new user after creating the user account.
2.0.0.0
Property
2.0.0.0
System.Web.UI.Themeable(false)
System.Web.UI.WebControls.MailDefinition
To be added.
The property returns a reference to a group of properties that you use to define the format and content of the e-mail message that is sent to new users. Common settings include the subject line and the sender's return address. For a complete list of properties, see the class.
The property is read-only; however, you can set the properties of the object it returns. You can set the properties declaratively in the form Property-Subproperty, where represents a property of the class (for example, MailDefinition-Subject). You can also set the properties programmatically in the form Property.SubProperty (for example, MailDefinition.Subject).
An e-mail message is sent to new users only if is not null and if is not empty or null. In that case, the event is raised and an attempt is made to send the e-mail message. The property must be set to an e-mail address. Otherwise, an exception is thrown.
When the e-mail message is created from the object, it will make the substitutions listed in the following table.
-
Substitution text
Replaced with
-
<%UserName%>
The user name of the newly created user account.
-
<%Password%>
The password for the newly created user account.
If the property of the object is true, the contents of the mail message will be HTML encoded to guard against cross-site scripting security vulnerabilities for the message recipient.
You can use the method to modify the created by the object.
This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.
It is not possible to guarantee that a user will receive or view an e-mail message. To verify that a user has received a notification by e-mail, consider providing a confirmation link in the e-mail message that enables the user to confirm that the notification was received.
Gets a reference to a collection of properties that define the characteristics of the e-mail message sent to new users.
Property
System.Web.UI.Themeable(false)
System.String
To be added.
The property contains the name of the defined class membership provider that is used to store the user information. You can store membership information for users in different data stores by changing the value of the property. When the property is set to , the default membership provider defined in the Web.config file is used.
Membership providers are defined in the Web.config file in the <membership> section.
This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.
Gets or sets the membership provider called to create user accounts.
2.0.0.0
Method
System.Boolean
To be added.
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
A Boolean value.
None
None
2.0.0.0
Method
System.Void
The event is raised when the user clicks the Continue button on the control.
Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Raises the event when the user clicks the Continue button on the final user account creation step.
An that contains the event data.
2.0.0.0
Method
System.Void
The method is called after the Web site user account is created by the membership provider. If the property is true, the user is logged in after the method is called.
Use the method to set Web site values, such as personalization properties, before the user is logged in for the first time.
Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Raises the event after the membership provider creates the user account.
An that contains the event data.
2.0.0.0
Method
System.Void
The method is called when the membership provider specified in the property returns an error message from creating the specified user account. The property of the object passed as the parameter contains a object that contains the details of the error.
Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Raises the event when there is a problem creating the specified user account.
A with the data for the event.
2.0.0.0
Method
System.Void
Use the method to do any processing required before sending the new user information to the method of the membership provider specified in the property. For example, you might set the user name field to all lowercase letters, or compare the e-mail address to a list of restricted addresses before allowing creation of the user account.
If you need to cancel the request to create the new user account, set the property of the object passed as the parameter to true.
Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Raises the event prior to calling the membership provider to create the new user account.
A containing the event data.
2.0.0.0
Method
System.Void
To be added.
To be added.
Raises the event when the user clicks the Next button in one of the Create User wizard steps.
2.0.0.0
Method
2.0.0.0
System.Void
To be added.
To be added.
To be added.
Method
System.Void
Use the method to modify the e-mail message sent to new users. The property of the object passed as the parameter contains the object that will be sent to the new user. Modify the properties of the object to modify the e-mail message.
E-mail messages are only created when the property of the object specified by the property points to a valid file name.
Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Raises the event before an e-mail message is sent to a new user.
A containing the event data.
2.0.0.0
Method
System.Void
The method is called when the SMTP mail system raises an exception while attempting to send e-mail to the new user.
Examine the property of the object passed as the parameter to determine the actual cause of the exception. The most common problem is a configuration error in the <smtpMail> section of the Web.config file.
You must set the property of the object passed as the parameter to signal that the exception that caused the method to be called has been taken care of, otherwise the exception is re-thrown.
Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Raises the event when e-mail cannot be sent to the new user.
A containing the event data.
2.0.0.0
Property
System.String
To be added.
The property contains the password entered by the user. By default, a object is provided for the and text box values. Each text box displayed on the control also has a object associated with it.
Gets the password entered by the user.
2.0.0.0
Property
System.Web.UI.WebControls.TableItemStyle
To be added.
The property defines the appearance of the text that describes password requirements in the control. This property is read-only; however, you can set the properties of the object that it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, PasswordHintStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, PasswordHintStyle.ForeColor).
The property defines the appearance of the property.
The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in properties of the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to a collection of properties that define the appearance of the text that describes password requirements.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
You can use the property to provide guidelines and requirements for the user on how to create a password. For example, you could set the property to "Your password must be at least six characters long." You can then use the property to validate that the user entered a password that conforms to the guidelines.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text that describes password requirements.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text of the label for the password text box.
2.0.0.0
Property
System.String
To be added.
Use the property to define the requirements for passwords used to validate users on your Web site. A common use is to make sure that a user has included symbols other than letters in a password to make it harder for attackers to guess a password. The regular expression is used in addition to any restrictions placed on the password by the membership provider specified in the property. If the membership provider rejects the password for any reason, the text contained in the property is displayed.
If the password entered does not pass the regular expression, the error message contained in the property is displayed to the user.
Gets or sets a regular expression used to validate the provided password.
2.0.0.0
Property
System.String
To be added.
Use the property to inform the user that the password entered did not conform to the site's password requirements.
Gets or sets the error message shown when the password entered does not conform to the site's password requirements.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text of the error message shown when the user does not enter a password.
2.0.0.0
Property
System.Web.UI.Themeable(false)
System.ComponentModel.Localizable(true)
System.String
To be added.
The membership provider specified in the property will determine whether the and text boxes are displayed at run time. Each text box displayed on the control has a associated with it.
This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the password recovery confirmation question entered by the user.
2.0.0.0
Property
2.0.0.0
System.Boolean
To be added.
The property returns a value from the membership provider set in the property specifying whether the user is required to enter a password confirmation question and answer.
If a Membership provider requires a question and answer, the and controls are required and the throws an exception if they are not found or of the wrong type. If they are not required by the Membership provider, no exception is thrown if they are not found, and if they are of the wrong type they are ignored.
Gets a value indicating whether the user is required to enter a password confirmation question and answer.
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text of the label for the question text box.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the error message that is displayed when the user does not enter a password confirmation question.
2.0.0.0
Property
System.Web.UI.Themeable(false)
System.Boolean
To be added.
When the property is true, the will display a text box and an associated label for the user to enter an e-mail address. If the user does not enter an e-mail address, the property will display an error message.
If the property is set to true and you are using templated content, the control is required and the throws an exception if the control is not found or is of the wrong type. If is set to false, no exception is thrown if the is not found. If it is of the wrong type, it is ignored.
If the membership provider specified in the property requires a unique e-mail address for new users, you must set the property to true so that the UI for entering an e-mail address is displayed. Otherwise, the user will see the but have no way to enter an e-mail address.
This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.
Gets or sets a value indicating whether an e-mail address is required for the Web site user.
2.0.0.0
Method
System.Object
To be added.
To be added.
Saves the state of the control.
2.0.0.0
Event
System.Web.UI.WebControls.MailMessageEventHandler
The class will send an e-mail message confirming that a new Web site account has been created when the property defines an e-mail message to send.
Because the e-mail message only has automatic replacement fields for the user name and password fields, you can use the event to modify the e-mail message before it is sent to the new user.
For more information about handling events, see Consuming Events.
Occurs before the user is sent an e-mail confirmation that an account has been created.
2.0.0.0
Event
System.Web.UI.WebControls.SendMailErrorEventHandler
The event is raised when there is a problem using the SMTP mail provider to send e-mail to the e-mail address provided by the new user. The most common reason to raise this event is when the <smtpMail> section of the Web.config file is incorrect.
The default event handler does not catch or handle the SMTP error from the e-mail system. Your event handler must set the property of the object to true in order to stop the error from appearing to the Web site user.
For more information about handling events, see Consuming Events.
Occurs when there is an SMTP error sending e-mail to the new user.
2.0.0.0
Method
System.Void
To be added.
To be added.
To be added.
2.0.0.0
Property
System.String
To be added.
Use the property to specify the alternate text for a hidden-image read by screen readers that will provide the ability to skip the sidebar area's content. The text that you specify provides assistive technology devices with a description of the hidden image that can be used to make the control more accessible.
If the property is set to false (the default), the property does not create a hidden image with alternate text. The property works only when the property is true.
Gets or sets a value that is used to render alternate text that notifies screen readers to skip the sidebar area's content.
2.0.0.0
Property
System.Web.UI.WebControls.Style
To be added.
The property defines the appearance of text box controls in the control. This property is read-only; however, you can set the properties of the object that it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, TextBoxStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, TextBoxStyle.ForeColor).
The property defines the appearance of the following text box controls:
-
text box field
-
text box field
-
text box field
-
text box field
-
text box field
The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in properties of the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to a collection of properties that define the appearance of text box controls.
2.0.0.0
Property
System.Web.UI.WebControls.TableItemStyle
To be added.
The property defines the appearance of titles in the control. This property is read-only; however, you can set the properties of the object that it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, TitleTextStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, TitleTextStyle.ForeColor).
The property defines the appearance of the title on the step and the step.
The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in properties of the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to a collection of properties that define the appearance of titles.
2.0.0.0
Method
System.Void
To be added.
Marks the starting point to begin tracking changes to the control as part of the control viewstate.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the error message displayed when an error returned by the membership provider is not defined.
2.0.0.0
Property
System.String
To be added.
If a user name is required by the membership provider specified in the property, then the user name text box will appear on the control. Each text box displayed on the control has a object associated with it.
Gets or sets the user name entered by the user.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the text of the label for the user name text box.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.String
To be added.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the error message displayed when the user name text box is left blank.
2.0.0.0
Property
System.Web.UI.WebControls.Style
To be added.
Use the property to change the appearance of messages that are displayed for input validation errors. By default, the is set to display the following messages in red:
-
-
-
-
-
-
-
-
The property is read-only; however, you can set the properties of the object it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the class (for example, ValidatorTextStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, ValidatorTextStyle.ForeColor).
Common settings include custom background color, text color, and font properties. The style settings for the property are merged with the style settings for the control. Any settings applied in the property override the corresponding settings in the properties of the control.
The following style properties are overridden by settings:
-
-
-
-
-
-
-
-
However, when you use templates to define the appearance of the control, the property has no effect.
Gets a reference to the object that allows you to set the appearance of the validation error messages.
2.0.0.0
Property
System.Web.UI.Themeable(false)
System.Web.UI.WebControls.WizardStepCollection
To be added.
The property returns a collection of objects that make up the control. You can use the collection to programmatically access the objects contained in the control. Use the , , , and methods to programmatically manipulate the objects in the collection.
Gets a reference to a collection containing all the objects defined for the control.
2.0.0.0