PrinterMetaData XML block components

The plugin returns a PrinterMetaData XML block in the formats parameter of the EnumerateFormats method. VWorks software passes a PrinterMetaData XML block into the labelxml parameter of the Print and PrintAndApply methods. The following table lists the XML components that are contained in this XML block for each method. The elements and attributes are described in the sections that follow. You can click an element name to jump to the appropriate section.

 

	Method name
Element name Attribute name	EnumerateFormats	Print	PrintAndApply
PrinterMetaData	✓	✓	✓
PrinterFormatMetaData (parent)	✓	✓	✓
PrinterFormatMetaData (child)	✓	✓	✓
Name	✓	✓	✓
Side		✓	✓
PrinterFieldMetaData (parent)	✓	✓	✓
PrinterFieldMetaData (child)	✓	✓	✓
Name	✓	✓	✓
Value		✓	✓

PrinterMetaData element

The PrinterMetaData element contains one PrinterFormatMetaData parent element.

PrinterFormatMetaData element (parent)

For the EnumerateFormats method, the PrinterFormatMetaData parent element contains one or more PrinterFormatMetaData child elements.

For the Print and PrintAndApply methods, the PrinterFormatMetaData parent element contains one PrinterFormatMetaData child element.

PrinterFormatMetaData element (child)

The PrinterFormatMetaData child element contains one PrinterFieldMetaData parent element and has the following attributes:

 

Name	Value
Name	The label format name.
Side	For the Print method, the value No Apply. For the PrintAndApply method, the side of the labware on which to apply the label. Possible values: • North • South • East • West

PrinterFieldMetaData element (parent)

The PrinterFieldMetaData parent element contains one or more PrinterFieldMetaData child elements.

PrinterFieldMetaData element (child)

The PrinterFieldMetaData child element has the following attributes:

 

Name	Value
Name	The field name.
Value	The contents of the field, for example, barcode, date, time, or other static text. If no Value attributes are specified, the plugin will not print anything.