Format.Close Method

Closes an open BarTender document.

Format.Close(BtSaveOptions)

Where BtSaveOptions determines whether the document will be saved.

The BtSaveOptions argument (optional in VB.NET, but required in C#) can be set to any one of the following:

Constant	Value	Description
btPromptSave	0	Will prompt the user to save changes if needed.
btDoNotSaveChanges	1	Do not save any changes.
btSaveChanges	2	Save all changes. Do not prompt the user.

Version	BarTender 6.00 or higher
Edition	Automation, Enterprise

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

'Close the document and save changes

btFormat.Close(BarTender.BtSaveOptions.btSaveChanges)

'End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges)

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

// Close the document and save changes

btFormat.Close(BarTender.BtSaveOptions.btSaveChanges);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);