KeyFields Property (FreshBooksCommandBuilder)

In This Topic

Gets or sets string containing list of key field names separated by semicolon. They are used to generate update commands.

Syntax

Visual Basic
C#

'Declaration
 
Public Shadows Property KeyFields As String

public new string KeyFields {get; set;}

Property Value

The string containing list of key field names separated by semicolon.

Remarks

This property is used when the ConflictOption property is set to OverwriteChanges, otherwise all columns will be used in the WHERE clause.

If KeyFields is nonempty, its value is used as the list of columns for the WHERE clause. If KeyFields is empty, the primary key columns are used.

Example

The following example demonstrates how UPDATE and DELETE statements are generated.

csharp

public void UseKeyFields(string connectionString) {

        FreshBooksConnection conn = new FreshBooksConnection(connectionString);
        conn.Open();

        FreshBooksDataAdapter adapter = new FreshBooksDataAdapter("SELECT * FROM Client", conn);
        FreshBooksCommandBuilder commBuilder = new FreshBooksCommandBuilder(adapter);

        commBuilder.ConflictOption = ConflictOption.OverwriteChanges;

        commBuilder.KeyFields = "Id, LastName";

        string updateComm = commBuilder.GetUpdateCommand().CommandText;
        string deleteComm = commBuilder.GetDeleteCommand().CommandText;

        Console.WriteLine(updateComm);
        Console.WriteLine(deleteComm);
        conn.Close();
}

Visual Basic

Public Sub UseKeyFields(ByVal connectionString As String)
        Dim conn As FreshBooksConnection = New FreshBooksConnection(connectionString)
        conn.Open()

        Dim adapter As FreshBooksDataAdapter = New FreshBooksDataAdapter("SELECT * FROM Client", conn)
        Dim commBuilder As FreshBooksCommandBuilder = New FreshBooksCommandBuilder(adapter)

        commBuilder.ConflictOption = ConflictOption.OverwriteChanges

        commBuilder.KeyFields = "Id, LastName"

        Dim updateComm As String = commBuilder.GetUpdateCommand().CommandText
        Dim deleteComm As String = commBuilder.GetDeleteCommand().CommandText

        Console.WriteLine(updateComm)
        Console.WriteLine(deleteComm)
        conn.Close()
End Sub

Reference

FreshBooksCommandBuilder Class
FreshBooksCommandBuilder Members

Send Feedback