BulletedListEventArgs.Index 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 the index of the list item in a BulletedList control that raised the event.

public:
 property int Index { int get(); };

public int Index { get; }

member this.Index : int

Public ReadOnly Property Index As Integer

Property Value

Int32

The index of the list item in a BulletedList control that raised the event.

Examples

The following example demonstrates how to specify and code an event handler for the Click event of a BulletedList control. When a list item is clicked, a message is displayed in a Label control on the page.

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

<!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 runat="server">
  <title>BulletedList Click Example</title>
  <script runat="server">

    void ItemsBulletedList_Click(object sender, System.Web.UI.WebControls.BulletedListEventArgs e)
    {

        // Change the message displayed in the label based on the index
        // of the list item that was clicked.
        switch (e.Index) 
      {
            case 0:
                Message.Text = "You clicked list item 1.";
                break;
            case 1:
                Message.Text = "You clicked list item 2.";
                break;
            case 2:
                Message.Text = "You clicked list item 3.";
                break;
            default:
                throw new Exception("You did not click a valid list item.");
                break;
        }

    }

  </script>

</head>
<body>

  <h3>BulletedList Click Example</h3>

  <form id="form1" runat="server">
            
    <p>Click on an item in the list to raise the Click event.</p> 
    
    <asp:BulletedList id="ItemsBulletedList" 
      BulletStyle="Disc"
      DisplayMode="LinkButton" 
      OnClick="ItemsBulletedList_Click"
      runat="server">    
        <asp:ListItem Value="http://www.cohowinery.com">Coho Winery</asp:ListItem>
        <asp:ListItem Value="http://www.contoso.com">Contoso, Ltd.</asp:ListItem>
        <asp:ListItem Value="http://www.tailspintoys.com">Tailspin Toys</asp:ListItem>
    </asp:BulletedList>
            
    <asp:Label id="Message" 
      Font-Size="12"
      Width="168px" 
      Font-Bold="True" 
      runat="server"
      AssociatedControlID="ItemsBulletedList"/>
              
   </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 runat="server">
  <title>BulletedList Click Example</title>
  <script runat="server">

    Sub ItemsBulletedList_Click(ByVal sender As Object, _
                                ByVal e As System.Web.UI.WebControls.BulletedListEventArgs)
      
      ' Change the message displayed in the label based on the index
      ' of the list item that was clicked.
      Select Case (e.Index)
        Case 0
          Message.Text = "You clicked list item 1."
        Case 1
          Message.Text = "You clicked list item 2."
        Case 2
          Message.Text = "You clicked list item 3."
        Case Else
          Throw New Exception("You did not click a valid list item.")
      End Select

    End Sub

    </script>

</head>
<body>

  <h3>BulletedList Click Example</h3>

  <form id="form1" runat="server">
            
    <p>Click on an item in the list to raise the Click event.</p> 
    
    <asp:BulletedList id="ItemsBulletedList" 
      BulletStyle="Disc"
      DisplayMode="LinkButton" 
      OnClick="ItemsBulletedList_Click"
      runat="server">    
        <asp:ListItem Value="http://www.cohowinery.com">Coho Winery</asp:ListItem>
        <asp:ListItem Value="http://www.contoso.com">Contoso, Ltd.</asp:ListItem>
        <asp:ListItem Value="http://www.tailspintoys.com">Tailspin Toys</asp:ListItem>
    </asp:BulletedList>
            
    <asp:Label id="Message" 
      Font-Size="12"
      Width="168px" 
      Font-Bold="True" 
      runat="server"
      AssociatedControlID="ItemsBulletedList"/>
              
   </form>

</body>
</html>

Remarks

Use this property to programmatically access the index of the list item in a BulletedList control that raised the event.

Applies to

Jaa