Gets a collection of DataKey objects that represent the data-key value for each item in a ListView control.
(in System.Web.Extensions.dll)
Visual Basic (Declaration)
<BrowsableAttribute(False)> _
Public Overridable ReadOnly Property DataKeys As DataKeyArray
Dim instance As ListView
Dim value As DataKeyArray
value = instance.DataKeys
[BrowsableAttribute(false)]
public virtual DataKeyArray DataKeys { get; }
[BrowsableAttribute(false)]
public:
virtual property DataKeyArray^ DataKeys {
DataKeyArray^ get ();
}
public function get DataKeys () : DataKeyArray
When the DataKeyNames property is set, the ListView control automatically creates a DataKey object for each item in the control. The DataKey object contains the values of the field or fields that are specified in the DataKeyNames property. The DataKey objects are then added to the control's DataKeys collection.
Use the DataKeys property to retrieve the DataKey object for a specific data item in the ListView control.
You can use the SelectedDataKey property to retrieve the DataKey object for the currently selected item. You can also use the SelectedValue property to retrieve the data-key value for the currently selected item directly.
The following example shows how to use the DataKeys property to determine the data-key values for the items in a ListView control. It also shows how to preserve the user selection based on a data item instead of the default behavior that uses the index.
Sub ContactsListView_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
If ContactsListView.SelectedIndex >= 0 Then
ViewState("SelectedKey") = ContactsListView.SelectedValue
Else
ViewState("SelectedKey") = Nothing
End If
End Sub
Sub ContactsListView_DataBound(ByVal sender As Object, ByVal e As EventArgs)
For i As Integer = 0 To ContactsListView.Items.Count - 1
' Ignore values that cannot be cast as integer.
Try
If Convert.ToInt32(ContactsListView.DataKeys(i).Value) = Convert.ToInt32(ViewState("SelectedKey")) Then _
ContactsListView.SelectedIndex = i
Catch
End Try
Next
End Sub
void ContactsListView_SelectedIndexChanged(Object sender, EventArgs e)
{
if (ContactsListView.SelectedIndex >= 0)
ViewState["SelectedKey"] = ContactsListView.SelectedValue;
else
ViewState["SelectedKey"] = null;
}
void ContactsListView_DataBound(Object sender, EventArgs e)
{
for (int i = 0; i < ContactsListView.Items.Count; i++)
{
// Ignore values that cannot be cast as integer.
try
{
if ((int)ContactsListView.DataKeys[i].Value == (int)ViewState["SelectedKey"])
ContactsListView.SelectedIndex = i;
}
catch { }
}
}
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5
Reference
Other Resources