dotnet add package DYMO.Connect.SDK --version                
NuGet\Install-Package DYMO.Connect.SDK -Version                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DYMO.Connect.SDK" Version="" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DYMO.Connect.SDK --version                
#r "nuget: DYMO.Connect.SDK,"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install DYMO.Connect.SDK as a Cake Addin
#addin nuget:?package=DYMO.Connect.SDK&version=

// Install DYMO.Connect.SDK as a Cake Tool
#tool nuget:?package=DYMO.Connect.SDK&version=                

DYMO Connect SDK

Getting Started 🚀

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

.NET Sample

This is a WPF sample using DYM.Connect.SDK nuget package.

Installing 🔧

Open the project on Visual Studio

File > Open > Project/Solution > Select WPFSDKSample.csproj

Run Package Manager Console

 update-package -reinstall

Nuget package 📦

Dependencies 🛠️

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.
         bool PrintLabel(DymoLabel label, string printerName, int copies = 1, bool collate = false, bool mirror = false, int rollSelected = 0, bool chainMarks 
        = false,  bool barcodeGraphsQuality = false) 
      • Print a list of instantiated DymoLabel objects in the selected printer.
      bool PrintLabel(IEnumerable<DymoLabel> labels, string printerName, int copies = 1, bool collate = false, bool mirror = false, int rollSelected = 0, 
      bool chainMarks=false,  bool barcodeGraphsQuality = false)
    • 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 Is550Printer(string printerName) 
      • Get information about current label inserted in the selected printer.
      IConsumableInfo550Printer GetCurrentLabelInsertedIn550Printer(string printerName)

JavaScript Sample

This is a JavaScript sample using DYMO Connect Framework.

Prerequisites 📋

DYMO Connect Software installed

Reference to Javascript SDK file

Installing 🔧

Include the framework into your project

Functions ⚙️

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

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.

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

Authors ✒️

DYMO Team www.dymo.com

Acknowledgments 📢

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on DYMO.Connect.SDK:

Package Downloads

I-Synergy Framework Dymo Label printer library for .net 8.0

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated 9,262 9/6/2023 65,697 3/15/2022 676 2/24/2022 16,514 11/16/2021 724 11/1/2021 1,264 10/4/2021 858 10/4/2021 1,023 9/20/2021 1,198 9/16/2021 973 9/14/2021 3,399 5/1/2021 811 4/9/2021 799 3/29/2021 809 3/25/2021 1,103 5/6/2020 13,675 3/4/2020
1.2.977.106 1,286 2/21/2020
1.2.977.101 1,095 2/18/2020
1.2.977 1,832 2/12/2020
1.2.977-beta 865 2/10/2020
1.2.976.48730 2,970 12/11/2019
1.2.976.48729 1,161 12/5/2019
1.2.967.48509-beta 933 10/23/2019
1.2.966.48498-beta 874 10/22/2019
1.2.965.48487-beta 902 10/17/2019
1.2.964.48478-beta 876 10/16/2019
1.2.959.48469-beta 899 10/14/2019
1.2.958.48468-beta 921 10/14/2019