Open topic with navigation

Format.PromptValues Property

ClosedDescription

Returns a list of data entry controls and their values in xml format. Read-only.

ClosedSyntax

Format.PromptValues

ClosedRequirements

Version

BarTender 9.4 SR2 or higher

Edition

Automation, Enterprise Automation

ClosedRemarks

The Format.PromptValues property returns a list of the data entry controls setup in a BarTender document, in a dialog displaying XML.

Sample XML Response

<Prompts xmlns:xsi="http://www.w3.org/2001/XMLSchema=instance" version=""1.0" encoding="UTF-16">

<Prompt Name="Text Input Box Control 1">

<Value>Value 1</Value>

</Prompt>

<Prompt Name="Text Input Box Control 2">

<Value>Value 2</Value>

</Prompt>

<Prompts>

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

'Show a list of data entry controls in the document

MessageBox.Show(btFormat.PromptValues)

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

// Show a list of data entry controls in the document

MessageBox.Show(btFormat.PromptValues);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);