Description
DesignObject.ExportToFile Method |
Description
Creates an image of the selected object and saves it to an image file.
Syntax DesignObject.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 (jpg, gif, etc). See Supported Image Formats in the BarTender online help for a list of supported image types.
BtColors sets the number of colors being 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. In VB.NET, valid values can be any number from 2 to 3000, representing DPI (dots per inch), or one of the following designated values: 0 (the resolution of the screen creating the image [btResolutionScreen]), or 1 (the resolution of the printer [btResolutionprinter]). In C#, you can use the predefined options BtResolution.btResolutionScreen or BtResolution.btResolutionPrinter, or specify the DPI as a number (numeric values must be cast to the BtResolution type).
BtSaveOptions, 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 9.4 or higher |
|
Edition |
Automation, Enterprise |
VB.NET Example
'Declare a BarTender application variable
Dim btApp As BarTender.Application
'Declare a BarTender document variable
Dim btFormat As BarTender.Format
'Declare a BarTender design object variable
Dim btObject As BarTender.DesignObject
'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, "")
'Set the object variable
btObject = btFormat.Objects.Find("Box 1")
'Export the box object to a bitmap file
btObject.ExportToFile("c:\Box1.bmp", "BMP", BarTender.BtColors.btColors24Bit, 150, 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;
// Declare a BarTender design object variable
BarTender.DesignObject btObject;
// 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, "");
// Set the object variable
btObject = btFormat.Objects.Find("Box 1");
// Export the box object to a bitmap file
btObject.ExportToFile("c:\\Box1.bmp", "BMP", BarTender.BtColors.btColors24Bit, (BarTender.BtResolution)150, BarTender.BtSaveOptions.btSaveChanges);
// End the BarTender process
btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);
Related Topics