Description
Format.ExportToFile Method |
Description
Creates an image of the document's template and saves it to an image file.
Syntax
Format.ExportToFile(FileName, FileType, BtColors, BtResolution, BtSaveOptions)
Where
FileName is the full path and file name of the file to create.
FileType is the image file type (such as JPG, GIF, and so on). For a list of supported image types, refer to Supported Image Formats in the BarTender online help system.
BtColors sets the number of colors that are used to create the image. Available options include BtColors.btColorsMono (black and white), BtColors.btColors16 (16 colors), BtColors.btColors256 (256 colors), BtColors.btColors24bit (24bit color file), and BtColors.btColors32bit (32bit color file). BtColors.btColors32bit supports exporting the object with a transparent background.
BtResolution sets the resolution of the exported image. Valid values can be any number from 2 to 3000, representing dots per inch (dpi) or one of the following designated values:
-1 (equal to 1 dpi)
0 (the resolution of the screen that creates the image [btResolutionScreen])
1 (the resolution of the printer [btResolutionprinter])
BtSaveOptions, which is optional for VB.NET and required for C#, determines what to do when the specified file name already exists at the specified path. Available options include BtSaveOptions.btPromptSave (overwrite the existing file when prompted), BtSaveOptions.btDoNotSaveChanges (do not overwrite the existing file or save changes), and BtSaveOptions.btSaveChanges (replace the existing file with the current image).
Requirements
|
Version |
BarTender 6.00 or higher |
|
Edition |
Automation, Enterprise |
Remarks
The Format.ExportToFile method exports all objects that are created on the template, with the following exceptions:
Any objects on the document for which the Preprinted option is selected are not exported to the Clipboard.
Any objects for which the Print When option is used to disable printing are not printed.
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 to visible
btApp.Visible = True
'Open a BarTender document
btFormat = btApp.Formats.Open("c:\Format1.btw", False, "")
'Export the document to a bitmap file
btFormat.ExportToFile("c:\Format1.bmp", "BMP", BarTender.BtColors.btColors24Bit, BarTender.BtResolution.btResolutionPrinter, BarTender.BtSaveOptions.btSaveChanges)
'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 to visible
btApp.Visible = true;
// Open a BarTender document
btFormat = btApp.Formats.Open("c:\\Format1.btw", false, "");
// Export the document to a bitmap file
btFormat.ExportToFile("c:\\Format1.bmp", "BMP", BarTender.BtColors.btColors24Bit, BarTender.BtResolution.btResolutionPrinter, BarTender.BtSaveOptions.btSaveChanges);
// End the BarTender process
btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);
Related Topics