ListView.SelectedDataKey Property
Definition
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 data-key value for the selected item in a ListView control.
public:
virtual property System::Web::UI::WebControls::DataKey ^ SelectedDataKey { System::Web::UI::WebControls::DataKey ^ get(); };[System.ComponentModel.Browsable(false)]
public virtual System.Web.UI.WebControls.DataKey SelectedDataKey { get; }[<System.ComponentModel.Browsable(false)>]
member this.SelectedDataKey : System.Web.UI.WebControls.DataKeyPublic Overridable ReadOnly Property SelectedDataKey As DataKeyProperty Value
The data key for the selected item in a ListView control. The default is null, which indicates that no item is currently selected.
- Attributes
Exceptions
No data keys are specified in the DataKeyNames property.
Examples
The following example shows how to use the second key field as a parameter in a master/detail scenario. A ListView control is used to display records from the Product Inventory table of the AdventureWorks database. When an item is selected in the ListView control, the details of the product are displayed in another ListView control. ProductID is the second key name in the first ListView control. To access the second key, the code uses the value of ProductInventoryListView.SelectedDataKey[1] (ProductInventoryListView.SelectedDataKey(1) in Visual Basic) as the PropertyName for the ControlParameter object. This parameter object is in turn used by the SqlDataSource control that the second ListView control is bound to.
<%@ Page language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
protected void ProductInventoryListView_PagePropertiesChanging(object sender,
PagePropertiesChangingEventArgs e)
{
ProductInventoryListView.SelectedIndex = -1;
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>ListView SelectedDataKey Example</title>
<style type="text/css">
.header
{
border: 1px solid #008080;
background-color: #008080;
color: White;
}
.item td { border: 1px solid #008080; }
</style>
</head>
<body>
<form id="form1" runat="server">
<h3>ListView SelectedDataKey Example</h3>
<asp:ListView runat="server"
ID="ProductInventoryListView"
DataSourceID="ProductInventoryDataSource"
DataKeyNames="LocationID,ProductID"
OnPagePropertiesChanging="ProductInventoryListView_PagePropertiesChanging">
<LayoutTemplate>
<b>Product Inventory</b>
<br />
<table width="400px" runat="server" id="tblProducts">
<tr class="header" runat="server">
<th runat="server"> </th>
<th runat="server">Product ID</th>
<th runat="server">Location ID</th>
<th runat="server">Shelf</th>
<th runat="server">Bin</th>
<th runat="server">Quantity</th>
</tr>
<tr runat="server" id="itemPlaceholder" />
</table>
<asp:DataPager runat="server" ID="ProductInventoryPager">
<Fields>
<asp:NextPreviousPagerField ShowFirstPageButton="true"
ShowLastPageButton="true" />
</Fields>
</asp:DataPager>
</LayoutTemplate>
<ItemTemplate>
<tr class="item" runat="server">
<td>
<asp:ImageButton runat="server"
ID="SelectButton"
Width="15"
Height="15"
ImageUrl="~/images/select.jpg"
CommandName="Select" />
</td>
<td>
<asp:Label runat="server" ID="ProductIDLabel" Text='<%#Eval("ProductID") %>' />
</td>
<td>
<asp:Label runat="server" ID="LocationIDLabel" Text='<%#Eval("LocationID") %>' />
</td>
<td>
<asp:Label runat="server" ID="ShelfLabel" Text='<%#Eval("Shelf") %>' />
</td>
<td>
<asp:Label runat="server" ID="BinLabel" Text='<%#Eval("Bin") %>' />
</td>
<td>
<asp:Label runat="server" ID="QuantityLabel" Text='<%#Eval("Quantity") %>' />
</td>
</tr>
</ItemTemplate>
</asp:ListView>
<br /><br />
<asp:ListView runat="server" ID="ProductListView"
DataSourceID="ProductDataSource">
<LayoutTemplate>
<b>Product Details</b>
<table runat="server" id="tblDetails">
<tr runat="server" id="itemPlaceholder" />
</table>
</LayoutTemplate>
<ItemTemplate>
<tr runat="server">
<td class="header">Product ID:</td>
<td>
<asp:Label runat="server" ID="ProductLabel" Text='<%#Eval("ProductID") %>' />
</td>
</tr>
<tr runat="server">
<td class="header">Name:</td>
<td>
<asp:Label runat="server" ID="NameLabel" Text='<%#Eval("Name") %>' />
</td>
</tr>
<tr runat="server">
<td class="header">Color:</td>
<td>
<asp:Label runat="server" ID="ColorLabel" Text='<%#Eval("Color") %>' />
</td>
</tr>
<tr runat="server">
<td class="header">Price:</td>
<td>
<asp:Label runat="server" ID="ListPriceLabel" Text='<%#Eval("ListPrice", "{0:c}") %>' />
</td>
</tr>
</ItemTemplate>
</asp:ListView>
<!-- This example uses Microsoft SQL Server and connects -->
<!-- to the AdventureWorks sample database. Use an ASP.NET -->
<!-- expression to retrieve the connection string value -->
<!-- from the Web.config file. -->
<asp:SqlDataSource ID="ProductInventoryDataSource" runat="server"
ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
SelectCommand="SELECT [ProductID], [LocationID], [Shelf], [Bin], [Quantity]
FROM Production.ProductInventory">
</asp:SqlDataSource>
<asp:SqlDataSource ID="ProductDataSource" runat="server"
ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
SelectCommand="SELECT [ProductID], [Name], [Color], [ListPrice], [ProductNumber]
FROM Production.Product
WHERE ProductID = @ProductID
ORDER BY [Name]">
<SelectParameters>
<asp:ControlParameter Name="ProductID"
DefaultValue="0"
ControlID="ProductInventoryListView"
PropertyName="SelectedDataKey[1]" />
</SelectParameters>
</asp:SqlDataSource>
</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">
<script runat="server">
Protected Sub ProductInventoryListView_PagePropertiesChanging(ByVal sender As Object, _
ByVal e As PagePropertiesChangingEventArgs)
ProductInventoryListView.SelectedIndex = -1
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>ListView SelectedDataKey Example</title>
<style type="text/css">
.header
{
border: 1px solid #008080;
background-color: #008080;
color: White;
}
.item td { border: 1px solid #008080; }
</style>
</head>
<body>
<form id="form1" runat="server">
<h3>ListView SelectedDataKey Example</h3>
<asp:ListView runat="server"
ID="ProductInventoryListView"
DataSourceID="ProductInventoryDataSource"
DataKeyNames="LocationID,ProductID"
OnPagePropertiesChanging="ProductInventoryListView_PagePropertiesChanging">
<LayoutTemplate>
<b>Product Inventory</b>
<br />
<table width="400px" runat="server" id="tblProducts">
<tr class="header" runat="server">
<th runat="server"> </th>
<th runat="server">Product ID</th>
<th runat="server">Location ID</th>
<th runat="server">Shelf</th>
<th runat="server">Bin</th>
<th runat="server">Quantity</th>
</tr>
<tr runat="server" id="itemPlaceholder" />
</table>
<asp:DataPager runat="server" ID="ProductInventoryPager">
<Fields>
<asp:NextPreviousPagerField ShowFirstPageButton="true"
ShowLastPageButton="true" />
</Fields>
</asp:DataPager>
</LayoutTemplate>
<ItemTemplate>
<tr class="item" runat="server">
<td>
<asp:ImageButton runat="server"
ID="SelectButton"
Width="15"
Height="15"
ImageUrl="~/images/select.jpg"
CommandName="Select" />
</td>
<td>
<asp:Label runat="server" ID="ProductIDLabel" Text='<%#Eval("ProductID") %>' />
</td>
<td>
<asp:Label runat="server" ID="LocationIDLabel" Text='<%#Eval("LocationID") %>' />
</td>
<td>
<asp:Label runat="server" ID="ShelfLabel" Text='<%#Eval("Shelf") %>' />
</td>
<td>
<asp:Label runat="server" ID="BinLabel" Text='<%#Eval("Bin") %>' />
</td>
<td>
<asp:Label runat="server" ID="QuantityLabel" Text='<%#Eval("Quantity") %>' />
</td>
</tr>
</ItemTemplate>
</asp:ListView>
<br /><br />
<asp:ListView runat="server" ID="ProductListView"
DataSourceID="ProductDataSource">
<LayoutTemplate>
<b>Product Details</b>
<table runat="server" id="tblDetails">
<tr runat="server" id="itemPlaceholder" />
</table>
</LayoutTemplate>
<ItemTemplate>
<tr runat="server">
<td class="header">Product ID:</td>
<td>
<asp:Label runat="server" ID="ProductLabel" Text='<%#Eval("ProductID") %>' />
</td>
</tr>
<tr runat="server">
<td class="header">Name:</td>
<td>
<asp:Label runat="server" ID="NameLabel" Text='<%#Eval("Name") %>' />
</td>
</tr>
<tr runat="server">
<td class="header">Color:</td>
<td>
<asp:Label runat="server" ID="ColorLabel" Text='<%#Eval("Color") %>' />
</td>
</tr>
<tr runat="server">
<td class="header">Price:</td>
<td>
<asp:Label runat="server" ID="ListPriceLabel" Text='<%#Eval("ListPrice", "{0:c}") %>' />
</td>
</tr>
</ItemTemplate>
</asp:ListView>
<!-- This example uses Microsoft SQL Server and connects -->
<!-- to the AdventureWorks sample database. Use an ASP.NET -->
<!-- expression to retrieve the connection string value -->
<!-- from the Web.config file. -->
<asp:SqlDataSource ID="ProductInventoryDataSource" runat="server"
ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
SelectCommand="SELECT [ProductID], [LocationID], [Shelf], [Bin], [Quantity]
FROM Production.ProductInventory">
</asp:SqlDataSource>
<asp:SqlDataSource ID="ProductDataSource" runat="server"
ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
SelectCommand="SELECT [ProductID], [Name], [Color], [ListPrice], [ProductNumber]
FROM Production.Product
WHERE ProductID = @ProductID
ORDER BY [Name]">
<SelectParameters>
<asp:ControlParameter Name="ProductID"
DefaultValue="0"
ControlID="ProductInventoryListView"
PropertyName="SelectedDataKey[1]" />
</SelectParameters>
</asp:SqlDataSource>
</form>
</body>
</html>
Remarks
When the DataKeyNames property is set, the ListView control creates a DataKey object for each item in the control by using the value or values of the specified field or fields. The DataKey objects are then added to the control's DataKeys collection. Normally, the DataKeys property is used to retrieve the DataKey object for a specific data item in the ListView control. However, if you want to retrieve only the DataKey object of the currently selected item, you can use the SelectedDataKey property as a shortcut.
Using the SelectedDataKey property is the same as retrieving the DataKey object from the DataKeys collection at the index that is specified by the SelectedIndex property. You can also use the SelectedValue property to retrieve the data-key value for the currently selected item directly.
If you are creating a ControlParameter object and you want to access a key field other than the first field, use the indexed SelectedDataKey property in the PropertyName property of the ControlParameter object.
