TemplatedWizardStep Class

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a step in a wizard control that can be customized through the use of templates.

public ref class TemplatedWizardStep : System::Web::UI::WebControls::WizardStepBase

[System.ComponentModel.Bindable(false)]
[System.Web.UI.Themeable(true)]
public class TemplatedWizardStep : System.Web.UI.WebControls.WizardStepBase

[<System.ComponentModel.Bindable(false)>]
[<System.Web.UI.Themeable(true)>]
type TemplatedWizardStep = class
    inherit WizardStepBase

Public Class TemplatedWizardStep
Inherits WizardStepBase

Inheritance: Object

Control

View

WizardStepBase
TemplatedWizardStep

Derived: System.Web.UI.WebControls.CompleteWizardStep

System.Web.UI.WebControls.CreateUserWizardStep

Attributes: BindableAttribute ThemeableAttribute

Examples

The TemplatedWizardStep class allows you to customize the content and navigation templates within it. The following example shows how to define a template-based wizard step.

Note

The CustomNavigationTemplate property allows you to take full control of the navigation block, usually displayed at the bottom of the current view. Normally, you fill the navigation block with a series of buttons. However, other controls are acceptable as long as they support command bubbling, as does the Button control.


<%@ Page Language="C#" %>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>TemplatedWizardStep Example</title>
    
    <script runat="server">
        void OnPreviousButtonClick(Object sender, WizardNavigationEventArgs e)
        {
            // Display feedback
            FeedbackID.Text = "Previous button clicked";
        }
      
        void OnNextButtonClick(Object sender, WizardNavigationEventArgs e)
        {
            // Display feedback.
            FeedbackID.Text = "Next button clicked";
        }
    </script>

</head>

<body>
    <form id="form1" runat="server">
    
        <asp:Wizard ID="Wizard1" runat="server" 
            OnPreviousButtonClick="OnPreviousButtonClick" 
            OnNextButtonClick="OnNextButtonClick">
        <WizardSteps>
            <asp:TemplatedWizardStep StepType="Auto">
                <ContentTemplate>
                    <asp:Label ID="Label1" runat="server" 
                        BackColor="blue"  Font-Bold="true" ForeColor="yellow">
                     Simple TemplatedWizardStep Example</asp:Label>
                </ContentTemplate>
                <CustomNavigationTemplate>
                    <div style="margin: 1em 1em;">
                        <asp:Button ID="PreviousButtonID" runat="server" Font-Bold="true"  
                            BackColor="Red" Text="Previous" CommandName="MovePrevious"/>
                        <asp:Button ID="NextButtonID" runat="server"   Font-Bold="true" 
                            BackColor="Aqua" Text="Next" CommandName="MoveNext"/>
                    </div>
                </CustomNavigationTemplate>
            </asp:TemplatedWizardStep>
        </WizardSteps>
  
        </asp:Wizard>
    
        <asp:Label ID="FeedbackID" runat="server" BackColor="yellow" ForeColor="red"/>
    </form>

</body>
</html>


<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>TemplatedWizardStep Example</title>
    
    <script runat="server">
        Sub OnPreviousButtonClick(ByVal sender As Object, ByVal e As WizardNavigationEventArgs)
            'Display feedback
            FeedbackID.Text = "Previous button clicked"
 
        End Sub

        Sub OnNextButtonClick(ByVal sender As Object, ByVal e As WizardNavigationEventArgs)

            ' Display feedback.
            FeedbackID.Text = "Next button clicked"

        End Sub
    
    </script>

</head>

<body>
    <form id="form1" runat="server">
    
        <asp:Wizard ID="Wizard1" runat="server" 
            OnPreviousButtonClick="OnPreviousButtonClick" 
            OnNextButtonClick="OnNextButtonClick">
        <WizardSteps>
            <asp:TemplatedWizardStep StepType="Auto">
                <ContentTemplate>
                    <asp:Label ID="Label1" runat="server" 
                        BackColor="blue"  Font-Bold="true" ForeColor="yellow">
                      Simple TemplatedWizardStep Example</asp:Label>
                </ContentTemplate>
                <CustomNavigationTemplate>
                    <div style="margin: 1em 1em;">
                        <asp:Button ID="PreviousButtonID" runat="server" Font-Bold="true"  
                            BackColor="Red" Text="Previous" CommandName="MovePrevious"/>
                        <asp:Button ID="NextButtonID" runat="server"   Font-Bold="true" 
                            BackColor="Aqua" Text="Next" CommandName="MoveNext"/>
                    </div>
                </CustomNavigationTemplate>
            </asp:TemplatedWizardStep>
        </WizardSteps>
  
        </asp:Wizard>
    
        <asp:Label ID="FeedbackID" runat="server" BackColor="yellow" ForeColor="red"/>
    </form>

</body>
</html>

Remarks

The TemplatedWizardStep class is provided to enable developers to apply a template to the steps in a control that acts as a wizard. The TemplatedWizardStep class is intended to be used primarily by control developers.

You can apply a theme to TemplatedWizardStep.

Constructors

TemplatedWizardStep()

Initializes a new instance of the TemplatedWizardStep class.

Properties

Adapter	Gets the browser-specific adapter for the control. (Inherited from Control)
AllowReturn	Gets or sets a value indicating whether the user is allowed to return to the current step from a subsequent step in a WizardStepCollection collection. (Inherited from WizardStepBase)
AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control)
BindingContainer	Gets the control that contains this control's data binding. (Inherited from Control)
ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control)
ClientID	Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control)
ClientIDMode	Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control)
ClientIDSeparator	Gets a character value representing the separator character used in the ClientID property. (Inherited from Control)
ContentTemplate	Gets or sets the template for displaying the content of a step in a Wizard control.
ContentTemplateContainer	Gets the container that a Wizard control uses to create a ContentTemplate template for a step.
Context	Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control)
Controls	Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control)
CustomNavigationTemplate	Gets or sets the template for displaying the navigation user interface (UI) of a step in a Wizard control.
CustomNavigationTemplateContainer	Gets the container that a Wizard control uses to create a CustomNavigationTemplate template for a step.
DataItemContainer	Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control)
DataKeysContainer	Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control)
DesignMode	Gets a value indicating whether a control is being used on a design surface. (Inherited from Control)
EnableTheming	Gets or sets a value indicating whether themes apply to this control. (Inherited from WizardStepBase)
EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control)
Events	Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control)
HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control)
ID	Gets or sets the programmatic identifier assigned to the server control. (Inherited from WizardStepBase)
IdSeparator	Gets the character used to separate control identifiers. (Inherited from Control)
IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state. (Inherited from Control)
IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control)
IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control. (Inherited from Control)
LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control)
Name	Gets the name associated with a step in a control that acts as a wizard. (Inherited from WizardStepBase)
NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control)
Page	Gets a reference to the Page instance that contains the server control. (Inherited from Control)
Parent	Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control)
RenderingCompatibility	Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control)
Site	Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control)
SkinID	Gets or sets the skin to apply to the control.
StepType	Gets or sets the type of navigation user interface (UI) to display for a step in a Wizard control. (Inherited from WizardStepBase)
TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control)
TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control)
Title	Gets or sets the title to use for a step in a Wizard control when the sidebar feature is enabled. (Inherited from WizardStepBase)
UniqueID	Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control)
ValidateRequestMode	Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control)
ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control)
ViewStateIgnoresCase	Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control)
ViewStateMode	Gets or sets the view-state mode of this control. (Inherited from Control)
Visible	Gets or sets a value that indicates whether the View control is visible. (Inherited from View)
Wizard	Gets the Wizard control that is the parent of the object derived from WizardStepBase. (Inherited from WizardStepBase)

Methods

