ObjectDataSource.InsertMethod Propriété

Définition

Obtient ou définit le nom de la méthode ou de la fonction que le contrôle ObjectDataSource appelle pour insérer des données.

public string InsertMethod { get; set; }

Valeur de propriété

Chaîne qui représente le nom de la méthode ou de la fonction que ObjectDataSource utilise pour insérer des données. La valeur par défaut est une chaîne vide ("").

Exemples

Cette section contient deux exemples de code. Le premier exemple de code montre comment utiliser un ObjectDataSource objet avec un objet métier et un DetailsView contrôle pour insérer des données. Le deuxième exemple de code fournit un exemple de l’objet métier de niveau intermédiaire utilisé dans le premier exemple de code.

L’exemple de code suivant montre comment utiliser un ObjectDataSource contrôle avec un objet métier et un DetailsView contrôle pour insérer des données. Initialement, le DetailsView affiche un nouvel NorthwindEmployee enregistrement, ainsi qu’un bouton Insérer généré automatiquement. Après avoir entré des données dans les champs du DetailsView contrôle, cliquez sur le bouton Insérer . La InsertMethod propriété identifie la méthode qui effectue l’opération d’insertion.

Dans cet exemple, la UpdateEmployeeInfo méthode est utilisée pour effectuer une insertion ; toutefois, elle nécessite un NorthwindEmployee paramètre pour insérer les données. Pour cette raison, la collection de chaînes que le DetailsView contrôle transmet automatiquement n’est pas suffisante. Le NorthwindEmployeeInserting délégué est un ObjectDataSourceMethodEventHandler objet qui gère l’événement Inserting et vous permet de manipuler les paramètres d’entrée avant que l’opération Insert ne continue. Étant donné que la UpdateEmployeeInfo méthode nécessite un NorthwindEmployee objet en tant que paramètre, une méthode est créée à l’aide de la collection de chaînes et est ajoutée à la collection à l’aide InputParameters d’un nom de paramètre (ne) attendu par la méthode. Vous pouvez effectuer des étapes comme celles-ci lorsque vous utilisez un objet de niveau intermédiaire existant en tant que source de données avec des types et des méthodes qui ne sont pas conçus spécifiquement pour une utilisation avec le ObjectDataSource contrôle.

