DetailsView.DataKey 属性
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
获取一个 DataKey 对象，该对象表示所显示的记录的主键。
public:
virtual property System::Web::UI::WebControls::DataKey ^ DataKey { System::Web::UI::WebControls::DataKey ^ get(); };[System.ComponentModel.Browsable(false)]
public virtual System.Web.UI.WebControls.DataKey DataKey { get; }[<System.ComponentModel.Browsable(false)>]
member this.DataKey : System.Web.UI.WebControls.DataKeyPublic Overridable ReadOnly Property DataKey As DataKey属性值
一个 DataKey，表示所显示的记录的主键。
- 属性
示例
下面的代码示例演示如何使用 DataKey 属性来确定当前记录的键字段和相应值。
<%@ 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">
void CustomerDetailView_ItemUpdated(Object sender,
DetailsViewUpdatedEventArgs e)
{
// Create a dictionary that contains the key fields and values using
// the AllValues method of the DataKey object contained in the DataKey
// property.
IOrderedDictionary keyList = CustomerDetailView.DataKey.Values;
// Get the ArrayList objects that represent the key fields and values.
ArrayList keys = (ArrayList)keyList.Keys;
ArrayList values = (ArrayList)keyList.Values;
// Get the key field and value for the current record.
String keyField = keys[0].ToString();
String keyValue = values[0].ToString();
// Log the update operation using the key field and value.
LogUpdate(keyField, keyValue);
}
void LogUpdate(String keyField, String keyValue)
{
// Insert code to log the update operation.
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>DetailsView DataKey Example</title>
</head>
<body>
<form id="Form1" runat="server">
<h3>DetailsView DataKey Example</h3>
<asp:detailsview id="CustomerDetailView"
datasourceid="DetailsViewSource"
datakeynames="CustomerID"
autogeneraterows="true"
autogenerateeditbutton="true"
allowpaging="true"
onitemupdated="CustomerDetailView_ItemUpdated"
runat="server">
<headerstyle backcolor="Navy"
forecolor="White"/>
</asp:detailsview>
<!-- This example uses Microsoft SQL Server and connects -->
<!-- to the Northwind sample database. Use an ASP.NET -->
<!-- expression to retrieve the connection string value -->
<!-- from the web.config file. -->
<asp:SqlDataSource ID="DetailsViewSource" runat="server"
ConnectionString=
"<%$ ConnectionStrings:NorthWindConnectionString%>"
InsertCommand="INSERT INTO [Customers]([CustomerID],
[CompanyName], [Address], [City], [PostalCode], [Country])
VALUES (@CustomerID, @CompanyName, @Address, @City,
@PostalCode, @Country)"
SelectCommand="Select [CustomerID], [CompanyName],
[Address], [City], [PostalCode], [Country] From [Customers]"
UpdateCommand="UPDATE [Customers] SET
[CompanyName] = @CompanyName,
[Address] = @Address, [City] = @City,
[PostalCode] = @PostalCode, [Country] = @Country
WHERE [CustomerID] = @CustomerID">
</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">
Sub CustomerDetailView_ItemUpdated(ByVal sender As Object, _
ByVal e As DetailsViewUpdatedEventArgs)
' Create a dictionary that contains the key fields and values
' using the AllValues method of the DataKey object contained
' in the DataKey property.
Dim keyList As IOrderedDictionary = _
CustomerDetailsView.DataKey.Values
' Get the ArrayList objects that represent the key fields
' and values.
Dim keys As ArrayList = CType(keyList.Keys, ArrayList)
Dim values As ArrayList = CType(keyList.Values, ArrayList)
' Get the key field and value for the current record.
Dim keyField As String = keys(0).ToString()
Dim keyValue As String = values(0).ToString()
' Log the update operation using the key field and value.
LogUpdate(keyField, keyValue)
End Sub
Sub LogUpdate(ByVal keyField As String, ByVal keyValue As String)
' Insert code to log the update operation.
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>
DetailsView DataKey Example</title>
</head>
<body>
<form id="Form1" runat="server">
<h3>
DetailsView DataKey Example</h3>
<asp:DetailsView ID="CustomerDetailsView"
DataSourceID="DetailsViewSource"
DataKeyNames="CustomerID"
AutoGenerateRows="true"
AutoGenerateEditButton="true"
AllowPaging="true"
OnItemUpdated="CustomerDetailView_ItemUpdated"
runat="server">
<HeaderStyle BackColor="Navy" ForeColor="White" />
</asp:DetailsView>
<!-- This example uses Microsoft SQL Server and connects -->
<!-- to the Northwind sample database. Use an ASP.NET -->
<!-- expression to retrieve the connection string value -->
<!-- from the web.config file. -->
<asp:SqlDataSource ID="DetailsViewSource" runat="server"
ConnectionString=
"<%$ ConnectionStrings:NorthWindConnectionString%>"
InsertCommand="INSERT INTO [Customers]([CustomerID],
[CompanyName], [Address], [City], [PostalCode], [Country])
VALUES (@CustomerID, @CompanyName, @Address, @City,
@PostalCode, @Country)"
SelectCommand="Select [CustomerID], [CompanyName],
[Address], [City], [PostalCode], [Country]
From [Customers]"
UpdateCommand="UPDATE [Customers] SET [CompanyName] = @CompanyName,
[Address] = @Address, [City] = @City,
[PostalCode] = @PostalCode, [Country] = @Country
WHERE [CustomerID] = @CustomerID"></asp:SqlDataSource>
</form>
</body>
</html>
注解
DataKeyNames设置属性后，控件DetailsView会自动创建一个DataKey对象，该对象代表当前记录的键字段或字段。 使用属性 DataKey 获取此 DataKey 对象。 此属性通常用于获取属性中指定的 DataKeyNames 字段的键及其相应值。
备注
作为快捷方式，还可以使用该 SelectedValue 属性来确定属性中列出的 DataKeyNames 第一个键字段的值。