308 lines
19 KiB
XML
308 lines
19 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="WizardStepBase" FullName="System.Web.UI.WebControls.WizardStepBase">
|
|
<TypeSignature Language="C#" Value="public abstract class WizardStepBase : System.Web.UI.WebControls.View" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Web.UI.WebControls.View</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.ToolboxItem("")</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Bindable(false)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Web.UI.ControlBuilder(typeof(System.Web.UI.WebControls.WizardStepControlBuilder))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>You cannot directly create an instance of the <see cref="T:System.Web.UI.WebControls.WizardStepBase" /> class. Instead, this class is inherited by the <see cref="T:System.Web.UI.WebControls.WizardStep" /> class and the <see cref="T:System.Web.UI.WebControls.TemplatedWizardStep" /> class to provide the basic functionality of a step in a control that acts as a wizard. </para>
|
|
<para>You can derive from the <see cref="T:System.Web.UI.WebControls.WizardStepBase" /> class to create a custom class that represents a unique step in a wizard control. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Implements the basic functionality required by a step in a <see cref="T:System.Web.UI.WebControls.Wizard" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected WizardStepBase ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.WizardStepBase" /> class. </para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="AllowReturn">
|
|
<MemberSignature Language="C#" Value="public virtual bool AllowReturn { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Web.UI.Filterable(false)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Web.UI.Themeable(false)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(true)</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.WizardStepBase.AllowReturn" /> property can be used to enforce linear navigation in a <see cref="T:System.Web.UI.WebControls.Wizard" /> control. If each step has its <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> property set to false, the user will not be able to return to a step after it has been accessed. One scenario where you might use this functionality is to disallow a user to return to a step after it has been completed because you are persisting the data to a database as each step is completed. If you save the data after each step and allow the user to return to a step and change information after it has been saved, the saved data might become corrupted. By setting the <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> property to false, once the user has left a step, he or she will not be able to return to it and change any values.</para>
|
|
<para>The <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> property determines how and when the <ui>Previous</ui> button is not rendered. The following table describes the <ui>Previous</ui> button rendering behavior.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Scenario</para>
|
|
</term>
|
|
<description>
|
|
<para>Behavior</para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>Linear: Step1 has <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> set to false and user action goes to step 2.</para>
|
|
</term>
|
|
<description>
|
|
<para>Step 2 does not display the <ui>Previous</ui> button.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>Non-Linear: Step1 has <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> set to false and user action goes to step 3.</para>
|
|
</term>
|
|
<description>
|
|
<para>Step 3 does not display the <ui>Previous</ui> button.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>SideBar Buttons: Step 2 has <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> set to false , <see cref="P:System.Web.UI.WebControls.Wizard.DisplaySideBar" /> is set to true, and a user clicks on the SideBar button.</para>
|
|
</term>
|
|
<description>
|
|
<para>No buttons are automatically disabled on the sidebar when <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> is set to false. If a user clicks the button, the action is ignored.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>Linear & Non-Linear with Custom Template: The step has a custom navigation template. </para>
|
|
</term>
|
|
<description>
|
|
<para>No automatic hiding or displaying occurs if <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> is set to false when you use a template for navigation. The <ui>Previous</ui> button should be optional on the template.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>Using the Visual Studio Designer and <see cref="P:System.Web.UI.WebControls.Wizard.ActiveStepIndex" /> : The control has 5 steps, you are working on step 4, and you run the page. </para>
|
|
</term>
|
|
<description>
|
|
<para>When step 4 is the <see cref="P:System.Web.UI.WebControls.Wizard.ActiveStepIndex" />, then the <ui>Previous</ui> button is rendered. The <ui>Previous</ui> button is only hidden for <see cref="P:System.Web.UI.WebControls.WizardStepBase.StepType" /> set to <see cref="F:System.Web.UI.WebControls.WizardStepType.Step" /> when the preceding step in the history has <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> set to false. Since step 4 is rendered first and there are no steps in the history, the <ui>Previous</ui> button is not hidden.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>Start Step and Non-Linear Navigation: A user visits step 3 and step 4 and then step 1 which has <see cref="P:System.Web.UI.WebControls.WizardStepBase.StepType" /> set to <see cref="F:System.Web.UI.WebControls.WizardStepType.Start" />. </para>
|
|
</term>
|
|
<description>
|
|
<para>The wizard does not add a <ui>Previous</ui> button when the <see cref="P:System.Web.UI.WebControls.WizardStepBase.StepType" /> is set to <see cref="F:System.Web.UI.WebControls.WizardStepType.Start" /> regardless of how the user navigates to that step. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>Same Step In History: A user visits step 3 where <see cref="P:System.Web.UI.WebControls.WizardStepBase.StepType" /> is set to <see cref="F:System.Web.UI.WebControls.WizardStepType.Step" /> and the user does not commit their actions. They then click on the previous button on step 3.</para>
|
|
</term>
|
|
<description>
|
|
<para>The wizard control checks to see if the <ui>Previous</ui> step in the history is the "same" step that the user is currently on. If the step is the same, the wizard control looks back in the history to determine the preceding "different" step and bases the display of the <ui>Previous</ui> button and destination based on the "different step" in the history. </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
<block subset="none" type="note">
|
|
<para>When the <see cref="P:System.Web.UI.WebControls.WizardStepBase.AllowReturn" /> property is set to false, but the <see cref="P:System.Web.UI.WebControls.Wizard.DisplaySideBar" /> property of the parent control of <see cref="T:System.Web.UI.WebControls.WizardStepBase" /> is set to true, clicking on a button in the sidebar area has no effect. The sidebar area is generally displayed to provide nonlinear navigation, so if you are not using the functionality of nonlinear navigation, you may want to set the <see cref="P:System.Web.UI.WebControls.Wizard.DisplaySideBar" /> property to false.</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 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.WizardStepCollection" /> collection. </para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Name">
|
|
<MemberSignature Language="C#" Value="public virtual string Name { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</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 <see cref="P:System.Web.UI.WebControls.WizardStepBase.Name" /> property returns a string that identifies a step in a wizard control. If a value is specified for the <see cref="P:System.Web.UI.WebControls.WizardStepBase.Title" /> property, the <see cref="P:System.Web.UI.WebControls.WizardStepBase.Name" /> property returns that value. If no value is specified for the <see cref="P:System.Web.UI.WebControls.WizardStepBase.Title" /> property, the <see cref="P:System.Web.UI.WebControls.WizardStepBase.Name" /> property returns the value of the <see cref="P:System.Web.UI.WebControls.WizardStepBase.ID" /> property. If values are not specified for either the <see cref="P:System.Web.UI.WebControls.WizardStepBase.Title" /> or the <see cref="P:System.Web.UI.WebControls.WizardStepBase.ID" /> property, the <see cref="P:System.Web.UI.WebControls.WizardStepBase.Name" /> property returns null.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the name associated with a step in a control that acts as a wizard.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="StepType">
|
|
<MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.WizardStepType StepType { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(System.Web.UI.WebControls.WizardStepType.Auto)</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>Use the <see cref="P:System.Web.UI.WebControls.WizardStepBase.StepType" /> property to specify the type of navigation buttons to display for a step in a <see cref="T:System.Web.UI.WebControls.Wizard" /> control. If you specify a value for this property, any steps marked as <see cref="F:System.Web.UI.WebControls.WizardStepType.Complete" /> displays in a disabled state in the sidebar.</para>
|
|
<para>If you do not specify a value for this property, the default is WizardStepType.Auto.</para>
|
|
<para>The following table lists the available settings for the <see cref="P:System.Web.UI.WebControls.WizardStepBase.StepType" /> property and the resulting behavior of the step:</para>
|
|
<list type="table">
|
|
<item>
|
|
<term>WizardStepType.Auto</term>
|
|
<description>
|
|
<para>The navigation UI that is rendered for the step is determined by the order in which the step is declared.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>WizardStepType.Complete</term>
|
|
<description>
|
|
<para>The step is the last one to appear. No navigation buttons are rendered.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>WizardStepType.Finish</term>
|
|
<description>
|
|
<para>The step is the final data collection step. The Finish and Previous buttons are rendered for navigation.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>WizardStepType.Start</term>
|
|
<description>
|
|
<para>The step is the first one to appear. A Previous button is not rendered.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>WizardStepType.Step</term>
|
|
<description>
|
|
<para>The step is any step between the Start and the Finish step. Previous and Next buttons are rendered for navigation. This step type is useful for overriding the <see cref="F:System.Web.UI.WebControls.WizardStepType.Auto" /> step type.</para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the type of navigation user interface (UI) to display for a step in a <see cref="T:System.Web.UI.WebControls.Wizard" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Title">
|
|
<MemberSignature Language="C#" Value="public virtual string Title { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</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>Use the <see cref="P:System.Web.UI.WebControls.WizardStepBase.Title" /> property to display a user-friendly title for a step in a <see cref="T:System.Web.UI.WebControls.Wizard" /> control when the sidebar feature is enabled. If the <see cref="P:System.Web.UI.WebControls.WizardStepBase.Title" /> property is not set and the sidebar feature is enabled, the value of the <see cref="P:System.Web.UI.WebControls.WizardStepBase.ID" /> property is displayed for the sidebar button.</para>
|
|
<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 a step in a <see cref="T:System.Web.UI.WebControls.Wizard" /> control when the sidebar feature is enabled.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Wizard">
|
|
<MemberSignature Language="C#" Value="public System.Web.UI.WebControls.Wizard Wizard { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.UI.WebControls.Wizard</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the <see cref="T:System.Web.UI.WebControls.Wizard" /> control that is the parent of the object derived from <see cref="T:System.Web.UI.WebControls.WizardStepBase" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |