/
CreateUserWizardStep.xml
256 lines (224 loc) · 20.1 KB
/
CreateUserWizardStep.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<Type Name="CreateUserWizardStep" FullName="System.Web.UI.WebControls.CreateUserWizardStep">
<TypeSignature Language="C#" Value="public sealed class CreateUserWizardStep : System.Web.UI.WebControls.TemplatedWizardStep" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CreateUserWizardStep extends System.Web.UI.WebControls.TemplatedWizardStep" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.CreateUserWizardStep" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class CreateUserWizardStep
Inherits TemplatedWizardStep" />
<TypeSignature Language="F#" Value="type CreateUserWizardStep = class
 inherit TemplatedWizardStep" />
<TypeSignature Language="C++ CLI" Value="public ref class CreateUserWizardStep sealed : System::Web::UI::WebControls::TemplatedWizardStep" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.TemplatedWizardStep</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Browsable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(false)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Contains basic functionality for creating a user in a step that can be templated. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.CreateUserWizard> control creates new user accounts in a Web site's user data store. The <xref:System.Web.UI.WebControls.CreateUserWizardStep> is, by default, the first step within the <xref:System.Web.UI.WebControls.CreateUserWizard> control. The <xref:System.Web.UI.WebControls.CreateUserWizardStep> step is a required step within the <xref:System.Web.UI.WebControls.CreateUserWizard> control.
The <xref:System.Web.UI.WebControls.CreateUserWizardStep> class is derived from the <xref:System.Web.UI.WebControls.TemplatedWizardStep> class. The <xref:System.Web.UI.WebControls.CreateUserWizardStep> is displayed in the <xref:System.Web.UI.WebControls.CreateUserWizard> control before the <xref:System.Web.UI.WebControls.CompleteWizardStep> step.
> [!NOTE]
> Although the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step is the first step in the wizard by default, it is possible to provide a different first step. Doing so, however, can affect whether the **Previous** button is displayed. For example, if the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step does not have a custom navigation template, and is preceded by another step that is rendered before <xref:System.Web.UI.WebControls.CreateUserWizardStep>, then the **Previous** button is displayed on the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step at run time. If the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step is rendered before the alternate "first" step, then the **Previous** button is not displayed. Furthermore, the **Previous** button is never rendered at design time. If you want the **Previous** button to be rendered at design time, you must add it to the custom navigation template of the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step.
You can modify the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step to contain additional fields, or change the display order of the fields included in the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step, by editing the template associated with the control.
The new Web site user account is created in the data store when the user clicks the **Next** button on the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step. By default, the <xref:System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn%2A> property is set to `false` to keep the user from returning to the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step and accidentally attempting to create another user account with the same credentials. If you set the <xref:System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn%2A> property to `true`, you must include logic in your application to remove the user account that was originally created before the user returned to this step, or to allow the user to edit information they originally entered.
## Examples
The first code example uses the short-form declarative syntax of the <xref:System.Web.UI.WebControls.CreateUserWizardStep> class to add an additional control to a <xref:System.Web.UI.WebControls.CreateUserWizard> control. The code example requires the following entries in the Web.config file.
`<configuration>`
`<system.web>`
`<profile>`
`<properties>`
`<add name="lastName" />`
`<add name="firstName" />`
`</properties>`
`</profile>`
`</system.web>`
`</configuration>`
> [!IMPORTANT]
> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://docs.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CreateUserWizardCreatedUser/CS/createuserwizardcreatedusercs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CreateUserWizardCreatedUser/VB/createuserwizardcreateduservb.aspx" id="Snippet1":::
> [!IMPORTANT]
> This control has a text box that accepts user input, which is a potential security threat. User input in a Web page can potentially contain malicious client script. By default, ASP.NET Web pages validate user input to ensure that the input does not contain HTML elements or script. As long as this validation is enabled, you do not need to explicitly check for script or HTML elements in user input. For more information, see [Script Exploits Overview](https://docs.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).
The second code example lists the complete <xref:System.Web.UI.WebControls.CreateUserWizardStep> control.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CreateUserWizardStep/CS/createuserwizardstepcs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CreateUserWizardStep/VB/createuserwizardstepvb.aspx" id="Snippet1":::
> [!IMPORTANT]
> This control has a text box that accepts user input, which is a potential security threat. User input in a Web page can potentially contain malicious client script. By default, ASP.NET Web pages validate user input to ensure that the input does not contain HTML elements or script. As long as this validation is enabled, you do not need to explicitly check for script or HTML elements in user input. For more information, see [Script Exploits Overview](https://docs.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).
]]></format>
</remarks>
<related type="Article" href="https://msdn.microsoft.com/library/7983d61e-d317-4181-8ab9-cab549adf9dc">How to: Customize the ASP.NET CreateUserWizard Control</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/fs0za4w6(v=vs.100)">Wizard Web Server Control</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CreateUserWizardStep ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.CreateUserWizardStep.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 CreateUserWizardStep();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Creates a new instance of the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> control.</summary>
<remarks>To be added.</remarks>
<related type="Article" href="https://msdn.microsoft.com/library/7983d61e-d317-4181-8ab9-cab549adf9dc">How to: Customize the ASP.NET CreateUserWizard Control</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/fs0za4w6(v=vs.100)">Wizard Web Server Control</related>
</Docs>
</Member>
<Member MemberName="AllowReturn">
<MemberSignature Language="C#" Value="public override bool AllowReturn { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AllowReturn" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property AllowReturn As Boolean" />
<MemberSignature Language="F#" Value="member this.AllowReturn : bool with get, set" Usage="System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool AllowReturn { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Browsable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the user is allowed to return to the current step from a subsequent step in a <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control.</summary>
<value>
<see langword="true" /> if the user is allowed to return to the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn%2A> property is set to `false` to keep users from returning to the <xref:System.Web.UI.WebControls.CreateUserWizardStep> step and accidentally trying to create another user account with the same credentials. If you override the <xref:System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn%2A> property and set it to `true`, you should include logic in your application to remove the user account that was originally created before the user returned to this step, or to allow the user to edit information they originally entered.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">An attempt was made to set the property.</exception>
<related type="Article" href="https://msdn.microsoft.com/library/7983d61e-d317-4181-8ab9-cab549adf9dc">How to: Customize the ASP.NET CreateUserWizard Control</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/fs0za4w6(v=vs.100)">Wizard Web Server Control</related>
</Docs>
</Member>
<Member MemberName="StepType">
<MemberSignature Language="C#" Value="public override System.Web.UI.WebControls.WizardStepType StepType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Web.UI.WebControls.WizardStepType StepType" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.CreateUserWizardStep.StepType" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property StepType As WizardStepType" />
<MemberSignature Language="F#" Value="member this.StepType : System.Web.UI.WebControls.WizardStepType with get, set" Usage="System.Web.UI.WebControls.CreateUserWizardStep.StepType" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Web::UI::WebControls::WizardStepType StepType { System::Web::UI::WebControls::WizardStepType get(); void set(System::Web::UI::WebControls::WizardStepType value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Browsable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Web.UI.Filterable(false)]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.Filterable(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Web.UI.Themeable(false)]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.Themeable(false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WizardStepType</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the type of user interface (UI) to display for the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step of a <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control.</summary>
<value>The <see cref="F:System.Web.UI.WebControls.WizardStepType.Auto" /> enumeration value of the <see cref="T:System.Web.UI.WebControls.WizardStepType" /> enumeration.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.CreateUserWizardStep.StepType%2A> property specifies the navigation options to display for the user-account-creation step of the <xref:System.Web.UI.WebControls.CreateUserWizard> control.
The <xref:System.Web.UI.WebControls.CreateUserWizardStep.StepType%2A> property determines which of the <xref:System.Web.UI.WebControls.Wizard> control's navigation buttons are displayed on the <xref:System.Web.UI.WebControls.CreateUserWizardStep> control. For more information, see the <xref:System.Web.UI.WebControls.WizardStepBase.StepType%2A?displayProperty=nameWithType> property.
> [!CAUTION]
> If you attempt to change the <xref:System.Web.UI.WebControls.CreateUserWizardStep.StepType%2A> property to any value other than the <xref:System.Web.UI.WebControls.WizardStepType.Auto> value of the <xref:System.Web.UI.WebControls.WizardStepType> enumeration, an <xref:System.InvalidOperationException> will be thrown.
This property cannot be set by themes or style sheet themes. For more information, see <xref:System.Web.UI.ThemeableAttribute> and [ASP.NET Themes and Skins](https://docs.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100)).
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">An attempt was made to set the <see cref="P:System.Web.UI.WebControls.CreateUserWizardStep.StepType" /> property to a value other than the <see langword="WizardStepType.Auto" /> enumeration value.</exception>
<altmember cref="T:System.Web.UI.WebControls.WizardStepType" />
<altmember cref="T:System.Web.UI.WebControls.WizardStepBase" />
<related type="Article" href="https://msdn.microsoft.com/library/7983d61e-d317-4181-8ab9-cab549adf9dc">How to: Customize the ASP.NET CreateUserWizard Control</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/fs0za4w6(v=vs.100)">Wizard Web Server Control</related>
</Docs>
</Member>
<Member MemberName="Title">
<MemberSignature Language="C#" Value="public override string Title { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Title" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.CreateUserWizardStep.Title" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property Title As String" />
<MemberSignature Language="F#" Value="member this.Title : string with get, set" Usage="System.Web.UI.WebControls.CreateUserWizardStep.Title" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ Title { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Localizable(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Localizable(true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the title to use for the user-account-creation step of the <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control.</summary>
<value>The title to use for the user-account-creation step of the <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control. The default value is "Sign up for your new account." The default text for the control is localized based on the server's current locale.</value>
<remarks>
<format type="text/markdown"><).
]]></format>
</remarks>
<related type="Article" href="https://msdn.microsoft.com/library/7983d61e-d317-4181-8ab9-cab549adf9dc">How to: Customize the ASP.NET CreateUserWizard Control</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/fs0za4w6(v=vs.100)">Wizard Web Server Control</related>
</Docs>
</Member>
</Members>
</Type>