DetailsViewUpdateEventArgs DetailsViewUpdateEventArgs DetailsViewUpdateEventArgs DetailsViewUpdateEventArgs Class

定義

ItemUpdating イベントのデータを提供します。Provides data for the ItemUpdating event.

public ref class DetailsViewUpdateEventArgs : System::ComponentModel::CancelEventArgs
public class DetailsViewUpdateEventArgs : System.ComponentModel.CancelEventArgs
type DetailsViewUpdateEventArgs = class
    inherit CancelEventArgs
Public Class DetailsViewUpdateEventArgs
Inherits CancelEventArgs
継承
DetailsViewUpdateEventArgsDetailsViewUpdateEventArgsDetailsViewUpdateEventArgsDetailsViewUpdateEventArgs

次のコード例は、使用する方法を示します、DetailsViewUpdateEventArgsオブジェクトのイベント ハンドラーに渡される、ItemUpdatingユーザーが入力した値を検証するイベントです。The following code example demonstrates how to use the DetailsViewUpdateEventArgs object passed to the event handler for the ItemUpdating event to validate the values entered by the user.


<%@ 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ときの Update ボタンにイベント (ボタンをそのCommandNameプロパティが「更新」に設定) コントロール内でをクリックする前に、DetailsViewコントロールは、レコードを更新します。The DetailsView control raises the ItemUpdating event when an Update button (a button with its CommandName property set to "Update") within the control is clicked, but before the DetailsView control updates the record. これにより、HTML エンコーディングなど、カスタムのルーチンを実行するイベント ハンドラーを提供するこのイベントが発生するたびに、データ ソースで更新する前に、レコードの値。This allows you to provide an event handler that performs a custom routine, such as HTML-encoding the values of a record before updating it in the data source, whenever this event occurs.

ADetailsViewUpdateEventArgsオブジェクトに送信される省略可能なコマンド引数の値を決定することができます、イベント ハンドラーに渡される、DetailsView制御し、を示すかどうか、更新操作をキャンセルするか。A DetailsViewUpdateEventArgs object is passed to the event handler, which allows you to determine the value of an optional command argument sent to the DetailsView control and to indicate whether the update operation should be canceled. コマンドの引数の値を調べるには、CommandArgumentプロパティ。To determine the value of the command argument, use the CommandArgument property. 更新操作をキャンセルするには、設定、Cancelプロパティをtrueします。To cancel the update operation, set the Cancel property to true. 読み取りまたはを使用して、ユーザーが入力した新しい値を変更することも、KeysNewValuesプロパティ。You can also read or modify the new values entered by the user by using the Keys and NewValues properties. Keysプロパティには、キーのフィールドが含まれています。 中に、NewValuesプロパティには、非キー フィールドが含まれています。The Keys property contains the key fields, while the NewValues property contains the non-key fields. 元のキー以外のフィールド値にアクセスする必要がある場合、OldValuesプロパティ。If you need to access the original non-key field values, use the OldValues property.

イベントを処理する方法の詳細については、次を参照してください。処理とイベントの発生します。For more information about how to handle events, see Handling and Raising Events.

DetailsViewUpdateEventArgs クラスのインスタンスの初期プロパティ値一覧については、DetailsViewUpdateEventArgs コンストラクターに関するトピックを参照してください。For a list of initial property values for an instance of the DetailsViewUpdateEventArgs class, see the DetailsViewUpdateEventArgs constructor.

コンストラクター

DetailsViewUpdateEventArgs(Object) DetailsViewUpdateEventArgs(Object) DetailsViewUpdateEventArgs(Object) DetailsViewUpdateEventArgs(Object)

DetailsViewUpdateEventArgs クラスの新しいインスタンスを初期化します。Initializes a new instance of the DetailsViewUpdateEventArgs class.

プロパティ

Cancel Cancel Cancel Cancel

イベントをキャンセルするかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the event should be canceled.

(Inherited from CancelEventArgs)
CommandArgument CommandArgument CommandArgument CommandArgument

DetailsView コントロールに渡される、更新処理のコマンド引数を取得します。Gets the command argument for the update operation passed to the DetailsView control.

Keys Keys Keys Keys

更新するレコードのキー フィールドの名前/値ペアを格納しているディクショナリを取得します。Gets a dictionary that contains the key field name/value pairs for the record to update.

NewValues NewValues NewValues NewValues

更新するレコードの新しいフィールドの名前と値のペアが格納されているディクショナリを取得します。Gets a dictionary that contains the new field name/value pairs for the record to update.

OldValues OldValues OldValues OldValues

更新するレコードの元のフィールドの名前/値ペアを格納しているディクショナリを取得します。Gets a dictionary that contains the original field name/value pairs for the record to update.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください