DocumentLabelsPerPage Property
This specifies the number of labels per page in the returned label file.
Syntax
upsfreightship.getDocumentLabelsPerPage(index, [callback]) upsfreightship.setDocumentLabelsPerPage(index, documentLabelsPerPage, [callback])
Possible Values
0 (flppOne), 1 (flppTwo), 2 (flppFour)
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 getDocumentLabelsPerPage([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 setDocumentLabelsPerPage([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
This specifies the number of labels per page in the returned label file. Possible values are:
flppOne (0) | |
flppTwo (1) | |
flppFour (2) |
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