MultiView.SwitchViewByIDCommandName Field

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents the command name associated with changing the active View control in a MultiView control, based on a specified View id. This field is read-only.

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

public static readonly string SwitchViewByIDCommandName

Field Value

Type: System.String

Use the SwitchViewByIDCommandName field to represent the "SwitchViewByID" command name.

You can use the value of this field to take advantage of the MultiView control's automatic updating of the active View control. For example, if a View control contains a Button control that navigates to the first View when clicked, you can set the CommandName property to the value of the SwitchViewByIDCommandName field, which is "SwitchViewByID". Set the CommandArgument property to the ID of the first View in the MultiView control, such as "Page1". This causes the MultiView control to automatically set "Page1" as the active View when the button is clicked.

The following code example demonstrates how to use a MultiView control to create a basic survey. Each View control is a separate survey question. The PreviousViewCommandName and NextViewCommandName fields are used to provide automatic navigation between the previous and next View controls in the survey. If the user clicks the Retake Survey button in the last View of the survey, the SwitchViewByIDCommandName field is used along with a command argument of "Page1" to redirect the user back to the first View of the survey.

System_CAPS_noteNote

The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see ASP.NET Web Forms Page Code Model.

<%@ 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">

    void Page4SaveButton_Click(Object sender, System.EventArgs e)
    {
      // The user wants to save the survey results.
      // Insert code here to save survey results.

      // Disable the navigation buttons.
      Page4Save.Enabled = false;
      Page4Restart.Enabled = false;

    }

  </script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
  <title>MultiView.NextViewCommandName Example</title>
</head>
<body>
    <form id="Form1" runat="Server">

      <h3>MultiView.NextViewCommandName Example</h3>

      <asp:Panel id="Page1ViewPanel" 
        Width="330px" 
        Height="150px"
        HorizontalAlign="Left"
        Font-size="12" 
        BackColor="#C0C0FF" 
        BorderColor="#404040"
        BorderStyle="Double"                     
        runat="Server">  

        <asp:MultiView id="DevPollMultiView"
          ActiveViewIndex="0"
          runat="Server">

          <asp:View id="Page1" 
            runat="Server">   

            <asp:Label id="Page1Label" 
              Font-bold="true"                         
              Text="What kind of applications do you develop?"
              runat="Server"
              AssociatedControlID="Page1">
            </asp:Label>

            <br/><br/>

            <asp:RadioButton id="Page1Radio1"
              Text="Web Applications" 
              Checked="False" 
              GroupName="RadioGroup1" 
              runat="server">
            </asp:RadioButton>

            <br/>

            <asp:RadioButton id="Page1Radio2"
              Text="Windows Forms Applications" 
              Checked="False" 
              GroupName="RadioGroup1" 
              runat="server">
            </asp:RadioButton>

            <br/><br/><br/>                                       

            <asp:Button id="Page1Next"
              Text = "Next"
              CommandName="NextView"
              Height="25"
              Width="70"
              runat= "Server">
            </asp:Button>     

          </asp:View>

          <asp:View id="Page2" 
            runat="Server">

            <asp:Label id="Page2Label" 
              Font-bold="true"                        
              Text="How long have you been a developer?"
              runat="Server"
              AssociatedControlID="Page2">                    
            </asp:Label>

            <br/><br/>

            <asp:RadioButton id="Page2Radio1"
              Text="Less than five years" 
              Checked="False" 
              GroupName="RadioGroup1" 
              runat="Server">
            </asp:RadioButton>

            <br/>

            <asp:RadioButton id="Page2Radio2"
              Text="More than five years" 
              Checked="False" 
              GroupName="RadioGroup1" 
              runat="Server">
            </asp:RadioButton>

            <br/><br/><br/>

            <asp:Button id="Page2Back"
              Text = "Previous"
              CommandName="PrevView"
              Height="25"
              Width="70"
              runat= "Server">
            </asp:Button> 

            <asp:Button id="Page2Next"
              Text = "Next"
              CommandName="NextView"
              Height="25"
              Width="70"
              runat="Server">
            </asp:Button> 

          </asp:View>

          <asp:View id="Page3" 
            runat="Server">

            <asp:Label id="Page3Label1" 
              Font-bold="true"                        
              Text= "What is your primary programming language?"                        
              runat="Server"
              AssociatedControlID="Page3">                    
            </asp:Label>

            <br/><br/>

            <asp:RadioButton id="Page3Radio1"
              Text="Visual Basic" 
              Checked="False" 
              GroupName="RadioGroup1" 
              runat="Server">
            </asp:RadioButton>

            <br/>

            <asp:RadioButton id="Page3Radio2"
              Text="C#" 
              Checked="False" 
              GroupName="RadioGroup1" 
              runat="Server">
            </asp:RadioButton>

            <br/>

            <asp:RadioButton id="Page3Radio3"
              Text="C++" 
              Checked="False" 
              GroupName="RadioGroup1" 
              runat="Server">
            </asp:RadioButton>

            <br/><br/>

            <asp:Button id="Page3Back"
              Text = "Previous"
              CommandName="PrevView"
              Height="25"
              Width="70"
              runat="Server">
            </asp:Button> 

            <asp:Button id="Page3Next"
              Text = "Next"
              CommandName="NextView"
              Height="25"
              Width="70"
              runat="Server">
            </asp:Button>

            <br/>

          </asp:View>     

          <asp:View id="Page4"
            runat="Server">

          <asp:Label id="Label1"
            Font-bold="true"                                           
            Text = "Thank you for taking the survey."
            runat="Server"
            AssociatedControlID="Page4">
          </asp:Label>

          <br/><br/><br/><br/><br/><br/>       

          <asp:Button id="Page4Save"
            Text = "Save Responses"
            OnClick="Page4SaveButton_Click"
            Height="25"
            Width="110"
            runat="Server">
          </asp:Button>

          <asp:Button id="Page4Restart"
            Text = "Retake Survey"
            commandname="SwitchViewByID"
            commandargument="Page1"
            Height="25"
            Width="110"
            runat= "Server">
          </asp:Button>                    

        </asp:View>  

      </asp:MultiView>

    </asp:Panel> 

  </form>
</body>
</html>

.NET Framework
Available since 2.0
Return to top
Show: