Wizard.HeaderText Property

Gets or sets the text caption that is displayed for the header area on the control.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in system.web.dll)

'Declaration
<LocalizableAttribute(True)> _
Public Overridable Property HeaderText As String
'Usage
Dim instance As Wizard
Dim value As String

value = instance.HeaderText

instance.HeaderText = value
/** @property */
public String get_HeaderText ()

/** @property */
public void set_HeaderText (String value)

public function get HeaderText () : String

public function set HeaderText (value : String)

Not applicable.

Property Value

The text caption displayed for the header area on the Wizard. The default is an empty string ("").

The HeaderText property defines the text caption that is displayed for the header area on the Wizard control.

To control the style of the header area, use the HeaderStyle property. Alternatively, you can define your own custom UI for the header row by setting the HeaderTemplate property instead of the HeaderText property.

NoteNote:

If both the HeaderText and HeaderTemplate properties are defined, the HeaderText property has no effect.

The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and ASP.NET Globalization and Localization.

The following code example demonstrates how to use the ActiveStepChanged event to update the HeaderText property of the Wizard control.

<%@ Page Language="VB" %>

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

<script runat="server">
  
  Sub OnActiveStepChanged(ByVal sender As Object, ByVal e As System.EventArgs)
    
    ' Every time that the ActiveStep property changes, change the HeaderText to match it.
    Wizard1.HeaderText = "You are currently on " + Wizard1.ActiveStep.Title
    
  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
      <form id="form1" runat="server">
        <asp:Wizard ID="Wizard1" 
          Runat="server" 
          OnActiveStepChanged="OnActiveStepChanged" 
          HeaderText="ActiveStepChanged Example">
          <WizardSteps>
            <asp:WizardStep ID="WizardStep1" Title="Step 1" 
              Runat="server">
            </asp:WizardStep>
            <asp:WizardStep ID="WizardStep2" Title="Step 2" 
              Runat="server">
            </asp:WizardStep>
          </WizardSteps>
        </asp:Wizard>
      </form>
  </body>
</html>

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: