Description
NamedSubStrings.GetAll Method |
Description
Returns a string that contains the name and value of all data sources on the template(s) separated by a delimiter.
SyntaxNamedSubStrings.GetAll(NameValueDelimiter, RecordDelimiter)
Where
NameValueDelimiter is the delimiter used to separate the name and the value.
RecordDelimiter is the delimiter used to separate multiple data source name/value pairs.
Requirements|
Version |
BarTender 6.00 or higher |
|
Edition |
Automation, Enterprise Automation |
Remarks
The NamedSubStrings.GetAll method is more efficient then using the Format.GetNamedSubStringValue method, because it only makes one call to retrieve the information as opposed to multiple calls get the same information.
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, "")
'Display all of the named data sources
MessageBox.Show(btFormat.NamedSubStrings.GetAll(",", ":"))
'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, "");
// Display all of the named data source values
MessageBox.Show(btFormat.NamedSubStrings.GetAll(",", ":"));
// End the BarTender process
btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);
Related Topics