DYMO Connect Framework

DYMO.Connect.Framework is a new JavaScript SDK based on DYMO.Label.Framework introducing compatibility with DYMO Connect Software.

Getting Started 🚀

These instructions will help you to understand how DYMO.Connect.Framework works.

Prerequisites 📋

DYMO Connect Software installed

• DYMO Connect Software Windows

• DYMO Connect Software Mac

• DYMO.Connect.Framework has compatibility with DYMO Label Software and DYMO Connect Software.

Samples

• JS samples

Installing 🔧

Include the framework into your project

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

Functions ⚙️

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

• Download 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

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.

Authors ✒️

DYMO Team www.dymo.com

Acknowledgments 📢

• NETStandard documentation
• Questions? [email protected]
• Developer's blog