Diese Dokumentation wurde archiviert und wird nicht länger gepflegt.

Wizard.AllowNavigationToStep-Methode

Aktualisiert: November 2007

Verwendet einen booleschen Wert, um zu bestimmen, ob die ActiveStep-Eigenschaft auf das WizardStepBase-Objekt festgelegt werden kann, das dem übergebenen Index entspricht.

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

protected virtual bool AllowNavigationToStep(
	int index
)
protected boolean AllowNavigationToStep(
	int index
)
protected function AllowNavigationToStep(
	index : int
) : boolean

Parameter

index
Typ: System.Int32
Der Index des zu überprüfenden WizardStepBase-Objekts.

Rückgabewert

Typ: System.Boolean
false, wenn der übergebene Index auf eine WizardStepBase verweist, auf die bereits zugegriffen und deren AllowReturn-Eigenschaft auf false festgelegt wurde, andernfalls true.

Abgeleitete Klassen können auf die AllowNavigationToStep-Methode nur aufgrund des protected-Modifizierers zugreifen. In einer abgeleiteten Klasse können Sie mit der AllowNavigationToStep-Methode bestimmen, ob der übergebene Index zum Festlegen der ActiveStepIndex-Eigenschaft verwendet werden kann. Die AllowNavigationToStep-Methode gibt false zurück, wenn der übergebene Index auf ein WizardStepBase-Objekt verweist, auf das bereits zugegriffen und dessen AllowReturn-Eigenschaft auf false festgelegt wurde, andernfalls gibt sie true zurück.

Das folgende Codebeispiel veranschaulicht das Erstellen einer abgeleiteten Klasse mit dem Namen CustomWizard und das Überschreiben der OnSideBarButtonClick-Methode. Wenn auf eine Schaltfläche im Randleistenbereich des CustomWizard-Steuerelements geklickt wird, wird die AllowNavigationToStep-Methode aufgerufen, um zu bestimmen, ob auf den ausgewählten Schritt zugegriffen werden kann. Dann wird in der enthaltenden Webseite eine Meldung geschrieben, in der der Benutzer über die aufgetretenen Vorgänge informiert wird.

<%@ page language="C#"%>

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

<script runat="server">

  // This custom wizard control defines the OnSideBarButtonClick method
  // that uses the AllowNavigationToStep method to determine whether the
  // value passed in can be used to set the ActiveStepIndex property.    
  class CustomWizard : Wizard
  {    
    override protected void OnSideBarButtonClick(WizardNavigationEventArgs e)
    {
      base.OnSideBarButtonClick(e);
      if (AllowNavigationToStep(e.NextStepIndex))
      {
        this.Page.Response.Write("AllowNavigationToStep() returned true, moving to Step" 
          + (e.NextStepIndex + 1).ToString() + ".");
        this.ActiveStepIndex = e.NextStepIndex;
      }
      else
      {
        this.Page.Response.Write("AllowNavigationToStep() returned false for Step" 
          + (e.NextStepIndex + 1).ToString() + ", moving to Step2.");
        this.ActiveStepIndex = 1;
      }
    }         
  }

  // Add the custom wizard control to the page.
  void Page_Load(object sender, EventArgs e) 
  {
      CustomWizard WizardControl = new CustomWizard();
      WizardControl.ID = "WizardControl";

      // Create some steps for the custom wizard.
      for (int i = 0; i <= 5; i++)
      {
        WizardStep newStep = new WizardStep();
        newStep.ID = "Step" + (i + 1).ToString();
        // Set AllowReturn to false for some of the steps.        
        if ((i % 2) == 0)
        {
          newStep.AllowReturn = false;
        }

        // Add each step to the custom wizard.
        WizardControl.WizardSteps.Add(newStep);
      }

      // Display the wizard on the page.
      PlaceHolder1.Controls.Add(WizardControl);
  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>AllowNavigationToStep Example</title>
</head>
<body>
    <form id="Form1" runat="server">
      <h3>AllowNavigationToStep Example</h3>
      <asp:PlaceHolder id="PlaceHolder1" 
        runat="server" />
    </form>
  </body>
</html>


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

.NET Framework und .NET Compact Framework unterstützen nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen für .NET Framework.

.NET Framework

Unterstützt in: 3.5, 3.0, 2.0
Anzeigen: