QueryPrompts.GetQueryPrompt Method

ClosedDescription

Returns a reference to a specified QueryPrompt object.

ClosedSyntax

QueryPrompts.GetQueryPrompt(Index)

Where Index can be either an integer or a string specifying the query prompt name.

ClosedRequirements

Version

BarTender 7.50 or higher

Edition

Automation, Enterprise

ClosedRemarks

Use the QueryPrompts.GetQueryPrompt method to access a specific query prompt that is setup on a BarTender document. Index can be either an integer value or a string index specifying the query prompt name.

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 query prompt variable

Dim btQueryPrompt As BarTender.QueryPrompt

'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 query prompt

btQueryPrompt = btFormat.Databases.QueryPrompts.GetQueryPrompt(1)

'Alternatively, use the query prompt's Name if it is known

'btQueryPrompt = btFormat.Databases.QueryPrompts.GetQueryPrompt("Today's Date")

'Show the query prompt's name

MessageBox.Show(btQueryPrompt.Name)

'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 query prompt variable

BarTender.QueryPrompt btQueryPrompt;

// 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 query prompt

btQueryPrompt = btFormat.Databases.QueryPrompts.GetQueryPrompt(1);

// Alternatively, use the query prompt's name if it is known

// bQueryPrompt = btFormat.Databases.QueryPrompts.GetQueryPrompt("Today's Date");

// Show the query prompt's name

MessageBox.Show(btQueryPrompt.Name);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);

Related Topics