FreshBooksCommandBuilder Class

In This Topic

Automatically generates single-table commands used to reconcile changes made to a System.Data.DataSet with the FreshBooks.

Syntax

Visual Basic
C#

'Declaration
 
Public Class FreshBooksCommandBuilder 
   Inherits Devart.Data.SqlShimCommandBuilder
   Implements System.ComponentModel.IComponent, System.IDisposable

public class FreshBooksCommandBuilder : Devart.Data.SqlShimCommandBuilder, System.ComponentModel.IComponent, System.IDisposable

Remarks

The FreshBooksDataAdapter does not automatically generate the SQL statements required to reconcile changes made to a System.Data.DataSet associated with FreshBooks. However, you can create a FreshBooksCommandBuilder object that generates SQL statements for single-table updates. After assigning the FreshBooksDataAdapter to the FreshBooksCommandBuilder, it begins to generate any additional SQL statements that you do not set.

The relationship between a FreshBooksDataAdapter and its corresponding FreshBooksCommandBuilder is always one-to-one. To create this correspondence, you set the DataAdapter property of the FreshBooksCommandBuilder object. This causes the FreshBooksCommandBuilder to register itself as a listener, which produces the output of FreshBooksDataAdapter.RowUpdating events that affect the System.Data.DataSet.

To generate INSERT, UPDATE, or DELETE statements, the FreshBooksCommandBuilder uses the FreshBooksDataAdapter.SelectCommand property to retrieve a required set of metadata. If you change the value of FreshBooksDataAdapter.SelectCommand after the metadata has been retrieved (for example, after the first update), you then should call the Devart.Common.DbCommandBuilderBase.RefreshSchema method to update the metadata.

The FreshBooksCommandBuilder also uses the Connection, CommandTimeout, and System.Data.Common.DbCommand.Transaction properties referenced by the FreshBooksDataAdapter.SelectCommand. The user should call Devart.Common.DbCommandBuilderBase.RefreshSchema if any of these properties are modified, or value of the FreshBooksDataAdapter.SelectCommand property itself is changed. Otherwise the FreshBooksDataAdapter.InsertCommand, FreshBooksDataAdapter.UpdateCommand, and FreshBooksDataAdapter.DeleteCommand properties retain their previous values.

If you assign null to corresponding property of FreshBooksDataAdapter, the FreshBooksCommandBuilder will be disassociated from the FreshBooksDataAdapter, and the generated commands will no longer be used.

Note: This class is not available in .NET Standard 1.3 compatible assembly. It is available only in the assembly for full .NET Framework and .NET Standard 2.0 compatible assembly.

Example

The following example uses FreshBooksCommand, along with FreshBooksDataAdapter and FreshBooksConnection, to select rows from FreshBooks. The example is passed an initialized System.Data.DataSet, a connection string, a query string that is SQL SELECT statement, and a string that is the name of the FreshBooks table. The example then creates a FreshBooksCommandBuilder.

csharp

public DataSet SelectFreshBooksSrvRows(DataSet myDataSet,string freshbooksConnection,string mySelectQuery,string myTableName)
{
  FreshBooksConnection myConn = new FreshBooksConnection(freshbooksConnection);
  FreshBooksDataAdapter myDataAdapter = new FreshBooksDataAdapter();
  myDataAdapter.SelectCommand = new FreshBooksCommand(mySelectQuery, myConn);
  FreshBooksCommandBuilder freshbooksCommandBuilder = new FreshBooksCommandBuilder(myDataAdapter);

  myConn.Open();

  DataSet myDataSet = new DataSet();
  myDataAdapter.Fill(myDataSet, "Departments");

  //code to modify data in dataset here

  //Without the FreshBooksCommandBuilder this line would fail
  myDataAdapter.Update(myDataSet, "Departments");

  myConn.Close();

  return myDataSet;
}

Visual Basic

Public Function SelectFreshBooksSrvRows(myDataSet As DataSet, freshbooksConnection As String, mySelectQuery As String, myTableName As String) As DataSet
  Dim myConn As New FreshBooksConnection(freshbooksConnection)
  Dim myDataAdapter As New FreshBooksDataAdapter()
  myDataAdapter.SelectCommand = New FreshBooksCommand(mySelectQuery, myConn)
  Dim freshbooksCommandBuilder As FreshBooksCommandBuilder = New FreshBooksCommandBuilder(myDataAdapter)

  myConn.Open()

  Dim myDataSet As DataSet = New DataSet
  myDataAdapter.Fill(myDataSet, "Departments")

  ' Code to modify data in DataSet here

  ' Without the FreshBooksCommandBuilder this line would fail.
  myDataAdapter.Update(myDataSet, "Departments")

  myConn.Close()

  SelectFreshBooksSrvRows = myDataSet
End Function

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Data.Common.DbCommandBuilder
            Devart.Common.DbCommandBuilderBase
               Devart.Common.DbCommandBuilder
                  Devart.Data.SqlShimCommandBuilder
                     Devart.Data.FreshBooks.FreshBooksCommandBuilder

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

FreshBooksCommandBuilder Members
Devart.Data.FreshBooks Namespace
FreshBooksDataAdapter Class
FreshBooksConnection Class
FreshBooksCommand Class

Send Feedback