Description
Format.UsedNames Property |
Description
Returns a list of database field names, share names, or template names used on the template(s). Read-only.
Syntax
Format.UsedNames(BtNameType, Delimiter)
Where
Delimiter is the character used to separate the names in the list.
BtNameType can be set to any of the following constants:
|
Constant |
Value |
Description |
|---|---|---|
|
btUsedNamedSubStrings |
0 |
Return a list of named data sources on the template(s) |
|
btUsedDatabaseFields |
1 |
Return a list of database fields on the template(s) |
|
btUsedTemplateFields |
2 |
Return a list of template fields on the template(s) |
Requirements
|
Version |
BarTender 7.75 or higher |
|
Edition |
Automation, Enterprise |
VB.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)
C# 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);