ListControl.SelectedValue, propriété (System.Web.UI.WebControls)

SelectedValue, propriété

Réduire tout

Filtre de language

Affichage du contenu : côte à côte

.NET Framework Class Library

ListControl..::.SelectedValue Property

Gets the value of the selected item in the list control, or selects the item in the list control that contains the specified value.

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

Syntax

Visual Basic

<BindableAttribute(True, BindingDirection.TwoWay)> _
<BrowsableAttribute(False)> _
<ThemeableAttribute(False)> _
Public Overridable Property SelectedValue As String
    Get
    Set

[BindableAttribute(true, BindingDirection.TwoWay)]
[BrowsableAttribute(false)]
[ThemeableAttribute(false)]
public virtual string SelectedValue { get; set; }

Visual C++

[BindableAttribute(true, BindingDirection::TwoWay)]
[BrowsableAttribute(false)]
[ThemeableAttribute(false)]
public:
virtual property String^ SelectedValue {
    String^ get ();
    void set (String^ value);
}

[<BindableAttribute(true, BindingDirection.TwoWay)>]
[<BrowsableAttribute(false)>]
[<ThemeableAttribute(false)>]
abstract SelectedValue : string with get, set
[<BindableAttribute(true, BindingDirection.TwoWay)>]
[<BrowsableAttribute(false)>]
[<ThemeableAttribute(false)>]
override SelectedValue : string with get, set

ASP.NET

<asp:ListControl SelectedValue="String" />

Property Value

Type: System..::.String
The value of the selected item in the list control. The default is an empty string ("").

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The selected value is not in the list of available values and view state or other state has been loaded (a postback has been performed). For more information, see the Remarks section.

Remarks

This property returns the Value property of the selected ListItem. The SelectedValue property is commonly used to determine the value of the selected item in the list control. If multiple items are selected, the value of the selected item with the lowest index is returned. If no item is selected, an empty string ("") is returned.

The SelectedValue property can also be used to select an item in the list control by setting it with the value of the item.

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

When the selected value is not in the list of available values and a postback is performed, an ArgumentOutOfRangeException exception is thrown. The following example shows how to catch an invalid value before postback occurs:

Visual Basic

Me.DropDownList1.Items.Add(New ListItem( Text="Hello", Value="1" )) 
If DropDownList1.Items.FindByValue("2") IsNot Nothing Then 
    Response.Write("Found") 
End If

this.DropDownList1.Items.Add(new ListItem{ Text="Hello", Value="1" });
if(DropDownList1.Items.FindByValue("2") != null) {
    Response.Write("Found");
}

Examples

The following example demonstrates how to use the SelectedValue property to select an item in a ListBox control. Notice that this property can also be used to retrieve the value of the selected item.

Security Note
This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

Visual Basic


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

<head runat="server">
    <title> ListControl SelectedValue Example </title>
<script runat="server">

      Sub Button_Click(sender As Object, e As EventArgs)

         ' Perform this operation in a try-catch block in case the item is not found.
         Try

            List.SelectedValue = ItemTextBox.Text
            MessageLabel.Text = "You selected " & List.SelectedValue + "."

         Catch ex As Exception

            List.SelectedValue = Nothing         
            MessageLabel.Text = "Item not found in ListBox control."

         End Try

      End Sub

   </script>

</head>

<body>

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

      <h3> ListControl SelectedValue Example </h3>

      <asp:ListBox ID="List"
           runat="server">

         <asp:ListItem>Item 1</asp:ListItem>
         <asp:ListItem>Item 2</asp:ListItem>
         <asp:ListItem>Item 3</asp:ListItem>
         <asp:ListItem>Item 4</asp:ListItem>

      </asp:ListBox>

      <hr />

      Enter the value of the item to select: <br />
      <asp:TextBox ID="ItemTextBox"
           MaxLength="6"
           Text="Item 1"
           runat="server"/>

      &nbsp;&nbsp;

      <asp:Button ID="SelectButton"
           Text="Select Item"
           OnClick="Button_Click"
           runat="server"/>

      <br /><br />

      <asp:Label ID="MessageLabel"
           runat="server"/>     

   </form>

</body>
</html>


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

<head runat="server">
    <title> ListControl SelectedValue Example </title>
