RadioButton.GroupName Property

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.

Gets or sets the name of the group that the radio button belongs to.

public:
 virtual property System::String ^ GroupName { System::String ^ get(); void set(System::String ^ value); };

public virtual string GroupName { get; set; }

[System.Web.UI.Themeable(false)]
public virtual string GroupName { get; set; }

member this.GroupName : string with get, set

[<System.Web.UI.Themeable(false)>]
member this.GroupName : string with get, set

Public Overridable Property GroupName As String

Property Value

String

The name of the group that the radio button belongs to. The default is an empty string ("").

Attributes: ThemeableAttribute

Examples

The following code example illustrates how to set the GroupName property programmatically.

<%@ Page Language="C#" AutoEventWireup="True" %>
<!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>
    <title>Panel Example</title>
<script language="C#" runat="server">
 
       void Button1_Click(Object sender, EventArgs e) {
          if (Radio3.GroupName == "RegularMenu") {
             Radio3.GroupName = "vegetarianMenu";
             Radio3.BackColor = System.Drawing.Color.LightGreen;
          } 
          else {
            Radio3.GroupName = "RegularMenu";
            Radio3.BackColor = System.Drawing.Color.Pink;
          }
       }    
 
    </script>
 </head>
 <body>
 
     <h3>Panel Example</h3>
 
     <form id="form1" runat="server">
 
        <asp:Label id="Label1" BackColor="Pink" Text="RegularMenu" runat="server"/>
         
 
        <asp:Label id="Label2" BackColor="LightGreen" Text="vegetarianMenu" runat="server"/>
        <br />
 
        <asp:RadioButton id="Radio1" GroupName="RegularMenu"
             Text="Beef" BackColor="Pink" runat="server"/>
 
        <br />
        <asp:RadioButton id="Radio2" GroupName="RegularMenu"
             Text="Pork" BackColor="Pink" runat="server"/>
 
        <br />
        <asp:RadioButton id="Radio3" GroupName="RegularMenu"
             Text="Fish" BackColor="Pink" runat="server"/>
 
        <br />
        <asp:RadioButton id="Radio4" GroupName="vegetarianMenu"
             Text="Mushroom" BackColor="LightGreen" runat="server"/>
 
        <br />
        <asp:RadioButton id="Radio5" GroupName="vegetarianMenu"
             Text="Tofu" BackColor="LightGreen" runat="server"/>
 
        <br />
        <asp:Button id="Button1" OnClick="Button1_Click"
             Text="Regroup the radio buttons" runat="server"/>
 
    </form>
 
 </body>
 </html>

<%@ Page Language="VB" AutoEventWireup="True" %>
<!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>
    <title>Panel Example</title>
<script language="VB" runat="server">
 
    Sub Button1_Click(sender As Object, e As EventArgs)
        If Radio3.GroupName = "RegularMenu" Then
            Radio3.GroupName = "vegetarianMenu"
            Radio3.BackColor = System.Drawing.Color.LightGreen
        Else
            Radio3.GroupName = "RegularMenu"
            Radio3.BackColor = System.Drawing.Color.Pink
        End If
    End Sub
 
    </script>
 </head>
 <body>
 
     <h3>Panel Example</h3>
 
     <form id="form1" runat="server">
 
        <asp:Label id="Label1" BackColor="Pink" Text="RegularMenu" runat="server"/>
         
 
        <asp:Label id="Label2" BackColor="LightGreen" Text="vegetarianMenu" runat="server"/>
        <br />
 
        <asp:RadioButton id="Radio1" GroupName="RegularMenu"
             Text="Beef" BackColor="Pink" runat="server"/>
 
        <br />
        <asp:RadioButton id="Radio2" GroupName="RegularMenu"
             Text="Pork" BackColor="Pink" runat="server"/>
 
        <br />
        <asp:RadioButton id="Radio3" GroupName="RegularMenu"
             Text="Fish" BackColor="Pink" runat="server"/>
 
        <br />
        <asp:RadioButton id="Radio4" GroupName="vegetarianMenu"
             Text="Mushroom" BackColor="LightGreen" runat="server"/>
 
        <br />
        <asp:RadioButton id="Radio5" GroupName="vegetarianMenu"
             Text="Tofu" BackColor="LightGreen" runat="server"/>
 
        <br />
        <asp:Button id="Button1" OnClick="Button1_Click"
             Text="Regroup the radio buttons" runat="server"/>
 
    </form>
 
 </body>
 </html>

Remarks

Use the GroupName property to specify a grouping of radio buttons to create a mutually exclusive set of controls. You can use the GroupName property when only one selection is possible from a list of available options.

When this property is set, only one RadioButton in the specified group can be selected at a time.

The value of this property is stored in view state.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

Applies to

Share via