Migrating to ThermalLabel SDK 8.0

If you're using an older version of ThermalLabel SDK (Version 4.0 to 7.0), please follow up these steps to migrate to Version 8.0

Migration Steps

Breaking Changes

Review the Breaking Changes topic

Update Target .NET Framework

ThermalLabel SDK 8.0 can be used in .NET 4.6.1+ so update your project's target framework to any of those versions. Older .NET Framework is no longer supported.

Update your Project's References

You should remove the reference to old Neodynamic.SDK.ThermalLabel.dll file and add a new reference to v8 dll. In addition, you should add the following libraries that are required by new ThermalLabel SDK and can be found in NuGet repository:

  • SkiaSharp 1.60
  • SkiaSharp.HarfBuzz 1.60
  • System.Text.Encoding.CodePages 4.4.0

PrintJob Print method

If your calling old PrintJob's Print method, then do the following:

  • Add a Reference to the brand new Neodynamic.SDK.ThermalLabel.WindowsPrinting.dll assembly
  • Then replace PrintJob class by WindowsPrintJob class

Serial Port Enumeration Types

Enumeration types for Serial Port printer settings has changed. In your code, do the following replacement:

  • Replace System.IO.Ports.Handshake by Neodynamic.SDK.Printing.SerialPortHandshake
  • Replace System.IO.Ports.Parity by Neodynamic.SDK.Printing.SerialPortParity
  • Replace System.IO.Ports.StopBits by Neodynamic.SDK.Printing.SerialPortStopBits

BarcodeItem Changes

  • The size of the barcode symbol when printed could vary from older versions if BarWidth or 2D Module Size settings were set to values that are not multiple of the target DPI printer. V8 now will print the same barcode size you can see on screen or when exporting labels to image formats. To get the same output printing from older version, BarWidth or 2D Module Size properties must be set to a value multiple of the target printer.
  • BarcodeItem GetAutoSize method now returns a System.Tuple<double, double> object instead of System.Windows.Size

TextItem Changes

TextItem GetAutoSize method now returns a System.Tuple<double, double> object instead of System.Windows.Size

ImageSettings Changes

ImageSettings' PixelFormat and TiffCompression properties are no longer supported. Remove it from your code. PNG or JPEG raster image formats are the only supported.

TIFF, BMP & GIF Outputs

Exporting labels to TIFF, BMP & GIF image formats is no longer supported. Change your code to export to PNG, JPG, SVG or PDF

Export Labels to PDF

Removed outputQuality param from ExportToPdf method of PrintJob class. Remove it from your own code.

Export Labels to PNG

If you expect to print any label that was exported to PNG image format, then consider setting the ImageSettings's PngIncludeDpiMetadata property to True because by default, that value will not be saved into the output PNG image.

License Registration

License info cannot be specified in .config files. Please refer to License Registration topic

Need Assistance?

For further tech assistance on this topic, please contact our Support