<script runat="server">

      void Button_Click(Object sender, EventArgs e)
      {

         // Perform this operation in a try-catch block in case the item is not found.
         try
         {
            List.SelectedValue = ItemTextBox.Text;
            MessageLabel.Text = "You selected " + List.SelectedValue + ".";
         }
         catch (Exception ex)
         {
            List.SelectedValue = null;
            MessageLabel.Text = "Item not found in ListBox control.";
         }

      }

   </script>

</head>

<body>

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

      <h3> ListControl SelectedValue Example </h3>

      <asp:ListBox ID="List"
           runat="server">

         <asp:ListItem>Item 1</asp:ListItem>
         <asp:ListItem>Item 2</asp:ListItem>
         <asp:ListItem>Item 3</asp:ListItem>
         <asp:ListItem>Item 4</asp:ListItem>

      </asp:ListBox>

      <hr />

      Enter the value of the item to select: <br />
      <asp:TextBox ID="ItemTextBox"
           MaxLength="6"
           Text="Item 1"
           runat="server"/>

      &nbsp;&nbsp;

      <asp:Button ID="SelectButton"
           Text="Select Item"
           OnClick="Button_Click"
           runat="server"/>

      <br /><br />

      <asp:Label ID="MessageLabel"
           runat="server"/>     

   </form>

</body>
</html>

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role not supported), Windows Server 2003 SP2

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

Reference

ListControl Class

System.Web.UI.WebControls Namespace

System..::.ArgumentOutOfRangeException

Bibliothèque de classes .NET Framework

ListControl..::.SelectedValue, propriété

Obtient la valeur de l'élément sélectionné dans le contrôle de liste ou sélectionne, dans ce contrôle, l'élément qui contient la valeur spécifiée.

Espace de noms : System.Web.UI.WebControls
Assembly : System.Web (dans System.Web.dll)

Syntaxe

Visual Basic

<BindableAttribute(True, BindingDirection.TwoWay)> _
<BrowsableAttribute(False)> _
<ThemeableAttribute(False)> _
Public Overridable Property SelectedValue As String
    Get
    Set

[BindableAttribute(true, BindingDirection.TwoWay)]
[BrowsableAttribute(false)]
[ThemeableAttribute(false)]
public virtual string SelectedValue { get; set; }

VisualC++

[BindableAttribute(true, BindingDirection::TwoWay)]
[BrowsableAttribute(false)]
[ThemeableAttribute(false)]
public:
virtual property String^ SelectedValue {
    String^ get ();
    void set (String^ value);
}

[<BindableAttribute(true, BindingDirection.TwoWay)>]
[<BrowsableAttribute(false)>]
[<ThemeableAttribute(false)>]
abstract SelectedValue : string with get, set
[<BindableAttribute(true, BindingDirection.TwoWay)>]
[<BrowsableAttribute(false)>]
[<ThemeableAttribute(false)>]
override SelectedValue : string with get, set

ASP.NET

<asp:ListControl SelectedValue="String" />

Valeur de propriété

Type : System..::.String
Valeur de l'élément sélectionné dans le contrôle de liste. La valeur par défaut est une chaîne vide ("").

Exceptions

Exception	Condition
ArgumentOutOfRangeException	La valeur sélectionnée ne figure pas dans la liste de valeurs disponibles, et l'état d'affichage ou un autre état a été chargé (une publication a été exécutée). Pour plus d'informations, consultez la section Notes.

Notes

Cette propriété retourne la propriété Value du ListItem sélectionné. La propriété SelectedValue est habituellement utilisée pour déterminer la valeur de l'élément sélectionné dans le contrôle de liste. Si plusieurs éléments sont sélectionnés, la valeur de l'élément sélectionné avec l'index le moins élevé est retournée. Si aucun élément n'est sélectionné, une chaîne vide ("") est retournée.

La propriété SelectedValue peut également servir à sélectionner un élément dans le contrôle de liste si vous lui attribuez la valeur de l'élément.

Cette propriété ne peut pas être définie par les thèmes ou les thèmes de feuille de style. Pour plus d'informations, consultez ThemeableAttribute et Thèmes et apparences ASP.NET.

Lorsque la valeur sélectionnée n'est pas dans la liste des valeurs disponibles et qu'une publication (postback) est exécutée, une exception ArgumentOutOfRangeException est levée. L'exemple suivant montre comment intercepter une valeur non valide avant que la publication (postback) n'ait lieu :

