Formats.Open Method

ClosedDescription

Opens a BarTender document, and can be used to change the document's default printer and to close out "Document1.btw" which opens automatically when BarTender starts.

ClosedSyntax

Formats.Open(Path&FileName, CloseOutFirstDocument, UsePrinter)

Where

ClosedRequirements

Version

BarTender 6.00 or higher

Edition

Automation, Enterprise

ClosedRemarks

You can specify a target printer to use for printing by specifying a printer name for the UsePrinter argument. If the UsePrinter argument is left out or is "", then the printer that was selected when the document was designed or last edited will be used. The UsePrinter argument cannot be left out if you are using C# or a scripting language such as VBScript.

The CloseOutFirstDocument argument can be used to close only the default BarTender document, "Document1.btw". Other documents must be closed separately with the Format.Close method. You cannot use the Format.Open method to reload "Document1.btw". The CloseOutFirstDocument argument cannot be left out if you are using C# or a scripting language such as VBScript.

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

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

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);