Format.UsedNames Property

ClosedDescription

Returns a list of database field names, share names, or template names used on the template(s). Read-only.

ClosedSyntax

Format.UsedNames(BtNameType, Delimiter)

Where

ClosedRequirements

Version

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

'Show a list of database fields used on the template(s)

MessageBox.Show(btFormat.UsedNames(BarTender.BtNameType.btUsedNamedSubStrings, ":"))

'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 database fields used on the document

MessageBox.Show(btFormat.get_UsedNames(BarTender.BtNameType.btUsedDatabaseFields, ":"));

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);