Visual Basic

Me.DropDownList1.Items.Add(New ListItem( Text="Hello", Value="1" )) 
If DropDownList1.Items.FindByValue("2") IsNot Nothing Then 
    Response.Write("Found") 
End If

this.DropDownList1.Items.Add(new ListItem{ Text="Hello", Value="1" });
if(DropDownList1.Items.FindByValue("2") != null) {
    Response.Write("Found");
}

Exemples

L'exemple suivant illustre l'utilisation de la propriété SelectedValue pour sélectionner un élément dans un contrôle ListBox. Notez que cette propriété permet également de récupérer la valeur de l'élément sélectionné.

Note de sécurité
Cet exemple a une zone de texte qui accepte l'entrée d'utilisateur, ce qui constitue une menace éventuelle pour la sécurité. Par défaut, les pages Web ASP.NET vérifient que l'entrée d'utilisateur n'inclut pas de script ni d'éléments HTML. Pour plus d'informations, consultez Vue d'ensemble des attaques de script.

Visual Basic


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

<head runat="server">
    <title> ListControl SelectedValue Example </title>
<script runat="server">

      Sub Button_Click(sender As Object, e As EventArgs)

         ' Perform this operation in a try-catch block in case the item is not found.
         Try

            List.SelectedValue = ItemTextBox.Text
            MessageLabel.Text = "You selected " & List.SelectedValue + "."

         Catch ex As Exception

            List.SelectedValue = Nothing         
            MessageLabel.Text = "Item not found in ListBox control."

         End Try

      End Sub

   </script>

</head>

<body>

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

      <h3> ListControl SelectedValue Example </h3>

      <asp:ListBox ID="List"
           runat="server">

         <asp:ListItem>Item 1</asp:ListItem>
         <asp:ListItem>Item 2</asp:ListItem>
         <asp:ListItem>Item 3</asp:ListItem>
         <asp:ListItem>Item 4</asp:ListItem>

      </asp:ListBox>

      <hr />

      Enter the value of the item to select: <br />
      <asp:TextBox ID="ItemTextBox"
           MaxLength="6"
           Text="Item 1"
           runat="server"/>

      &nbsp;&nbsp;

      <asp:Button ID="SelectButton"
           Text="Select Item"
           OnClick="Button_Click"
           runat="server"/>

      <br /><br />

      <asp:Label ID="MessageLabel"
           runat="server"/>     

   </form>

</body>
</html>


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

<head runat="server">
    <title> ListControl SelectedValue Example </title>
<script runat="server">

      void Button_Click(Object sender, EventArgs e)
      {

         // Perform this operation in a try-catch block in case the item is not found.
         try
         {
            List.SelectedValue = ItemTextBox.Text;
            MessageLabel.Text = "You selected " + List.SelectedValue + ".";
         }
         catch (Exception ex)
         {
            List.SelectedValue = null;
            MessageLabel.Text = "Item not found in ListBox control.";
         }

      }

   </script>

</head>

<body>

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

      <h3> ListControl SelectedValue Example </h3>

      <asp:ListBox ID="List"
           runat="server">

         <asp:ListItem>Item 1</asp:ListItem>
         <asp:ListItem>Item 2</asp:ListItem>
         <asp:ListItem>Item 3</asp:ListItem>
         <asp:ListItem>Item 4</asp:ListItem>

      </asp:ListBox>

      <hr />

      Enter the value of the item to select: <br />
      <asp:TextBox ID="ItemTextBox"
           MaxLength="6"
           Text="Item 1"
           runat="server"/>

      &nbsp;&nbsp;

      <asp:Button ID="SelectButton"
           Text="Select Item"
           OnClick="Button_Click"
           runat="server"/>

      <br /><br />

      <asp:Label ID="MessageLabel"
           runat="server"/>     

   </form>

</body>
</html>

Informations de version

.NET Framework

Pris en charge dans : 4, 3.5, 3.0, 2.0, 1.1

Plateformes

Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows XP SP2 Édition x64, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2

Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.

Voir aussi

Référence

ListControl Classe

System.Web.UI.WebControls, espace de noms

System..::.ArgumentOutOfRangeException

Mots clés

: Ajouter un mot clé

Contenu de la communauté

Ajouter du contenu

Annotations

Gérer votre profil | Contactez-nous | Newsletter MSDN