DetailsViewUpdateEventArgs Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет данные о событии ItemUpdating.
public ref class DetailsViewUpdateEventArgs : System::ComponentModel::CancelEventArgs
public class DetailsViewUpdateEventArgs : System.ComponentModel.CancelEventArgs
type DetailsViewUpdateEventArgs = class
inherit CancelEventArgs
Public Class DetailsViewUpdateEventArgs
Inherits CancelEventArgs
- Наследование
Примеры
В следующем примере кода показано, как использовать объект, переданный DetailsViewUpdateEventArgs обработчику событий для события, ItemUpdating чтобы проверить значения, введенные пользователем.
<%@ 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 CustomerDetailsView_ItemUpdating(Object sender,
DetailsViewUpdateEventArgs e)
{
// Validate the field values entered by the user. This
// example determines whether the user left any fields
// empty. Use the NewValues property to access the new
// values entered by the user.
ArrayList emptyFieldList =
ValidateFields((IOrderedDictionary)e.NewValues);
if (emptyFieldList.Count > 0)
{
// The user left some fields empty.
// Display an error message.
// Use the Keys property to retrieve the key field value.
String keyValue = e.Keys["CustomerID"].ToString();
MessageLabel.Text =
"You must enter a value for all fields of record " +
keyValue + ".<br/>The following fields are missing:<br/><br/>";
// Display the missing fields.
foreach (String value in emptyFieldList)
{
// Use the OldValues property access the original
// value of a field.
MessageLabel.Text += value + " - Original Value = " +
e.OldValues[value].ToString() + "<br />";
}
// Cancel the update operation.
e.Cancel = true;
}
else
{
// The field values passed validation. Clear the
// error message label.
MessageLabel.Text = "";
}
}
ArrayList ValidateFields(IOrderedDictionary list)
{
// Create an ArrayList object to store the
// names of any empty fields.
ArrayList emptyFieldList = new ArrayList();
// Iterate though the field values entered by
// the user and check for an empty field. Empty
// fields contain a null value.
foreach (DictionaryEntry entry in list)
{
if (entry.Value == null)
{
// Add the field name to the ArrayList object.
emptyFieldList.Add(entry.Key.ToString());
}
}
return emptyFieldList;
}
void CustomerDetailsView_ModeChanging(Object sender,
DetailsViewModeEventArgs e)
{
if (e.CancelingEdit)
{
// The user canceled the update operation.
// Clear the error message label.
MessageLabel.Text = "";
}
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>DetailsViewUpdateEventArgs Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>DetailsViewUpdateEventArgs Example</h3>
<asp:detailsview id="CustomerDetailsView"
datasourceid="DetailsViewSource"
autogeneraterows="true"
autogenerateeditbutton="true"
allowpaging="true"
datakeynames="CustomerID"
onitemupdating="CustomerDetailsView_ItemUpdating"
onmodechanging="CustomerDetailsView_ModeChanging"
runat="server">
<pagersettings position="Bottom"/>
</asp:detailsview>
<br/>
<asp:label id="MessageLabel"
forecolor="Red"
runat="server"/>
<!-- 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"
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"
connectionstring=
"<%$ ConnectionStrings:NorthWindConnectionString%>"
runat="server"/>
</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 CustomerDetailsView_ItemUpdating(ByVal sender As Object, _
ByVal e As DetailsViewUpdateEventArgs)
' Validate the field values entered by the user. This
' example determines whether the user left any fields
' empty. Use the NewValues property to access the new
' values entered by the user.
Dim emptyFieldList As ArrayList = _
ValidateFields(CType(e.NewValues, IOrderedDictionary))
If emptyFieldList.Count > 0 Then
' The user left some fields empty. Display an error message.
' Use the Keys property to retrieve the key field value.
Dim keyValue As String = e.Keys("CustomerID").ToString()
MessageLabel.Text = _
"You must enter a value for all fields of record " & _
keyValue & ".<br/>The following fields are missing:<br/><br/>"
' Display the missing fields.
Dim value As String
For Each value In emptyFieldList
' Use the OldValues property access the original value
' of a field.
MessageLabel.Text &= value & " - Original Value = " & _
e.OldValues(value).ToString() & "<br />"
Next
' Cancel the update operation.
e.Cancel = True
Else
' The field values passed validation. Clear the
' error message label.
MessageLabel.Text = ""
End If
End Sub
Function ValidateFields(ByVal list As IOrderedDictionary) _
As ArrayList
' Create an ArrayList object to store the
' names of any empty fields.
Dim emptyFieldList As New ArrayList()
' Iterate though the field values entered by
' the user and check for an empty field. Empty
' fields contain a null value.
Dim entry As DictionaryEntry
For Each entry In list
If entry.Value Is Nothing Then
' Add the field name to the ArrayList object.
emptyFieldList.Add(entry.Key.ToString())
End If
Next
Return emptyFieldList
End Function
Sub CustomerDetailsView_ModeChanging(ByVal sender As Object, ByVal e As DetailsViewModeEventArgs)
If e.CancelingEdit Then
' The user canceled the update operation.
' Clear the error message label.
MessageLabel.Text = ""
End If
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>DetailsViewUpdateEventArgs Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>DetailsViewUpdateEventArgs Example</h3>
<asp:detailsview id="CustomerDetailsView"
datasourceid="DetailsViewSource"
autogeneraterows="true"
autogenerateeditbutton="true"
allowpaging="true"
datakeynames="CustomerID"
onitemupdating="CustomerDetailsView_ItemUpdating"
onmodechanging="CustomerDetailsView_ModeChanging"
runat="server">
<pagersettings position="Bottom"/>
</asp:detailsview>
<br/>
<asp:label id="MessageLabel"
forecolor="Red"
runat="server"/>
<!-- 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"
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"
connectionstring=
"<%$ ConnectionStrings:NorthWindConnectionString%>"
runat="server"/>
</form>
</body>
</html>
Комментарии
Элемент DetailsView управления вызывает ItemUpdating событие при нажатии кнопки "Обновить" (кнопка с его CommandName свойством "Обновить") в элементе управления, но перед DetailsView обновлением записи элементом управления. Это позволяет предоставить обработчик событий, выполняющий пользовательскую подпрограмму, например html-кодирование значений записи перед обновлением в источнике данных, при каждом возникновении этого события.
DetailsViewUpdateEventArgs Объект передается обработчику событий, который позволяет определить значение необязательного аргумента команды, отправленного DetailsView элементу управления, и указать, следует ли отменить операцию обновления. Чтобы определить значение аргумента команды, используйте CommandArgument свойство. Чтобы отменить операцию обновления, задайте Cancel для свойства значение true. Вы также можете считывать или изменять новые значения, введенные пользователем, с помощью Keys свойств и NewValues свойств. Свойство Keys содержит ключевые поля, а NewValues свойство содержит поля, отличные от ключей. Если вам нужно получить доступ к исходным значениям полей, не являющихся ключами OldValues , используйте это свойство.
Дополнительные сведения об обработке событий см. в разделе "Обработка и создание событий".
Список начальных значений свойств для экземпляра DetailsViewUpdateEventArgs класса см. в конструкторе DetailsViewUpdateEventArgs .
Конструкторы
| Имя | Описание |
|---|---|
| DetailsViewUpdateEventArgs(Object) |
Инициализирует новый экземпляр класса DetailsViewUpdateEventArgs. |
Свойства
| Имя | Описание |
|---|---|
| Cancel |
Возвращает или задает значение, указывающее, следует ли отменить событие. (Унаследовано от CancelEventArgs) |
| CommandArgument |
Возвращает аргумент команды для операции обновления, переданной элементу DetailsView управления. |
| Keys |
Возвращает словарь, содержащий пары "имя и значение" ключевого поля для обновляемой записи. |
| NewValues |
Возвращает словарь, содержащий новые пары имени поля и значения для обновляемой записи. |
| OldValues |
Возвращает словарь, содержащий исходные пары имени поля и значения для обновляемой записи. |
Методы
| Имя | Описание |
|---|---|
| Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
| GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |