linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls/CreateUserWizardStep.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="CreateUserWizardStep" FullName="System.Web.UI.WebControls.CreateUserWizardStep">
  <TypeSignature Language="C#" Value="public sealed class CreateUserWizardStep : System.Web.UI.WebControls.TemplatedWizardStep" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Web.UI.WebControls.TemplatedWizardStep</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control creates new user accounts in a Web site's user data store. The <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> is, by default, the first step within the <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control. The <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step is a required step within the <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control.</para>
      <para>The <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> class is derived from the <see cref="T:System.Web.UI.WebControls.TemplatedWizardStep" /> class. The <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> is displayed in the <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control before the <see cref="T:System.Web.UI.WebControls.CompleteWizardStep" /> step.</para>
      <block subset="none" type="note">
        <para>Although the <see cref="T: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 <ui>Previous</ui> button is displayed. For example, if the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step does not have a custom navigation template, and is preceded by another step that is rendered before <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" />, then the <ui>Previous</ui> button is displayed on the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step at run time. If the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step is rendered before the alternate "first" step, then the <ui>Previous</ui> button is not displayed. Furthermore, the <ui>Previous</ui> button is never rendered at design time. If you want the <ui>Previous</ui> button to be rendered at design time, you must add it to the custom navigation template of the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step.</para>
      </block>
      <para>You can modify the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step to contain additional fields, or change the display order of the fields included in the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step, by editing the template associated with the control. </para>
      <para>The new Web site user account is created in the data store when the user clicks the <ui>Next</ui> button on the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step. By default, the <see cref="P:System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn" /> property is set to false to keep the user from returning to the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step and accidentally attempting to create another user account with the same credentials. If you set the <see cref="P:System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn" /> 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 he or she originally entered.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Contains basic functionality for creating a user in a step that can be templated. This class cannot be inherited.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CreateUserWizardStep ();" />
      <MemberType>Constructor</MemberType>
      <Parameters />
      <Docs>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Creates a new instance of the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> control.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="AllowReturn">
      <MemberSignature Language="C#" Value="public override bool AllowReturn { set; get; }" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn" /> property is set to false to keep users from returning to the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> step and accidentally trying to create another user account with the same credentials. If you override the <see cref="P:System.Web.UI.WebControls.CreateUserWizardStep.AllowReturn" /> 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 he or she originally entered.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>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.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="StepType">
      <MemberSignature Language="C#" Value="public override System.Web.UI.WebControls.WizardStepType StepType { set; get; }" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>System.Web.UI.Themeable(false)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Web.UI.WebControls.WizardStepType</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.UI.WebControls.CreateUserWizardStep.StepType" /> property specifies the navigation options to display for the user-account-creation step of the <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control. </para>
          <para>The <see cref="P:System.Web.UI.WebControls.CreateUserWizardStep.StepType" /> property determines which of the <see cref="T:System.Web.UI.WebControls.Wizard" /> control's navigation buttons are displayed on the <see cref="T:System.Web.UI.WebControls.CreateUserWizardStep" /> control. For more information, see the <see cref="P:System.Web.UI.WebControls.WizardStepBase.StepType" /> property.</para>
          <block subset="none" type="note">
            <para>If you attempt to change the <see cref="P:System.Web.UI.WebControls.CreateUserWizardStep.StepType" /> property to any value other than the <see cref="F:System.Web.UI.WebControls.WizardStepType.Auto" /> value of the <see cref="T:System.Web.UI.WebControls.WizardStepType" /> enumeration, an <see cref="T:System.InvalidOperationException" /> will be thrown.</para>
          </block>
          <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>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.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Title">
      <MemberSignature Language="C#" Value="public override string Title { set; get; }" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see <see cref="T:System.ComponentModel.LocalizableAttribute" /> and <format type="text/html"><a href="8ef3838e-9d05-4236-9dd0-ceecff9df80d">ASP.NET Globalization and Localization</a></format>.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the title to use for the user-account-creation step of the <see cref="T:System.Web.UI.WebControls.CreateUserWizard" /> control. </para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>