DocumentPrintFormat Property

Specifies the print format of the label.

Syntax

 upsfreightship.getDocumentPrintFormat(index, [callback])
 upsfreightship.setDocumentPrintFormat(index,  documentPrintFormat, [callback])

Possible Values

  0 (fpfLaser), 
  1 (fpfThermal)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getDocumentPrintFormat([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setDocumentPrintFormat([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Specifies the print format of the label. Possible values are:

Required when DocumentType is fitLabel. Otherwise it is ignored.

The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

Integer