How to: Add a Deleter Method

Article
02/04/2013

You can enable an end user to delete a data record from an external list on a SharePoint site by adding a Deleter method to the model. For more information, see Designing a Business Data Connectivity Model.

To create a Deleter method

On the BDC designer, select an entity.
On the View menu, click Other Windows, and then click BDC Method Details.

The BDC Method Details window opens. For more information about the BDC Method Details window, see BDC Model Design Tools Overview.
In the BDC Method Details window, from the Add a Method drop-down list, select Create a Deleter Method.

Visual Studio adds the following elements to the model. These elements appear in the BDC Method Details window.
- A method named Delete.
- An input parameter for the method.
- A type descriptor for the parameter.
- A method instance for the method.
For more information, see Designing a Business Data Connectivity Model.
In Solution Explorer, right-click the service code file that was generated for the entity, and then click View Code.

The entity service code file opens in the Code Editor. For more information about the entity service code file, see Creating a Business Data Connectivity Model.

Add code to the Deleter method to delete a record. The following example deletes a line item from a sales order by using the AdventureWorks sample database for SQL Server.

Note

The method in this example uses two input parameters.

Note

Replace the value of the ServerName field with the name of your server.

Public Shared Sub Delete(ByVal salesOrderID As Integer, ByVal salesOrderDetailID As Integer)
    Const ServerName As String = "MySQLServerName"
    Dim dataContext As AdventureWorksDataContext = _
        New AdventureWorksDataContext("Data Source=" & ServerName & _
            ";Initial Catalog=AdventureWorks;Integrated Security=True")

    Dim SalesOrderDetail As SalesOrderDetail = _
        (From SalesOrderDetails In dataContext.SalesOrderDetails.AsEnumerable().Take(20) _
        Where SalesOrderDetails.SalesOrderID = salesOrderID And _
              SalesOrderDetails.SalesOrderDetailID = salesOrderDetailID _
        Select SalesOrderDetails).Single()

    dataContext.SalesOrderDetails.DeleteOnSubmit(SalesOrderDetail)
    dataContext.SubmitChanges()

End Sub

public static void Delete(int salesOrderID, int salesOrderDetailID)
{
    const string ServerName = "MySQLServerName";
    AdventureWorksDataContext dataContext = new AdventureWorksDataContext
          ("Data Source=" + ServerName + ";" +
           "Initial Catalog=AdventureWorks;Integrated Security=True");

    SalesOrderDetail SalesOrderDetail =
           (from SalesOrderDetails in dataContext.SalesOrderDetails.AsEnumerable().Take(20)
            where SalesOrderDetails.SalesOrderID == salesOrderID &&
            SalesOrderDetails.SalesOrderDetailID == salesOrderDetailID
            select SalesOrderDetails).Single();

    dataContext.SalesOrderDetails.DeleteOnSubmit(SalesOrderDetail);
    dataContext.SubmitChanges();
}

Share via

How to: Add a Deleter Method

To create a Deleter method

See Also

Tasks

Concepts

Other Resources

Additional resources