Format.GetPrompt Method

ClosedDescription

Returns the value of a specified user prompt.

ClosedSyntax

Format.GetPrompt(promptName)

Where promptName is the name of the user prompt to retrieve.

ClosedRequirements

Version

BarTender 9.4 SR2 or higher

Edition

Automation, Enterprise

ClosedVB.NET Example

'Declare a BarTender application variable

Dim btApp As BarTender.Application

'Declare a BarTender document variable

Dim btFormat As BarTender.Format

'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, "")

'Display the value of the user prompt entitled ProductName

MessageBox.Show(btFormat.GetPrompt("ProductName"))

'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;

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

// Display the value of the user prompt entitled ProductName

MessageBox.Show(btFormat.GetPrompt("ProductName"));

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);

Related Topics