DYMO Connect SDK

Important Changes

There have been API Changes in 1.6.0 compared to 1.4.4.21. In particular, IsRollStatus and GetPrinters are no longer tasks. Please include DYMO.Connect.SDK, DYMO.LabelAPI.PlatformSpecfic, and DYMO.CrossPlatform.Common.PlatformSpecific depending on your target We have split our SDK up into different parts, so please ensure you are installing the correct packages. In general, we find that including DYMO.Connect.SDK, DYMO.LabelAPI.PlatformSpecific, and DYMO.CrossPlatform.Common.PlatformSpecific should be enough, as nuget should also install dependencies automatically. For example, on windows you would include the following in your csproj:

<PackageReference Include="DYMO.Connect.SDK" Version="1.6.0" />
<PackageReference Include="DYMO.CrossPlatform.Common.Windows" Version="1.6.0" />
<PackageReference Include="DYMO.LabelAPI.Windows" Version="1.6.0" />

Getting Started 🚀

These instructions will help you to understand how DYMO Connect SDK works for .NET and Javascript.

.NET Sample

We have various samples using DYM.Connect.SDK nuget package in .NET. We have a WPF sample, a Maui sample, and a VB sample.

Installing 🔧

Open the project on Visual Studio

File > Open > Project/Solution > Select the desired project

Run Package Manager Console

 update-package -reinstall

Nuget package 📦

• DYMO.Connect.SDK - The nuget package required
  For Windows:
• DYMO.LabelAPI.Windows
• DYMO.CrossPlatform.Common.Windows
  For Mac:
• DYMO.LabelAPI.Mac
• DYMO.CrossPlatform.Common.Mac
  For iOS:
• DYMO.LabelAPI.iOS
• DYMO.CrossPlatform.Common.iOS
  For Android:
• DYMO.LabelAPI.Android
• DYMO.CrossPlatform.Common.Android

Dependencies 🛠️

• NETStandard - NETStandard.Library (>= 2.0.0)
• SkiaSharp - SkiaSharp (= 1.68.0)
• SkiaSharp.Views - SkiaSharp.Views (= 1.68.0)

Classes and methods ⚙️

• DymoLabel instance

  • Load label

  void LoadLabelFromFilePath(string FileName) // Load label content from file 
  

  void LoadLabelFromXML(string XmlContent) //Load label from XML content
  

  • Manage label objects

  IEnumerable<ILabelObject> GetLabelObjects() //Get list of objects(Text, Shapes, Address, etc.) contained in the label
  

  bool UpdateLabelObject(ILabelObject labelObject, string objectValue) //Update value of specified object
  

  bool SetImageFromFilePath(string objectName, string imageFile) //Set content of image object specified from image file 
  

  bool SetImageFromBase64(string objectName, string base64String) //Set content of image object specified from Base64 string
  

  • Get preview

  byte[] GetPreviewLabel() //Get preview image's label as byte array
  

  • Save label

  bool Save(string fileName) //Save label file
  

• DymoPrinter instance

  • Get printers

    • Get list of DYMO printers installed in the current machine.

    IEnumerable<IPrinter> GetPrinters()
    

  • Print label

    • Print an instantiated DymoLabel object in the selected printer.

    async Task<bool> PrintLabel(
    IDymoLabel label, /* Label instance */
    string printerName, /* Printer name */
    int copies = 1, /* Number of copies */
    bool collate = false, /* Collate printing label */
    bool mirror = false, /* Mirroring label */
    int rollSelected = 0, /* It applies only for Twin Turbo 450 printer --> 0: left, 1:right */
    bool chainMarks = false, /* Chain marks when label printer is D1 */
    bool barcodeGraphsQuality = false /* Activate Barcode and graphics quality */)
    

    • Print a list of instantiated DymoLabel objects in the selected printer.

    async Task<bool> PrintLabel(
    IEnumerable<IDymoLabel> labelsCollection, /* Collection of labels instances */
    string printerName, /* Printer name */
    int copies = 1, /* Number of copies */
    bool collate = false, /* Collate printing label */
    bool mirror = false, /* Mirroring label */
    int rollSelected = 0, /* It applies only for Twin Turbo 450 printer --> 0: left, 1:right */
    bool chainMarks = false, /* Chain marks when label printer is D1 */
    bool barcodeGraphsQuality = false /* Activate Barcode and graphics quality */)
    

  • LW 550 printer methods(these methods will not have effect when selected printer does not belong to 550 series)

    • Verify if selected printer belongs to 550 series.

    bool IsRollStatusSupported(string printerName)
    

    • Get information about current label inserted in the selected printer.

    async Task<IRollStatusInPrinter> GetRollStatusInPrinter(string printerName)
    

JavaScript Sample

This is a JavaScript sample using DYMO Connect Framework.

Prerequisites 📋

DYMO Connect Software installed

• DYMO Connect Software
• DYMO Connect framework has compatibility with DYMO Label Software

Reference to Javascript SDK file

• DYMO.Connect.Framework

Installing 🔧

Include the framework into your project

• https://github.com/dymosoftware/dymo-connect-framework/blob/master/dymo.connect.framework.min.js
• https://qajavascriptsdktests.azurewebsites.net/JavaScript/dymo.connect.framework.js

Functions ⚙️

dymo.connect.framework includes functions from the previous dymo.label.framework

• DYMO.Label.Framework documentation

These are the main functions to get start

• dymo.connect.framework

  • Initialize

   dymo.label.framework.init() //Initialize DYMO Label Framework
  

  dymo.label.framework.checkEnvironment() // Validate if the environment meets the requirements
  

  • Load label

  dymo.label.framework.openLabelFile(fileName) //Load label from file name and return label instance
  

  • Validate label

  dymo.label.framework.openLabelXml(labelXml) //Load label from XML content and return label instance
  

  • Validate label instance (introduced in dymo.connect.framework)

  label.isValidLabel() //Validate if the current content is a valid label based on the current service installed
  label.isDCDLabel() //Validate if the current content is a valid DYMO Connect label based on DYMO Connect service
  label.isDLSLabel() //Validate if the current content is a valid DYMO Label Software label based on DYMO Label Software service
  

  • Get printers

  dymo.label.framework.getPrinters() //Get list of DYMO printers installed
  

  • Print

  dymo.label.framework.printLabel(printerName, printParamsXml, labelXml, labelSetXml) //Print label
  

  • Get preview

  dymo.label.framework.renderLabel(labelXml, renderParamsXml, printerName) //Get label preview image of the label
  

Sample Html Pages 📋

Local Web Api service should be running to be able to work with sample pages.

• https://qajavascriptsdktests.azurewebsites.net/JavaScript/CheckEnvironment/CheckEnvironment.html
• https://qajavascriptsdktests.azurewebsites.net/JavaScript/VisitorManagement/VisitorManagement.html
• https://qajavascriptsdktests.azurewebsites.net/JavaScript/PreviewAndPrintLabel/PreviewAndPrintLabel.html

Important notes

Opening a label file previously created from DYMO Label Software, with DYMO Connect Software installed, it will convert the structure of DLS label into DYMO Connect label. Therefore, isDCDLabel function will return always true after label file has been open, when DYMO Connect is running.

setTextMarkup function is not supported for DYMO Connect labels.

Publishing your app

Please read the following thread in case you run into some issues deploying your application integrating DYMO Connect SDK.

Common deployment issues

Python Sample

We also have a python wrapper around our SDK available here.

Authors ✒️

DYMO Team www.dymo.com

Acknowledgments 📢

• NETStandard documentation
• Questions? dymoconsumercare@newellco.com