NamedSubStrings.GetSubString Method

Description

Returns a reference to a specified SubString object.

Syntax

NamedSubStrings.GetSubString(Index)

Where Index can be either an integer or a string specifying the shared name of the data source.

Requirements

Version	BarTender 7.50 or higher
Edition	Automation, Enterprise

Use the NamedSubStrings.GetSubString method to access a specific SubString object that is setup on a template. Index can be either an integer value or a string specifying the name of the data source. The order of data sources in the collection is not guaranteed to be in the order of data sources in the object(s). Therefore we recommend referencing a SubString object by its name, rather by an integer index.

VB.NET Example

'Declare a BarTender application variable

Dim btApp As BarTender.Application

'Declare a BarTender document variable

Dim btFormat As BarTender.Format

'Declare a BarTender data source variable

Dim btSubString As BarTender.SubString

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

'Select the data source

btSubString = btFormat.NamedSubStrings.GetSubString(1)

'Alternatively, use the data source's name if it is known

'btSubString = btFormat.NamedSubStrings.GetSubString("bikes")

'Display the name of the data source

MessageBox.Show(btSubString.Name)

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

// Declare a BarTender data source variable

BarTender.SubString btSubString;

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

// Select the data source

btSubString = btFormat.NamedSubStrings.GetSubString(1);

// Alternatively, use the data source's name if it is known

// btSubString = btFormat.NamedSubStrings.GetSubString("bikes");

// Display the name of the data source

MessageBox.Show(btSubString.Name);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);

Related Topics