This documentation is archived and is not being maintained.

BulletedList.DisplayMode Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the display mode of the list content in a BulletedList control.

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

public virtual BulletedListDisplayMode DisplayMode { get; set; }
/** @property */
public BulletedListDisplayMode get_DisplayMode ()

/** @property */
public void set_DisplayMode (BulletedListDisplayMode value)

public function get DisplayMode () : BulletedListDisplayMode

public function set DisplayMode (value : BulletedListDisplayMode)

Property Value

One of the BulletedListDisplayMode values. The default is Text.

Exception typeCondition

ArgumentOutOfRangeException

The specified type is not one of the BulletedListDisplayMode values.

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.

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="VB" %>

<html>
<head>
    <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>

	<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"/><br><br>

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

</body>
</html>

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: