CommandType Property (FreshBooksCommand)

In This Topic

Gets or sets a value indicating how the CommandText property is to be interpreted.

Syntax

Visual Basic
C#

'Declaration
 
Public Overrides Property CommandType As CommandType

public override CommandType CommandType {get; set;}

Property Value

One of the System.Data.CommandType values. The default value is System.Data.CommandType.Text.

Remarks

CommandType can be one of the following values: Text, StoredProcedure, TableDirect.

When the value is CommandType.Text, the property CommandText should contain text of a query that must be run on the server.

When the value is CommandType.StoredProcedure, CommandText property must be a name of a procedure to execute.

When the value is set to TableDirect, CommandText must be name of a table you want to get all data from. All rows and columns are retrieved.

Example

The following example creates an instance of a derived class FreshBooksCommand and sets some of its properties.

csharp

public void CreateCommand()
{
  FreshBooksCommand freshbooksCommand = new FreshBooksCommand();
  freshbooksCommand.CommandText = "SELECT * FROM Client ORDER BY Id";
  freshbooksCommand.CommandType = CommandType.Text;
}

Visual Basic

Public Sub CreateCommand()
  Dim freshbooksCommand As New FreshBooksCommand()
  freshbooksCommand.CommandText = "SELECT * FROM Client ORDER BY Id"
  freshbooksCommand.CommandType = CommandType.Text
End Sub

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

FreshBooksCommand Class
FreshBooksCommand Members
CommandText Property

Send Feedback