Description
Formats.Open Method |
Description
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.
Syntax Formats.Open(Path&FileName, CloseOutFirstDocument, UsePrinter)
Where
Path&FileName is the path and file name of the BarTender document. Wildcards, * and ?, are supported for opening multiple documents.
CloseOutFirstDocument, optional in VB.NET and required in C#, determines whether BarTender will close out "Document1.btw" if it exists. If set to true, "Document1.btw" is closed out.
UsePrinter, optional in VB.NET and required in C#, specifies an alternate printer for the document. The default is to use the printer that was selected when the document was designed or last edited.
Requirements
|
Version |
BarTender 6.00 or higher |
|
Edition |
Automation, Enterprise |
Remarks
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.
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, "")
'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, "");
// End the BarTender process
btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);