Open topic with navigation

ODBC.SQLStatement Property

BarTender 2016 introduced new functionality to the Database object that eliminates the need for a separate ODBC object. Although the ODBC object is still supported in BarTender 2016, we recommend that you use the new properties of the Database object instead. It is possible that the ODBC object will be deprecated in a future BarTender version.

ClosedDescription

Sets and returns the custom SQL statement.

ClosedSyntax

ODBC.SQLStatement = Statement

Where Statement is a string that contains the custom SQL statement.

ClosedRequirements

Version

BarTender 6.00 or higher

Edition

Automation, Enterprise Automation

ClosedRemarks

The ODBC.SQLStatement property sets and returns a custom SQL statement for record selection within an ODBC database. The SQL statement is applied at data browsing or print-time to perform record filtering. Setting the ODBC.SQLStatement property implies the use of a custom SQL statement, and the options found in the Tables, Query, Join, and Sort tabs of an ODBC database will be ignored.

ClosedVB.NET Example

'Declare a BarTender application variable

Dim btApp As BarTender.Application

'Declare a BarTender document variable

Dim btFormat As BarTender.Format

'Declare BarTender database variable

Dim btDb As BarTender.Database

'Create a new instance of BarTender

btApp = New BarTender.Application

'Set the BarTender application visible

btApp.Visible = True

'Open a BarTender document

btFormat = btApp.Formats.Open("c:\Format1.btw", False, "")

'Select the database

btDb = btFormat.Databases.GetDatabase(1)

'Set the SQL statement

btDb.ODBC.SQLStatement = "SELECT * FROM 'Customers' WHERE 'Name'='Frank Wild'"

'End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges)

ClosedC# Example

// Declare a BarTender application variable

BarTender.Application btApp;

// Declare a BarTender document variable

BarTender.Format btFormat;

// Declare a BarTender database variable

BarTender.Database btDb;

// Create a new instance of BarTender

btApp = new BarTender.Application();

// Set the BarTender application visible

btApp.Visible = true;

// Open a BarTender document

btFormat = btApp.Formats.Open("c:\\Format1.btw", false, "");

// Select the database

btDb = btFormat.Databases.GetDatabase(1);

// Set the SQL statement

btDb.ODBC.SQLStatement = "SELECT * FROM 'Customers' WHERE 'Name'='Frank Wild'";

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);

Related Topics