AddedControl(Control, Int32)	Called after a child control is added to the Controls collection of the Control object. (Inherited from Control)
AddParsedSubObject(Object)	Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control)
ApplyStyleSheetSkin(Page)	Applies the style properties defined in the page style sheet to the control. (Inherited from Control)
BeginRenderTracing(TextWriter, Object)	Begins design-time tracing of rendering data. (Inherited from Control)
BuildProfileTree(String, Boolean)	Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control)
ClearCachedClientID()	Sets the cached ClientID value to `null`. (Inherited from Control)
ClearChildControlState()	Deletes the control-state information for the server control's child controls. (Inherited from Control)
ClearChildState()	Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control)
ClearChildViewState()	Deletes the view-state information for all the server control's child controls. (Inherited from Control)
ClearEffectiveClientIDMode()	Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control)
CreateChildControls()	Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control)
CreateControlCollection()	Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control)
DataBind()	Binds a data source to the invoked server control and all its child controls. (Inherited from Control)
DataBind(Boolean)	Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control)
DataBindChildren()	Binds a data source to the server control's child controls. (Inherited from Control)
Dispose()	Enables a server control to perform final clean up before it is released from memory. (Inherited from Control)
EndRenderTracing(TextWriter, Object)	Ends design-time tracing of rendering data. (Inherited from Control)
EnsureChildControls()	Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control)
EnsureID()	Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindControl(String, Int32)	Searches the current naming container for a server control with the specified `id` and an integer, specified in the `pathOffset` parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control)
FindControl(String)	Searches the current naming container for a server control with the specified `id` parameter. (Inherited from Control)
Focus()	Sets input focus to a control. (Inherited from Control)
GetDesignModeState()	Gets design-time data for a control. (Inherited from Control)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetRouteUrl(Object)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(String, Object)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetRouteUrl(String, RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUniqueIDRelativeTo(Control)	Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control)
HasControls()	Determines if the server control contains any child controls. (Inherited from Control)
HasEvents()	Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control)
IsLiteralContent()	Determines if the server control holds only literal content. (Inherited from Control)
LoadControlState(Object)	Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control)
LoadViewState(Object)	Restores view-state information from a previous page request that was saved by the SaveViewState() method. (Inherited from WizardStepBase)
MapPathSecure(String)	Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnActivate(EventArgs)	Raises the Activate event of the View control. (Inherited from View)
OnBubbleEvent(Object, EventArgs)	Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control)
OnDataBinding(EventArgs)	Raises the DataBinding event. (Inherited from Control)
OnDeactivate(EventArgs)	Raises the Deactivate event of the View control. (Inherited from View)
OnInit(EventArgs)	Raises the Init event. (Inherited from Control)
OnLoad(EventArgs)	Raises the OnLoad(EventArgs) event. (Inherited from WizardStepBase)
OnPreRender(EventArgs)	Raises the PreRender event. (Inherited from Control)
OnUnload(EventArgs)	Raises the Unload event. (Inherited from Control)
OpenFile(String)	Gets a Stream used to read a file. (Inherited from Control)
RaiseBubbleEvent(Object, EventArgs)	Assigns any sources of the event and its information to the control's parent. (Inherited from Control)
RemovedControl(Control)	Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control)
Render(HtmlTextWriter)	Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control)
RenderChildren(HtmlTextWriter)	Outputs the content of the WizardStepBase control's child controls to the specified HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from WizardStepBase)
RenderControl(HtmlTextWriter, ControlAdapter)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control)
RenderControl(HtmlTextWriter)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control)
ResolveAdapter()	Gets the control adapter responsible for rendering the specified control. (Inherited from Control)
ResolveClientUrl(String)	Gets a URL that can be used by the browser. (Inherited from Control)
ResolveUrl(String)	Converts a URL into one that is usable on the requesting client. (Inherited from Control)
SaveControlState()	Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control)
SaveViewState()	Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (Inherited from Control)
SetDesignModeState(IDictionary)	Sets design-time data for a control. (Inherited from Control)
SetRenderMethodDelegate(RenderMethod)	Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control)
SetTraceData(Object, Object, Object)	Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control)
SetTraceData(Object, Object)	Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control)
ToString()	Returns a string that represents the current object. (Inherited from Object)
TrackViewState()	Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the ViewState property. (Inherited from Control)

Events

Activate	Occurs when the current View control becomes the active view. (Inherited from View)
DataBinding	Occurs when the server control binds to a data source. (Inherited from Control)
Deactivate	Occurs when the current active View control becomes inactive. (Inherited from View)
Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control)
Init	Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control)
Load	Occurs when the server control is loaded into the Page object. (Inherited from Control)
PreRender	Occurs after the Control object is loaded but prior to rendering. (Inherited from Control)
Unload	Occurs when the server control is unloaded from memory. (Inherited from Control)

Explicit Interface Implementations

IControlBuilderAccessor.ControlBuilder	For a description of this member, see ControlBuilder. (Inherited from Control)
IControlDesignerAccessor.GetDesignModeState()	For a description of this member, see GetDesignModeState(). (Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)	For a description of this member, see SetDesignModeState(IDictionary). (Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control)	For a description of this member, see SetOwnerControl(Control). (Inherited from Control)
IControlDesignerAccessor.UserData	For a description of this member, see UserData. (Inherited from Control)
IDataBindingsAccessor.DataBindings	For a description of this member, see DataBindings. (Inherited from Control)
IDataBindingsAccessor.HasDataBindings	For a description of this member, see HasDataBindings. (Inherited from Control)
IExpressionsAccessor.Expressions	For a description of this member, see Expressions. (Inherited from Control)
IExpressionsAccessor.HasExpressions	For a description of this member, see HasExpressions. (Inherited from Control)
IParserAccessor.AddParsedSubObject(Object)	For a description of this member, see AddParsedSubObject(Object). (Inherited from Control)

Extension Methods

FindDataSourceControl(Control)	Returns the data source that is associated with the data control for the specified control.
FindFieldTemplate(Control, String)	Returns the field template for the specified column in the specified control's naming container.
FindMetaTable(Control)	Returns the metatable object for the containing data control.

Applies to

Dela via