Class dymo.label.framework.LabelSetBuilder

Class Summary
Constructor Attributes	Constructor Name and Description
	dymo.label.framework.LabelSetBuilder() LabelSetBuilder is used to create a LabelSet to print multiple labels in one print job.

Method Summary
Method Attributes	Method Name and Description
	addRecord() Adds a new record to the LabelSet.
	toString() Converts the builder's content to an XML string suitable to pass to dymo.label.framefork.printLabel.
<static>	dymo.label.framework.LabelSetBuilder.toXml(records) Converts record objects to XML format.

Class Detail

dymo.label.framework.LabelSetBuilder()

LabelSetBuilder is used to create a LabelSet to print multiple labels in one print job. LabelSet is a collection of records. Each record contains multiple pairs; each pair consists of the object name and the object text data/content. The data of each record are applied to all corresponend objects and for each record one label is printed.

Method Detail

{dymo.label.framework.ILabelSetRecord} addRecord()

Adds a new record to the LabelSet. Returns a record object.

Returns:: {dymo.label.framework.ILabelSetRecord}

toString()

Converts the builder's content to an XML string suitable to pass to dymo.label.framefork.printLabel.

<static> {string} dymo.label.framework.LabelSetBuilder.toXml(records)

Converts record objects to XML format. The XML format schema is defined in LabelSet.xsd. Returned XML can be passed to dymo.label.framefork.printLabel as labelSetXml parameter. This function can be used independent of other LabelSetBuilder methods, if records data is generated by other functions.

Parameters:
{Array} records: The records to convert to XML. Records should be an array-like object of associative-arrays with object names as keys and object text as values.

Returns:: {string} An XML string.

Classes

Class dymo.label.framework.LabelSetBuilder