Open topic with navigation

Database.SQLStatement Property

ClosedDescription

Sets and returns the custom SQL statement.

ClosedSyntax

Database.SQLStatement = Statement

Where Statement is a string containing the custom SQL statement.

ClosedRequirements

Version

BarTender 2016 or higher

Edition

Automation, Enterprise

ClosedRemarks

The Database.SQLStatement property sets and returns a custom SQL statement for record selection within the database. The property applies to all database types.

The SQL statement will be applied with data browsing or at print time to perform record filtering. Setting the Database.SQLStatement property will imply the use of a custom SQL statement and any options within the database itself for tables, queries, joins, and sorts will be ignored.

The Database.SQLStatement property is read-only when used with a text file or SAP IDoc database.

ClosedVB.NET Example

'Declare a BarTender application variable

Dim btApp As BarTender.Application

'Declare a BarTender document variable

Dim btFormat As New 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.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.SQLStatement = "SELECT * FROM 'Customers' WHERE 'Name'='Frank Wild'";

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);

Related Topics