Developer's Guide

Introduction

Welcome to scConverter
scConverter is a powerful component for converting plot files (PLT, HPGL, HPGL/2 and Calcomp), PDF, CGM, DWF, TIFF, PNG, JPEG, CALS and BMP files to PDF, DXF, DWF, TIF and many other formats.

You may use scConverter in any development environment that can use COM components, e.g.: Visual Basic, Visual C++, C#, ASP, ASPX, NET, Delphi and more.
The component can be used in environments not supporting COM as the DLL does export functions that can be called directly. This makes it easy to use the DLL even in a Java application. If you choose to use the exported functions directly you do not have to register the DLL.
This document describes each method, property and event available in this component.

• Exported Functions - An alternative to the COM interface
  
• Source Code Examples - Working examples with full source
  
• Redistribution - Information about which files you have to include in your application
  

Methods

AddGerberLayer

Add a Gerber layer to the control for conversion. Use this method to convert multiple layers to a single image file. When all layers are added you may use either ConvertGerberLayersToImage or ConvertGerberLayersToImageEx methods to create an image based on all layers.

AddMarkupEx

Add markup data to a file already opened by OpenFileEx.

CheckFile

Check if the given file can be opened by the converter.

ClearGerberLayers

Unload all added Gerber layers from the memory.

CloseFileEx

Close a file previously opened by OpenFileEx.

Convert

Convert the input file to a new file using the given format.

ConvertFileEx

Convert a single page, or all pages, from the input file into a new file using the given format.

ConvertGerberLayersToImage

Convert all loaded Gerber layers to a new image file of the given file format.
To be able to use this method one or more Gerber files must have previously been added as layers using the AddGerberLayer method.
Use the BackgroundColor property to change the image background color.
The image width and height will automatically be calculated based on the input file and given scale factor.

ConvertGerberLayersToImageEx

Convert all loaded Gerber layers to a new image. To be able to use this method you will need to add one or more Gerber layers using the AddGerberLayer method.
Use the BackgroundColor property to change the image background color.
The image width and height will automatically be calculated based on the input files and given scale factor.

ConvertMarkup

Convert the input file together with markup data to a new file using the given format.

ConvertPage

Convert a single page from the input file into a new file using the given format.

ConvertPageToImage

Convert a single page from the input file into a memory image.

ConvertPageToImageEx

Convert a single page from an already loaded file into a memory image.

ConvertToImageFile

Convert the input file to a new image file of the given file format.
This method gives better control of the created image that can be very useful for Gerber to image conversion.

ConvertToPaperSize

Convert the input file to a new file using the given format and selected paper size.

ConvertToPaperSizeEx

Convert the input file to a new file using the given format and selected paper size.

ConvertToPDF

Convert the input file into a PDF file.

GerberFormatSettings

Change settings that are needed to load RS-274D Gerber files correctly.

GetFileDimensions

Return dimensions of the given page in the given file.
All returned values are in millimeters.

GetFileDimensionsEx

Return dimensions of the given page in the given file.
All returned values are in millimeters.

GetFileRasterInfoEx

Return dimensions, bits per pixel and resolution of selected page in an already opened file.

GetFormatEx

Return format identifier for given file handle.

GetNumFilePages

Returns the number of pages in the given file.

GetNumFilePagesEx

Returns the number of pages in the given file.

GetPageThumbnailEx

Returns a thumbnail image for the given page and file handle.
You may alos take a look at the C# scPDFMerge sample too see how this method is used.

GetPenTableEntry

Return width, color and style for the given pen table entry.
Please see the SetPenTableEntry method for descritpion of the returned values.

LoadPenTable

Load a ViewCompanion compatible pen table file.

OpenFileEx

Open a file and keep it open for as long as needed.
This method will return a handle that may be uses by other methods to perform different tasks.
When you've done with the file it should be closed by using the CloseFileEx method.

PDFConform

Conform, or convert, an existing PDF file to selected PDF/A standard.

PDFEncrypt

Encrypt a PDF file using password(s) and restriction settings.

PDFMergeAddFile

Add a PDF file to the currently merged PDF file.
All pages from the given PDF file will be added to the merged output file.
PDFMergeInit must be called before any PDF file is added.

PDFMergeAddFileEx

Add a PDF file to the currently merged PDF file.
The PageInformation parameter controls which pages from the given PDF file that will be added to the merged output file. PDFMergeInit must be called before any PDF file is added.

PDFMergeClose

Close the currently merged PDF file and output to given file name.

PDFMergeInit

Start a new empty PDF file prepared for merging.
Use PDFMergeAddFile to add files, and finally call PDFMergeClose to complete the merge.

PDFOptimize

Optimize a PDF file for faster loading and rendering. The optimize process will rescale images and rebuild the structure of the input file. The function rebuilds the content streams of all pages, templates and, annotations. Useless operators as well as errors in content streams will be removed. The resulting content streams are error free and usually smaller. How much the optimization takes effect depends on the quality of the original content streams.

