BulletedList.DisplayMode 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 display mode of the list content in a BulletedList control.

public:
 virtual property System::Web::UI::WebControls::BulletedListDisplayMode DisplayMode { System::Web::UI::WebControls::BulletedListDisplayMode get(); void set(System::Web::UI::WebControls::BulletedListDisplayMode value); };

public virtual System.Web.UI.WebControls.BulletedListDisplayMode DisplayMode { get; set; }

member this.DisplayMode : System.Web.UI.WebControls.BulletedListDisplayMode with get, set

Public Overridable Property DisplayMode As BulletedListDisplayMode

Property Value

BulletedListDisplayMode

One of the BulletedListDisplayMode values. The default is Text.

Exceptions

ArgumentOutOfRangeException

The specified type is not one of the BulletedListDisplayMode values.

Examples

The following code example demonstrates how to create a BulletedList control and set the DisplayMode property. A ListBox control is populated with the BulletedListDisplayMode enumeration values. The format of the list item content changes based on the display mode that the user selects from the list box.

<%@ 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>DisplayMode Example</title>
<script runat="server">
  
  void Index_Changed(object sender, System.EventArgs e)
  {

      // Change the message displayed, based on 
      // the display mode selected from the list box.
      if (DisplayModeListBox.SelectedIndex > -1)
      {
          Message1.Text = "You chose: " + DisplayModeListBox.SelectedItem.Text;
      }

      // Change the display mode, based on 
      // the mode selected from the list box.
      switch (DisplayModeListBox.SelectedIndex) 
    {
          case 0:
              ItemsBulletedList.DisplayMode = BulletedListDisplayMode.Text;
              Message2.Text = "";
              break;
          case 1:
              ItemsBulletedList.DisplayMode = BulletedListDisplayMode.HyperLink;
              // Opens a new browser window to display the page linked to.
              ItemsBulletedList.Target = "_blank";
              Message2.Text = "";
              break;
          case 2:
              ItemsBulletedList.DisplayMode = BulletedListDisplayMode.LinkButton;
              break;
          default:
              throw new Exception("You did not select a valid display mode.");
              break;
      }

  }

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

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

  }

</script>

</head>
<body>

  <h3>DisplayMode Example</h3>

  <form id="form1" runat="server">

    <h3>BulletedListDisplayMode Example</h3>

    <p>
    <asp:BulletedList id="ItemsBulletedList" 
      BulletStyle="Disc"
      DisplayMode="Text" 
      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></p>

    <hr />

    <h4>Select from the list to change the display mode:</h4>
    <asp:ListBox id="DisplayModeListBox" 
      Rows="1"
      SelectionMode="Single"
      AutoPostBack="True"
      OnSelectedIndexChanged="Index_Changed"
      runat="server">
        <asp:ListItem>Text</asp:ListItem>
        <asp:ListItem>Hyperlink</asp:ListItem>
        <asp:ListItem>LinkButton</asp:ListItem>
    </asp:ListBox>

    <asp:Label id="Message1" 
      runat="server"
      AssociatedControlID="DisplayModeListBox"/><br /><br />

    <asp:Label id="Message2"
      runat="server"
      AssociatedControlID="DisplayModeListBox"/>

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

  Sub Index_Changed(ByVal sender As Object, ByVal e As System.EventArgs)

    ' Change the message displayed, based on 
    ' the display mode selected from the list box.
    If DisplayModeListBox.SelectedIndex > -1 Then
      Message1.Text = "You chose: " & DisplayModeListBox.SelectedItem.Text
    End If

    ' Change the display mode, based on 
    ' the mode selected from the list box.
    Select Case (DisplayModeListBox.SelectedIndex)
      Case 0
        ItemsBulletedList.DisplayMode = BulletedListDisplayMode.Text
        Message2.Text = ""
      Case 1
        ItemsBulletedList.DisplayMode = BulletedListDisplayMode.HyperLink
        ' Opens a new browser window to display the page linked to.
        ItemsBulletedList.Target = "_blank"
        Message2.Text = ""
      Case 2
        ItemsBulletedList.DisplayMode = BulletedListDisplayMode.LinkButton
      Case Else
        Throw New Exception("You did not select a valid display mode.")
    End Select

  End Sub

  Sub ItemsBulletedList_Click(ByVal sender As Object, _
                              ByVal e As System.Web.UI.WebControls.BulletedListEventArgs)

    ' Change the message displayed, based on the index
    ' of the bulletedlist list item that was clicked.
    Select Case (e.Index)
      Case 0
        Message2.Text = "You  clicked list item 1."
      Case 1
        Message2.Text = "You  clicked list item 2."
      Case 2
        Message2.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>DisplayMode Example</h3>

  <form id="form1" runat="server">

    <h3>BulletedListDisplayMode Example</h3>

    <p>
    <asp:BulletedList id="ItemsBulletedList" 
      BulletStyle="Disc"
      DisplayMode="Text" 
      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></p>

    <hr />

    <h4>Select from the list to change the display mode:</h4>
    <asp:ListBox id="DisplayModeListBox" 
      Rows="1"
      SelectionMode="Single"
      AutoPostBack="True"
      OnSelectedIndexChanged="Index_Changed"
      runat="server">
        <asp:ListItem>Text</asp:ListItem>
        <asp:ListItem>Hyperlink</asp:ListItem>
        <asp:ListItem>LinkButton</asp:ListItem>
    </asp:ListBox>

    <asp:Label id="Message1" 
      runat="server"
      AssociatedControlID="DisplayModeListBox"/><br /><br />

    <asp:Label id="Message2"
      runat="server"
      AssociatedControlID="DisplayModeListBox"/>

   </form>

</body>
</html>

Remarks

Use the DisplayMode property to specify the display behavior to apply to the content of list items in a BulletedList control. The DisplayMode property is set using one of the BulletedListDisplayMode enumeration values. The following table lists the possible values.

Value	Displayed as
Text	Text.
HyperLink	Hyperlinks.
LinkButton	Link buttons.

The HyperLink value allows you to display list content as hyperlinks. When clicked, a hyperlink navigates to a URL. Use the Value property to specify the URL that a hyperlink navigates to.

The LinkButton field allows you to display list content as links. Use the BulletedList.Click event to post back to the server when a link button is clicked.

The value of this property is stored in view state.

Applies to