ZohoBooksCommandBuilder Class

In This Topic

Syntax
Remarks
Example
Inheritance Hierarchy
Requirements
See Also

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

Syntax

Visual Basic
C#

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

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

Remarks

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

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

To generate INSERT, UPDATE, or DELETE statements, the ZohoBooksCommandBuilder uses the ZohoBooksDataAdapter.SelectCommand property to retrieve a required set of metadata. If you change the value of ZohoBooksDataAdapter.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 ZohoBooksCommandBuilder also uses the Connection, CommandTimeout, and System.Data.Common.DbCommand.Transaction properties referenced by the ZohoBooksDataAdapter.SelectCommand. The user should call Devart.Common.DbCommandBuilderBase.RefreshSchema if any of these properties are modified, or value of the ZohoBooksDataAdapter.SelectCommand property itself is changed. Otherwise the ZohoBooksDataAdapter.InsertCommand, ZohoBooksDataAdapter.UpdateCommand, and ZohoBooksDataAdapter.DeleteCommand properties retain their previous values.

If you assign null to corresponding property of ZohoBooksDataAdapter, the ZohoBooksCommandBuilder will be disassociated from the ZohoBooksDataAdapter, 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 ZohoBooksCommand, along with ZohoBooksDataAdapter and ZohoBooksConnection, to select rows from Zoho Books. 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 Zoho Books table. The example then creates a ZohoBooksCommandBuilder.

csharp

public DataSet SelectZohoBooksSrvRows(DataSet myDataSet,string ZohoBooksConnection,string mySelectQuery,string myTableName)
{
  ZohoBooksConnection myConn = new ZohoBooksConnection(ZohoBooksConnection);
  ZohoBooksDataAdapter myDataAdapter = new ZohoBooksDataAdapter();
  myDataAdapter.SelectCommand = new ZohoBooksCommand(mySelectQuery, myConn);
  ZohoBooksCommandBuilder ZohoBooksCommandBuilder = new ZohoBooksCommandBuilder(myDataAdapter);

  myConn.Open();

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

  //code to modify data in dataset here

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

  myConn.Close();

  return myDataSet;
}

Visual Basic

Public Function SelectZohoBooksSrvRows(myDataSet As DataSet, ZohoBooksConnection As String, mySelectQuery As String, myTableName As String) As DataSet
  Dim myConn As New ZohoBooksConnection(ZohoBooksConnection)
  Dim myDataAdapter As New ZohoBooksDataAdapter()
  myDataAdapter.SelectCommand = New ZohoBooksCommand(mySelectQuery, myConn)
  Dim ZohoBooksCommandBuilder As ZohoBooksCommandBuilder = New ZohoBooksCommandBuilder(myDataAdapter)

  myConn.Open()

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

  ' Code to modify data in DataSet here

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

  myConn.Close()

  SelectZohoBooksSrvRows = 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.ZohoBooks.ZohoBooksCommandBuilder

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

ZohoBooksCommandBuilder Members
Devart.Data.ZohoBooks Namespace
ZohoBooksDataAdapter Class
ZohoBooksCommand Class

Send Feedback