PDFSplit

Split a multi-page PDF file into smaller files based on user settings.

PDFToCAD

Convert a PDF file to an editable vector format file, for example Autodesk DXF.

SaveThumbnailEx

Saves the thumbnail for the given page and file handle to an image file.

SetMargins

Add margins to the converted file.

SetSerialNumber

Use this function to unlock the component to use all it's functionality.
You will get your own this serialnumber when You purchase a developer license.

SetPenTableEntry

Set width, color, linestyle and line endstyle for the given pen table entry.

#define PS_SOLID       0
#define PS_DASH        1   /* -------  */
#define PS_DOT         2   /* .......  */
#define PS_DASHDOT     3   /* _._._._  */
#define PS_DASHDOTDOT  4   /* _.._.._  */

SetTIFFCompression

Set compression types to use for exported TIFF files.

TextExtractEx

Extract text from an already open document.

TIFFSplit

Split a multi-page TIFF file into multiple single paged files (one per page).

Properties

BackgroundColor
Set the background color that will be used for the converted files. This property accepts a COLORREF (Windows RGB) value.
Default Value : 0x00FFFFFF (white)

DWFExporterDPI
Set resolution to use for exported DWF files.
Default Value : 1000

DWFLoadMarkup
If set to 1 (true) markup created by Autodesk Design Review will be loaded and included in the conversion.
Set to 0 to ignore markup created by Design Review.
Default Value : 1

DWFUsePaperSize
If set to 1 (true) all DWF files will be loaded using paper size if this is available, else the file will be loaded with drawing extents.
Default Value : 1

DXFForceLineLW
If set to non-zero all line elements will be written as LWPolyline instead of Line. This will increase file size, but makes it possible to write lines with width..
Default Value : 1

DXFIgnoreWhiteAreas
If set to non-zero, all filled white areas will be ignored when the DXF files is written. This may be useful if you're converting PDF files to DXF because white areas may give problems in AutoCAD.
Default Value : 0

DXFWriteMM
If enabled all DXF files be written using coordinates in millimeter. If disabled DXF files will use Inch coordinates.
Default Value : Depends on system regional settings

GerberApertureFileName
Set filename for an Gerber aperture table to be used when loading RS274D Gerber data.
Default Value : none

GetLastError
Retrieves the component's last-error code value.
Possible error codes:

0. No error.
1. Unknown format.
2. Can't create file. Possible reasons could be security settings or out of disk space.
3. No license available. No serial number given and the evaluation time (30 days) have expired.
4. Out of memory. Not enough memory available to complete the conversion.
5. File read error. Could not load the file.

ImportersPath
Set path to where the additional file importers are located.

MonochromeMode
Enable or disable monochrome export. If set to non-zero the converted files will only contain black and white graphics.
Default Value : 0

PDFHighPrecision
Enable or disable creation of high resolution PDF files. If set to non-zero, all coordinates will be written using 4 decimals to give higher accuracy. If this option is disabled 2 decimals will be used for coordinates. High resolution will increase file size.
Default Value : TRUE

PDFLargeFormat
Enables or disables creation of large format PDF files (up to 60x60 meters).
Default Value : TRUE

PDFLayers
Enable or disable creation of layered PDF files. If set to non-zero, pens will be mapped to PDF layers.
Default Value : 1

PDFMonoRasterCompression
Select the compression method to use for monochrome (1-bit) raster images in exported PDF files.
Following compression methods are available:

0. Deflate.
1. CCITT Group 4.
2. JBIG2.

PDFSearchable
Enable or disable creation of searchable PDF files. If this option is enabled and the original file contains text, the converted PDF file will be searchable.
Default Value : FALSE

PDFTransparency
Enable or disable use of transparency in exported PDF files.Some printer drivers doesn't support transparency, and turning off transparency for exported PDF files may make your files print faster.
Default Value : TRUE

PDFWriterFormat
Select PDF standard to use for converted files, following options is available:

0. Create an editable PDF file (version 1.6).
1. create a PDF/A file for archiving. PDF/A files are write-protected and cannot be edited.

PLTEncoded
Enable or disable encoded polylines (PE instruction) in exported PLT (HPGL/2) files. Files with encoded polyline are smaller (compressed).
Default Value : 1 (Use encoded polygons)

TIFFSingleStrip
Enable or disable creation of single-strip TIFF files. By default the component will create multi-strip files.
Single-strip files are usually smaller (in terms of file size) than multi-strip files. A multi-strip file may however have some advantages (depends on application):

• Less memory can be used to process the image because an application can process one strip at a time.
• Random access to image data is less complicated.

UsePenTable
Enable or disable the pen table settings. If set to non-zero the converted files be converted using the current pen table settings.
Pen tables are supported for PLT (HPGL, HPGL/2 and Calcomp), CGM and DWF file formats.
Default Value : 0