Open topic with navigation

Formats.GetFormat Method

ClosedDescription

Returns a reference to a specified Format object.

ClosedSyntax

Formats.GetFormat(Index)

Where Index can be either an integer or a string specifying the file name of the BarTender document.

ClosedRequirements

Version

BarTender 7.50 or higher

Edition

Automation, Enterprise Automation

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

'Open a second BarTender document

btFormat = btApp.Formats.Open("c:\Format2.btw", False, "")

'Select the first open document

btFormat = btApp.Formats.GetFormat(1)

'Alternatively, use the document's FileName property if it is known

'btFormat = btFormat.Formats.GetFormat("Format1.btw")

'Set focus to the first document

btFormat.Activate()

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

// Open a second BarTender document

btFormat = btApp.Formats.Open("c:\\Format2.btw", false, "");

// Select the first opened document

btFormat = btApp.Formats.GetFormat(1);

// Alternatively, use the document's FileName property if it is known

// btFormat = btFormat.Formats.GetFormat("Format1.btw")

// Set focus to the first document

btFormat.Activate();

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);