### Get list of DYMO printers: dymo.label.framework.getPrinters Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Retrieves a list of DYMO printers installed on the system. Use before printing to select a printer. ```javascript dymo.label.framework.getPrinters() //Get list of DYMO printers installed ``` -------------------------------- ### dymo.label.framework.getPrinters Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Gets the list of DYMO printers installed. ```APIDOC ## [GET] /dymo.label.framework.getPrinters ### Description Gets the list of DYMO printers installed. ### Method GET ### Endpoint /dymo.label.framework.getPrinters ### Parameters None ### Request Example ```javascript dymo.label.framework.getPrinters() ``` ### Response #### Success Response (200) - **printers** (array of string) - List of printer names. #### Response Example ``` ["DYMO LabelWriter 450"] ``` ``` -------------------------------- ### dymo.label.framework.checkEnvironment() Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.html Checks that the browser environment is suitable for the Framework. Returns an object with properties indicating browser support, framework installation, and error details. ```APIDOC ## dymo.label.framework.checkEnvironment() ### Description Checks that the browser environment is suitable for the Framework. ### Method checkEnvironment() ### Returns An object with the following properties: - **isBrowserSupported** (boolean) - Indicates whether the browser is supported or not. - **isFrameworkInstalled** (boolean) - Indicates whether the Framework is installed or not. - **errorDetails** (string) - An empty string if no error is detected; an error message if an error is detected. ``` -------------------------------- ### dymo.label.framework.renderLabel Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Gets a label preview image of the label. ```APIDOC ## [POST] /dymo.label.framework.renderLabel ### Description Gets a label preview image of the label. ### Method POST ### Endpoint /dymo.label.framework.renderLabel ### Parameters #### Request Body - **labelXml** (string) - Required - XML string of the label. - **renderParamsXml** (string) - Required - XML string containing rendering parameters. - **printerName** (string) - Required - The name of the printer. ### Request Example ```javascript dymo.label.framework.renderLabel(labelXml, renderParamsXml, printerName) ``` ### Response #### Success Response (200) - **image** (string) - The label preview image (e.g., base64 encoded). #### Response Example ``` "data:image/png;base64,..." ``` ``` -------------------------------- ### Get label preview: dymo.label.framework.renderLabel Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Renders a label preview image. Provide label XML, render parameters XML, and printer name. ```javascript dymo.label.framework.renderLabel(labelXml, renderParamsXml, printerName) //Get label preview image of the label ``` -------------------------------- ### getAddressObjectCount() Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Gets the number of Address objects on the label. ```APIDOC ## getAddressObjectCount() ### Description Gets the number of Address objects on the label. ### Method N/A (SDK method) ### Parameters None ### Returns - {number} - The number of Address objects on the label. ``` -------------------------------- ### getObjectNames() Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Gets an array of object reference names on the label. ```APIDOC ## getObjectNames() ### Description Gets an array of object reference names on the label. ### Method N/A (SDK method) ### Parameters None ### Returns - {Array} - An array of strings. ``` -------------------------------- ### Validate label instance: isValidLabel, isDCDLabel, isDLSLabel Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Validate the current label content using the installed service. isValidLabel checks against the current service, while isDCDLabel and isDLSLabel check against specific services. Note that after opening a DLS label with DYMO Connect running, isDCDLabel will always return true. ```javascript label.isValidLabel() //Validate if the current content is a valid label based on the current service installed ``` ```javascript label.isDCDLabel() //Validate if the current content is a valid DYMO Connect label based on DYMO Connect service ``` ```javascript label.isDLSLabel() //Validate if the current content is a valid DYMO Label Software label based on DYMO Label Software service ``` -------------------------------- ### label.isValidLabel Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Validates if the current content is a valid label based on the current service installed. ```APIDOC ## [POST] /label.isValidLabel ### Description Validates if the current content is a valid label based on the current service installed. ### Method POST ### Endpoint /label.isValidLabel ### Parameters None ### Request Example ```javascript label.isValidLabel() ``` ### Response #### Success Response (200) - **boolean** (boolean) - True if the label is valid, false otherwise. #### Response Example ``` true ``` ``` -------------------------------- ### getObjectText(objectName) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Gets the 'text' content of an object. ```APIDOC ## getObjectText(objectName) ### Description Gets the 'text' content of an object. The content depends on the object type. ### Method N/A (SDK method) ### Parameters - **objectName** (string) - Required - The name of the object. ### Returns - {string} - The text content of the object. ``` -------------------------------- ### getAddressText(addressIndex) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Gets the text content of an Address object. ```APIDOC ## getAddressText(addressIndex) ### Description Gets the text content of an Address object. ### Method N/A (SDK method) ### Parameters - **addressIndex** (number) - Required - The zero-based index of the Address object in a 'virtual' array of all Address objects on the label. ### Returns - {string} - The plain text from the Address object. ``` -------------------------------- ### getAddressBarcodePosition(addressIndex) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Gets the Intelligent Mail barcode position for an Address object. ```APIDOC ## getAddressBarcodePosition(addressIndex) ### Description Gets the Intelligent Mail barcode position for an Address object. ### Method N/A (SDK method) ### Parameters - **addressIndex** (number) - Required - The zero-based index of the Address object in a 'virtual' array of all Address objects on the label. ### Returns - {dymo.label.framework.AddressBarcodePosition} - A string with one of the values defined by the dymo.label.framework.AddressBarcodePosition enumeration. ``` -------------------------------- ### dymo.label.framework.init Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Initializes the DYMO Label Framework. Must be called before using other framework functions. ```APIDOC ## [POST] /dymo.label.framework.init ### Description Initializes the DYMO Label Framework. This function must be called before using any other framework functions. ### Method POST ### Endpoint /dymo.label.framework.init ### Parameters None ### Request Example ```javascript dymo.label.framework.init() ``` ### Response #### Success Response (200) No return value. #### Response Example ``` undefined ``` ``` -------------------------------- ### Initialize and check environment for DYMO Label Framework Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Initialize DYMO Label Framework and validate that the environment meets requirements. Call these functions before using other framework APIs. ```javascript dymo.label.framework.init() //Initialize DYMO Label Framework ``` ```javascript dymo.label.framework.checkEnvironment() // Validate if the environment meets the requirements ``` -------------------------------- ### Load label from file: dymo.label.framework.openLabelFile Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Load a label from a file name and return a label instance. The file must be a valid DYMO Connect or DYMO Label Software label file. ```javascript dymo.label.framework.openLabelFile(fileName) //Load label from file name and return label instance ``` -------------------------------- ### dymo.label.framework.openLabelFile Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Loads a label from a file name and returns a label instance. ```APIDOC ## [POST] /dymo.label.framework.openLabelFile ### Description Loads a label from a file name and returns a label instance. ### Method POST ### Endpoint /dymo.label.framework.openLabelFile ### Parameters #### Path Parameters - **fileName** (string) - Required - The name of the label file to load. ### Request Example ```javascript dymo.label.framework.openLabelFile(fileName) ``` ### Response #### Success Response (200) - **label** (object) - The label instance. #### Response Example ``` Label instance ``` ``` -------------------------------- ### dymo.label.framework.PrinterInfo() Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.PrinterInfo.html Constructor for the PrinterInfo class. One element returned by dymo.label.framework.getPrinters. ```APIDOC ## dymo.label.framework.PrinterInfo() ### Description Creates a new PrinterInfo object. This is one element returned by dymo.label.framework.getPrinters. ### Constructor `dymo.label.framework.PrinterInfo()` ### Fields - **isAutoCutSupported** (boolean) - Indicates whether the Auto-Cut feature is supported by the printer or not. Note: The property is only defined if printerType is "TapePrinter". - **isConnected** (boolean) - Indicates whether the printer is connected to a computer or not. Note: Currently only returns properly for local USB-connected printers on Windows. - **isLocal** (boolean) - Indicates whether the printer is a local USB-connected printer or a shared network printer. Note: Currently only returns properly on Windows. - **isTwinTurbo** (boolean) - Indicates whether the printer is a "LabelWriter Twin Turbo" (has two rolls) or not. Note: The property is only defined if printerType is "LabelWriterPrinter". - **modelName** (string) - Returns the printer model/driver name. - **name** (string) - Returns the printer name (print queue name on Mac). - **printerType** (string) - Returns the printer type; "LabelWriterPrinter" or "TapePrinter". ### Example ```javascript var printers = dymo.label.framework.getPrinters(); var printer = printers[0]; console.log(printer.name); ``` ``` -------------------------------- ### dymo.label.framework.openLabelXml Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Loads a label from XML content and returns a label instance. ```APIDOC ## [POST] /dymo.label.framework.openLabelXml ### Description Loads a label from XML content and returns a label instance. ### Method POST ### Endpoint /dymo.label.framework.openLabelXml ### Parameters #### Request Body - **labelXml** (string) - Required - The XML content of the label. ### Request Example ```javascript dymo.label.framework.openLabelXml(labelXml) ``` ### Response #### Success Response (200) - **label** (object) - The label instance. #### Response Example ``` Label instance ``` ``` -------------------------------- ### Load label from XML: dymo.label.framework.openLabelXml Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Load a label from XML content and return a label instance. The XML must be a valid label definition. ```javascript dymo.label.framework.openLabelXml(labelXml) //Load label from XML content and return label instance ``` -------------------------------- ### render(renderParamsXml, printerName) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Creates a label raster image for previewing. ```APIDOC ## render(renderParamsXml, printerName) ### Description Creates a label raster image that can be used for label previewing. ### Method render ### Parameters - **renderParamsXml** (string) - Required - Rendering parameters, such as shadow depth, label color, etc. See LabelRenderParams.xsd. - **printerName** (string) - Required - The name of the printer that the preview is generated for. The preview/output can be different for different printers, especially for tape printers with different print head sizes. If it is not important what printer the label is printed to, an empty string can be passed. In this case, the default printer metrics will be used. The default is LW400 for LabelWriter printers and LW400 DUO Tape for tape printers. ### Returns - **string** - The label raster image. ``` -------------------------------- ### dymo.label.framework.LabelSetBuilder() Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.LabelSetBuilder.html Constructor for the LabelSetBuilder class. ```APIDOC ## LabelSetBuilder() ### Description Creates a new LabelSetBuilder instance used to build a LabelSet for printing multiple labels in one print job. ### Constructor `dymo.label.framework.LabelSetBuilder()` ### Usage ```javascript var builder = new dymo.label.framework.LabelSetBuilder(); ``` ``` -------------------------------- ### render(renderParamsXml, printerName) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Creates a label raster image that can be used for label previewing. ```APIDOC ## render(renderParamsXml, printerName) ### Description Creates a label raster image that can be used for label previewing. ### Method N/A (SDK method) ### Parameters - **renderParamsXml** (string) - Required - The render parameters. - **printerName** (string) - Required - The name of the printer. ``` -------------------------------- ### toString() Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.LabelSetBuilder.html Converts the builder's content to an XML string. ```APIDOC ## toString() ### Description Converts the builder's content to an XML string suitable to pass to `dymo.label.framework.printLabel`. ### Method `toString()` ### Returns - **{string}** - XML string representation of the LabelSet. ### Usage ```javascript var xml = builder.toString(); ``` ``` -------------------------------- ### dymo.label.framework.createLabelRenderParamsXml(params) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.html Creates an XML string suitable to pass to the dymo.label.framework.renderLabel function as renderParamsXml parameter. ```APIDOC ## dymo.label.framework.createLabelRenderParamsXml(params) ### Description Creates an XML string suitable to pass to the dymo.label.framework.renderLabel function as renderParamsXml parameter. ### Method createLabelRenderParamsXml ### Parameters - **params** (object) - Required - The label render parameters. ``` -------------------------------- ### dymo.label.framework.renderLabel(labelXml, renderParamsXml, printerName) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.html Creates a label raster image that can be used for label previewing. ```APIDOC ## dymo.label.framework.renderLabel(labelXml, renderParamsXml, printerName) ### Description Creates a label raster image that can be used for label previewing. ### Method renderLabel ### Parameters - **labelXml** (string) - Required - The label XML string. - **renderParamsXml** (string) - Required - The render parameters XML string. - **printerName** (string) - Required - The name of the printer to use. ``` -------------------------------- ### dymo.label.framework.loadImageAsPngBase64(imageUri) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.html Loads an image from a URL or file and returns it as a base64-encoded PNG stream. ```APIDOC ## dymo.label.framework.loadImageAsPngBase64(imageUri) ### Description Loads an image from a URL or file and returns it as a base64-encoded PNG stream. ### Method loadImageAsPngBase64 ### Parameters - **imageUri** (string) - Required - The URI of the image to load. ``` -------------------------------- ### print(printerName, printParamsXml, labelSetXml) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Prints the label. ```APIDOC ## print(printerName, printParamsXml, labelSetXml) ### Description Prints the label. ### Method N/A (SDK method) ### Parameters - **printerName** (string) - Required - The name of the printer to print to. A list of printers can be obtained using dymo.label.framework.getPrinters. - **printParamsXml** (string) - Required - The print parameters, such as number of copies, print quality, etc. See PrintParams.xsd. - **labelSetXml** (string) - Required - The label set XML. ``` -------------------------------- ### Print a label: dymo.label.framework.printLabel Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Prints a label to the specified printer. Provide printer name, print parameters XML, label XML, and optional label set XML. ```javascript dymo.label.framework.printLabel(printerName, printParamsXml, labelXml, labelSetXml) //Print label ``` -------------------------------- ### dymo.label.framework.createTapePrintParamsXml(params) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.html Creates an XML string suitable to pass to the dymo.label.framework.printLabel function as printParamsXml parameter. ```APIDOC ## dymo.label.framework.createTapePrintParamsXml(params) ### Description Creates an XML string suitable to pass to the dymo.label.framework.printLabel function as printParamsXml parameter. ### Method createTapePrintParamsXml ### Parameters - **params** (object) - Required - The tape print parameters. ``` -------------------------------- ### dymo.label.framework.checkEnvironment Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Validates if the environment meets the requirements for the DYMO Label Framework. ```APIDOC ## [POST] /dymo.label.framework.checkEnvironment ### Description Validates if the environment meets the requirements for the DYMO Label Framework. ### Method POST ### Endpoint /dymo.label.framework.checkEnvironment ### Parameters None ### Request Example ```javascript dymo.label.framework.checkEnvironment() ``` ### Response #### Success Response (200) No return value. #### Response Example ``` undefined ``` ``` -------------------------------- ### dymo.label.framework.createLabelWriterPrintParamsXml(params) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.html Creates an XML string suitable to pass to the dymo.label.framework.printLabel function as printParamsXml parameter. ```APIDOC ## dymo.label.framework.createLabelWriterPrintParamsXml(params) ### Description Creates an XML string suitable to pass to the dymo.label.framework.printLabel function as printParamsXml parameter. ### Method createLabelWriterPrintParamsXml ### Parameters - **params** (object) - Required - The label writer print parameters. ``` -------------------------------- ### dymo.label.framework.printLabel Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Prints a label with the specified printer, print parameters, label XML, and label set XML. ```APIDOC ## [POST] /dymo.label.framework.printLabel ### Description Prints a label with the specified printer, print parameters, label XML, and label set XML. ### Method POST ### Endpoint /dymo.label.framework.printLabel ### Parameters #### Request Body - **printerName** (string) - Required - The name of the printer. - **printParamsXml** (string) - Required - XML string containing print parameters. - **labelXml** (string) - Required - XML string of the label to print. - **labelSetXml** (string) - Required - XML string of the label set. ### Request Example ```javascript dymo.label.framework.printLabel(printerName, printParamsXml, labelXml, labelSetXml) ``` ### Response #### Success Response (200) No return value. #### Response Example ``` undefined ``` ``` -------------------------------- ### getLabelXml() Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Returns the current label as an XML string. ```APIDOC ## getLabelXml() ### Description Returns the current label as an XML string. ### Method N/A (SDK method) ### Parameters None ### Returns - {string} - The current label as an XML string. ``` -------------------------------- ### label.isDLSLabel Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Validates if the current content is a valid DYMO Label Software label based on DYMO Label Software service. ```APIDOC ## [POST] /label.isDLSLabel ### Description Validates if the current content is a valid DYMO Label Software label based on DYMO Label Software service. ### Method POST ### Endpoint /label.isDLSLabel ### Parameters None ### Request Example ```javascript label.isDLSLabel() ``` ### Response #### Success Response (200) - **boolean** (boolean) - True if the label is a valid DYMO Label Software label, false otherwise. #### Response Example ``` true ``` ``` -------------------------------- ### toXml(records) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.LabelSetBuilder.html Static method to convert record objects to XML format. ```APIDOC ## toXml(records) ### Description Static method that converts record objects to XML format. The XML schema is defined in LabelSet.xsd. The returned XML can be passed to `dymo.label.framework.printLabel` as the `labelSetXml` parameter. This function can be used independently of other LabelSetBuilder methods. ### Method `dymo.label.framework.LabelSetBuilder.toXml(records)` ### Parameters - **records** (Array) - Required - An array-like object of associative-arrays with object names as keys and object text as values. ### Returns - **{string}** - An XML string. ### Usage ```javascript var records = [{ "Name": "John", "Address": "123 Main St" }]; var xml = dymo.label.framework.LabelSetBuilder.toXml(records); ``` ``` -------------------------------- ### addRecord() Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.LabelSetBuilder.html Adds a new record to the LabelSet. ```APIDOC ## addRecord() ### Description Adds a new record to the LabelSet and returns the record object for further manipulation. ### Method `addRecord()` ### Returns - **{dymo.label.framework.ILabelSetRecord}** - The newly added record object. ### Usage ```javascript var record = builder.addRecord(); ``` ``` -------------------------------- ### label.isDCDLabel Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/README.md Validates if the current content is a valid DYMO Connect label based on DYMO Connect service. ```APIDOC ## [POST] /label.isDCDLabel ### Description Validates if the current content is a valid DYMO Connect label based on DYMO Connect service. ### Method POST ### Endpoint /label.isDCDLabel ### Parameters None ### Request Example ```javascript label.isDCDLabel() ``` ### Response #### Success Response (200) - **boolean** (boolean) - True if the label is a valid DYMO Connect label, false otherwise. #### Response Example ``` true ``` ``` -------------------------------- ### setObjectText(objectName, text) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Sets the text content for an object. ```APIDOC ## setObjectText(objectName, text) ### Description Sets the text content for an object. ### Method N/A (SDK method) ### Parameters - **objectName** (string) - Required - The name of the object. - **text** (string) - Required - The text to set. ``` -------------------------------- ### setObjectText(objectName, text) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Sets the text content for an object. ```APIDOC ## setObjectText(objectName, text) ### Description Sets the text content for an object. The content and/or text formatting are set differently depending on the object type. ### Method setObjectText ### Parameters - **objectName** (string) - Required - The name of the object. - **text** (string) - Required - The plain text string for new object content. ### Returns - **dymo.label.framework.ILabel** - self ``` -------------------------------- ### setText(objectName, text) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabelSetRecord.html Adds plain text data to the record for a specified object. ```APIDOC ## setText(objectName, text) ### Description Adds data to the record specified as plain text. ### Method setText ### Parameters - **objectName** (string) - Required - The name of the object that the text is set for. - **text** (string) - Required - The object text to set. ### Returns - **{dymo.label.framework.ILabelSetRecord}** - self ``` -------------------------------- ### setTextMarkup(objectName, textMarkup) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabelSetRecord.html Adds text markup data to the record for a specified object. ```APIDOC ## setTextMarkup(objectName, textMarkup) ### Description Adds data to the record specified as text markup. ### Method setTextMarkup ### Parameters - **objectName** (string) - Required - The name of the object that the markup is set for. - **textMarkup** (string) - Required - The markup string. See [TextMarkup.xsd](http://labelwriter.com/software/dls/sdk/TextMarkup.xsd). ### Returns - **{dymo.label.framework.ILabelSetRecord}** - self ``` -------------------------------- ### setBase64Image(objectName, base64Image) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabelSetRecord.html Adds a base64-encoded PNG image to the record for a specified object. ```APIDOC ## setBase64Image(objectName, base64Image) ### Description Adds image data to the record. The image must be a base64-encoded PNG stream. ### Method setBase64Image ### Parameters - **objectName** (string) - Required - The name of the object that the image is set for. - **base64Image** (string) - Required - The string containing the base64-encoded PNG image stream. ### Returns - **{dymo.label.framework.ILabelSetRecord}** - self ``` -------------------------------- ### setAddressText(addressIndex, text) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Sets the text content of an Address object. ```APIDOC ## setAddressText(addressIndex, text) ### Description Sets the text content of an Address object. ### Method N/A (SDK method) ### Parameters - **addressIndex** (number) - Required - The zero-based index of the Address object in a 'virtual' array of all Address objects on the label. - **text** (string) - Required - The text to set. ``` -------------------------------- ### setAddressText(addressIndex, text) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Sets the text content of an Address object. ```APIDOC ## setAddressText(addressIndex, text) ### Description Sets the text content of an Address object. ### Method setAddressText ### Parameters - **addressIndex** (number) - Required - The zero-based index of the Address object in a 'virtual' array of all Address objects on the label. - **text** (string) - Required - The plain text string that contains the content of the Address object. Note: The current text formatting is retained on a line-by-line basis. ### Returns - **dymo.label.framework.ILabel** - self ``` -------------------------------- ### setAddressBarcodePosition(addressIndex, bacodePosition) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Sets the Intelligent Mail barcode position for an Address object. ```APIDOC ## setAddressBarcodePosition(addressIndex, bacodePosition) ### Description Sets the Intelligent Mail barcode position for an Address object. ### Method N/A (SDK method) ### Parameters - **addressIndex** (number) - Required - The zero-based index of the Address object in a 'virtual' array of all Address objects on the label. - **bacodePosition** (dymo.label.framework.AddressBarcodePosition) - Required - The barcode position. ``` -------------------------------- ### setAddressBarcodePosition(addressIndex, bacodePosition) Source: https://github.com/dymosoftware/dymo-connect-framework/blob/master/doc/JavaScript/symbols/dymo.label.framework.ILabel.html Sets the Intelligent Mail barcode position for an Address object. ```APIDOC ## setAddressBarcodePosition(addressIndex, bacodePosition) ### Description Sets the Intelligent Mail barcode position for an Address object. ### Method setAddressBarcodePosition ### Parameters - **addressIndex** (number) - Required - The zero-based index of the Address object in a 'virtual' array of all Address objects on the label. - **bacodePosition** (dymo.label.framework.AddressBarcodePosition) - Required - The barcode position. ### Returns - **dymo.label.framework.ILabel** - self ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.