Open topic with navigation

QueryPrompts.Item Method

ClosedDescription

Returns a reference to a specified QueryPrompt object.

This method has the same functionality as the QueryPrompts.GetQueryPrompt method.

ClosedSyntax

QueryPrompts.Item(Index)

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

ClosedRequirements

Version

BarTender 6.00 or higher

Edition

Automation, Enterprise Automation

ClosedRemarks

Use the QueryPrompts.Item method to access a specific query prompt that is setup in a BarTender document. Index can be either an integer value or a string specifying the query prompt name. In VB.NET, QueryPrompts.Item is the default method for the query prompts collection, therefore the QueryPrompts.Item method does not have to be specified in order to get a reference to a given query prompt object. The query prompt object can be referenced directly using the query prompts collection.

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.Item(1)

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

'btQueryPrompt = btFormat.Databases.QueryPrompts.Item("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;

// Declare an object variable

System.Object obj;

// 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, "");

// Declare an index variable and set to the index value

int index = 1;

// Alternatively, if you plan to use the query prompt's name,

// Declare a string variable

// string index = "MyQueryPrompt";

// Set the object variable to the value of the index variable

obj = index;

// Select the query prompt

btQueryPrompt = btFormat.Databases.QueryPrompts.Item(ref obj);

// Show the query prompt's name

MessageBox.Show(btQueryPrompt.Name);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);

Related Topics