Lorsque l’opération Insert est effectuée, la méthode identifiée par la InsertMethod propriété est appelée. Si la Insert méthode de l’objet a une signature de méthode qui inclut des paramètres, la InsertParameters collection doit contenir un paramètre avec des noms qui correspondent aux paramètres de signature de méthode pour que la Insert méthode se termine correctement.

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS" Assembly="Samples.AspNet.CS" %>
<%@ Import namespace="Samples.AspNet.CS" %>
<%@ 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">
private void NorthwindEmployeeInserting(object source, ObjectDataSourceMethodEventArgs e)
{
  // The business object expects a custom type. Build it
  // and add it to the parameters collection.
  
  IDictionary paramsFromPage = e.InputParameters;

  NorthwindEmployee ne = new NorthwindEmployee();

  ne.FirstName  = paramsFromPage["FirstName"].ToString();
  ne.LastName   = paramsFromPage["LastName"].ToString();
  ne.Title      = paramsFromPage["Title"].ToString();
  ne.Courtesy   = paramsFromPage["Courtesy"].ToString();
  ne.Supervisor = Int32.Parse(paramsFromPage["Supervisor"].ToString());

  paramsFromPage.Clear();
  paramsFromPage.Add("ne", ne);
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ObjectDataSource - C# Example</title>
  </head>
  <body>
    <form id="Form1" method="post" runat="server">

        <asp:detailsview
          id="DetailsView1"
          runat="server"
          autogenerateinsertbutton="True"
          datasourceid="ObjectDataSource1">
        </asp:detailsview>

        <asp:objectdatasource
          id="ObjectDataSource1"
          runat="server"
          selectmethod="GetEmployee"
          insertmethod="UpdateEmployeeInfo"
          oninserting="NorthwindEmployeeInserting"
          typename="Samples.AspNet.CS.EmployeeLogic"
          >
          <selectparameters>
            <asp:parameter name="anID" defaultvalue="-1" />
          </selectparameters>
        </asp:objectdatasource>

    </form>
  </body>
</html>

L’exemple de code suivant fournit un exemple d’objet métier de niveau intermédiaire que l’exemple de code précédent utilise. L’exemple de code se compose de deux classes de base :

  • Classe EmployeeLogic , qui est une classe sans état qui encapsule la logique métier.

  • La NorthwindEmployee classe , qui est une classe de modèle qui contient uniquement les fonctionnalités de base requises pour charger et conserver des données à partir de la couche Données.

Une classe supplémentaire NorthwindDataException est fournie pour des raisons pratiques. Pour obtenir un exemple opérationnel complet, vous devez compiler et utiliser ces classes. La UpdateEmployeeInfo méthode n’étant pas complètement implémentée, vous n’insérerez pas de données dans la base de données Northwind Traders lorsque vous expérimenterez cet exemple.

namespace Samples.AspNet.CS {

using System;
using System.Collections;
using System.Configuration;
using System.Data;
using System.Data.SqlClient;
using System.Web.UI;
using System.Web.UI.WebControls;
  //
  // EmployeeLogic is a stateless business object that encapsulates
  // the operations you can perform on a NorthwindEmployee object.
  //
  public class EmployeeLogic {

    // Returns a collection of NorthwindEmployee objects.
    public static ICollection GetAllEmployees () {
      ArrayList al = new ArrayList();

      ConnectionStringSettings cts = ConfigurationManager.ConnectionStrings["NorthwindConnection"];

      SqlDataSource sds
        = new SqlDataSource(cts.ConnectionString,
                            "SELECT EmployeeID FROM Employees");
      try {
        IEnumerable IDs = sds.Select(DataSourceSelectArguments.Empty);

        // Iterate through the Enumeration and create a
        // NorthwindEmployee object for each ID.
        IEnumerator enumerator = IDs.GetEnumerator();
        while (enumerator.MoveNext()) {
          // The IEnumerable contains DataRowView objects.
          DataRowView row = enumerator.Current as DataRowView;
          string id = row["EmployeeID"].ToString();
          NorthwindEmployee nwe = new NorthwindEmployee(id);
          // Add the NorthwindEmployee object to the collection.
          al.Add(nwe);
        }
      }
      finally {
        // If anything strange happens, clean up.
        sds.Dispose();
      }

      return al;
    }

    public static NorthwindEmployee GetEmployee(object anID) {
      if (anID.Equals("-1") ||
          anID.Equals(DBNull.Value) ) {
        return new NorthwindEmployee();
      }
      else {
        return new NorthwindEmployee(anID);
      }
    }

    public static void UpdateEmployeeInfo(NorthwindEmployee ne) {
      bool retval = ne.Save();
      if (!retval) { throw new NorthwindDataException("UpdateEmployee failed."); }
    }

    public static void DeleteEmployee(NorthwindEmployee ne) {
      bool retval = ne.Delete();
      if (!retval) { throw new NorthwindDataException("DeleteEmployee failed."); }
    }

    // And so on...
  }

  public class NorthwindEmployee {

    public NorthwindEmployee () {
      ID = DBNull.Value;
      lastName = "";
      firstName = "";
      title="";
      titleOfCourtesy = "";
      reportsTo = -1;
    }

    public NorthwindEmployee (object anID) {
      this.ID = anID;

      SqlConnection conn
        = new SqlConnection (ConfigurationManager.ConnectionStrings["NorthwindConnection"].ConnectionString);
      SqlCommand sc =
        new SqlCommand(" SELECT FirstName,LastName,Title,TitleOfCourtesy,ReportsTo " +
                       " FROM Employees " +
                       " WHERE EmployeeID = @empId",
                       conn);
      // Add the employee ID parameter and set its value.
      sc.Parameters.Add(new SqlParameter("@empId",SqlDbType.Int)).Value = Int32.Parse(anID.ToString());
      SqlDataReader sdr = null;

      try {
        conn.Open();
        sdr = sc.ExecuteReader();

        // Only loop once.
        if (sdr != null && sdr.Read()) {
          // The IEnumerable contains DataRowView objects.
          this.firstName        = sdr["FirstName"].ToString();
          this.lastName         = sdr["LastName"].ToString();
          this.title            = sdr["Title"].ToString();
          this.titleOfCourtesy  = sdr["TitleOfCourtesy"].ToString();
          if (!sdr.IsDBNull(4)) {
            this.reportsTo        = sdr.GetInt32(4);
          }
        }
        else {
          throw new NorthwindDataException("Data not loaded for employee id.");
        }
      }
      finally {
        try {
          if (sdr != null) sdr.Close();
          conn.Close();
        }
        catch (SqlException) {
          // Log an event in the Application Event Log.
          throw;
        }
      }
    }

    private object ID;
    public string EmpID {
      get { return ID.ToString();  }
    }

    private string lastName;
    public string LastName {
      get { return lastName; }
      set { lastName = value; }
    }

    private string firstName;
    public string FirstName {
      get { return firstName; }
      set { firstName = value;  }
    }

    public string FullName {
      get { return FirstName + " " + LastName; }
    }

    private string title;
    public String Title {
      get { return title; }
      set { title = value; }
    }

    private string titleOfCourtesy;
    public string Courtesy {
      get { return titleOfCourtesy; }
      set { titleOfCourtesy = value; }
    }

    private int    reportsTo;
    public int Supervisor {
      get { return reportsTo; }
      set { reportsTo = value; }
    }

    public bool Save () {
      // Implement persistence logic.
      return true;
    }

    public bool Delete () {
      // Implement delete logic.
      return true;
    }
  }

  internal class NorthwindDataException: Exception {
    public NorthwindDataException(string msg) : base (msg) { }
  }
}

Remarques

L’objet métier est supposé insérer des données un enregistrement à la fois, plutôt que dans un lot.

La InsertMethod propriété délègue à la InsertMethod propriété de l’objet ObjectDataSourceView associé à l’objet ObjectDataSource .

Durée de vie des objets

La méthode identifiée par la InsertMethod propriété peut être une méthode d’instance ou une static méthode (Shared en Visual Basic). S’il s’agit d’une méthode d’instance, l’objet métier est créé et détruit chaque fois que la méthode spécifiée par la InsertMethod propriété est appelée. Vous pouvez gérer les ObjectCreated événements et ObjectCreating pour travailler avec l’objet métier avant l’appel de la InsertMethod propriété. Vous pouvez également gérer l’événement ObjectDisposing déclenché après l’appel de la méthode spécifiée par la DeleteMethod propriété . Si l’objet métier implémente l’interface IDisposable , la Dispose méthode est appelée avant la destruction de l’objet. Si la méthode est static (Shared en Visual Basic), l’objet métier n’est jamais créé et vous ne pouvez pas gérer les ObjectCreatedévénements , ObjectCreatinget ObjectDisposing .

Fusion de paramètres

Les paramètres sont ajoutés à la InsertParameters collection à partir de trois sources :

  • À partir du contrôle lié aux données, au moment de l’exécution.

  • À partir de l’élément InsertParameters , de façon déclarative.

  • À partir de la Inserting méthode , par programmation.

Tout d’abord, tous les paramètres générés à partir de contrôles liés aux données sont ajoutés à la InsertParameters collection. Par exemple, si le ObjectDataSource contrôle est lié à un GridView contrôle qui a les colonnes Name et Number, les paramètres pour Name et Number sont ajoutés à la collection. Le type de données de ces paramètres est string. Ensuite, les paramètres répertoriés dans l’élément InsertParameters sont ajoutés. Si un paramètre dans l’élément InsertParameters est trouvé avec le même nom qu’un paramètre qui se trouve déjà dans la InsertParameters collection, le paramètre existant est modifié pour correspondre au paramètre spécifié dans l’élément InsertParameters . En règle générale, il est utilisé pour modifier le type des données dans le paramètre . Enfin, vous pouvez ajouter et supprimer par programmation des paramètres dans l’événement Inserting , ce qui se produit avant l’exécution de la Insert méthode. La méthode est résolue après la fusion des paramètres. La résolution de méthode est abordée dans la section suivante.

Important

Vous devez valider toute valeur de paramètre que vous recevez du client. Le runtime remplace simplement la valeur du paramètre dans la InsertMethod propriété .

Résolution de méthode

Lorsque la Insert méthode est appelée, les champs de données du contrôle lié aux données, les paramètres créés de manière déclarative dans l’élément InsertParameters et les paramètres ajoutés dans le Inserting gestionnaire d’événements sont tous fusionnés. (Pour plus d’informations, consultez la section précédente.) L’objet ObjectDataSource tente ensuite de trouver une méthode à appeler. Tout d’abord, il recherche une ou plusieurs méthodes portant le nom spécifié dans la InsertMethod propriété . Si aucune correspondance n’est trouvée, une InvalidOperationException exception est levée. Si une correspondance est trouvée, il recherche ensuite les noms de paramètres correspondants. Par exemple, supposons qu’un type spécifié par la TypeName propriété possède deux méthodes nommées InsertARecord. L’un InsertARecord a un paramètre, ID, et l’autre InsertARecord a deux paramètres, Name et Number. Si la InsertParameters collection n’a qu’un seul paramètre nommé ID, la InsertARecord méthode avec uniquement le ID paramètre est appelée. Le type du paramètre n’est pas archivé pour résoudre les méthodes. L’ordre des paramètres n’a pas d’importance.

Si la DataObjectTypeName propriété est définie, la méthode est résolue d’une autre manière. Recherche ObjectDataSource une méthode avec le nom spécifié dans la InsertMethod propriété qui prend un paramètre du type spécifié dans la DataObjectTypeName propriété . Dans ce cas, le nom du paramètre n’a pas d’importance.

S’applique à

Produit Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Voir aussi