Open topic with navigation

Object Response Tag (Label)

ClosedDescription

Returns information about each object in the document.

ClosedSyntax

<Object Name=Value Type=Value DatasourceValue=Value HumanReadableValue=Value HexEncodedValue=Value Subtype=Value>...</Object>

The supported attributes include:

Attribute

Description

Name

Returns the name of the object.

Type

Returns the object type. The available object types include:

  • Text
  • Barcode
  • Picture
  • RFID

DatasourceValue

Returns the text value of the objects on the template when it is printed. It is ignored by Reprint commands.

HumanReadableValue

Returns the human readable characters value, used by the client, created by the data sources and returned with the XML return print data. Produced by barcode objects only.

HexEncodedValue

Returns the hex readable text value, used by the client, created by the data sources (RFID objects only) and returned with the XML return print data.

SubType

Returns the type of barcode used, in a string format. It is only returned for barcode objects.

ClosedChild Elements

The following child element tags are supported:

Tag

Description

SubString

Returns a individual data source.

ClosedParent Tag

<Label>

ClosedExample

<?xml version="1.0" encoding="utf-16"?>

<Response Version="2.0" Name="09232006_103601_Job1" ID="123" AppName="BarTender" AppVersion="9.00" AppVersionId="900" AppVersionMajor="9" AppVersionMinor="00" AppVersionBuild="2345" AppInstancePid="12345" AppInstanceGUID="(5EFC7975-14BC-11CF-9B2B-00AA00573819)">

<User>Administrator</User>

<Server>MyServer</Server>

<Command Name="Cmd1">

<Print GUID="{C87068F8-4972-41F1-A6E8-724381703764}" JobName="MCIJob" ID="1234" JobLastStatus="Sent" JobCompleted="true">

<JobStatus Completed="true">

...

</JobStatus>

<PrintData>

<Summary>

...

</Summary>

<Pages TotalLabels="2" TotalPages="2" MediaHandling="true">

<Page PrintedPageNumber="2" TotalPages="2" Status="Printed" MediaHandlingAction="Pause">

<Label Position="1">

<Object Name="Text 1" Type="Text">

<SubString Position="1" ShareName="Sub-String 1" Type="Screen Data">

<Value>John Doe</Value>

</SubString>

<SubString Position="2" ShareName="Sub-String 2" Type="Date">

<Value>4/24/2007</Value>

</SubString>

</Object>

<Object Name="RFID 1" Type="RFID">

<SubString Position="1" ShareName="RFIDCode" Type="Database">

<Value>30705E30A700004000000001</Value>

</SubString>

</Object>

</Label>

<Label Position="2">

<Object Name="Text 1" Type="Text">

<SubString Position="1" ShareName="Sub-String 1" Type="Screen Data">

<Value>John Doe</Value>

</SubString>

<SubString Position="2" ShareName="Sub-String 2" Type="Date">

<Value>4/24/2007</Value>

</SubString>

</Object>

<Object Name="RFID 1" Type="RFID">

<SubString Position="1" ShareName="RFIDCode" Type="Database">

<Value>30705E30A700004000000002</Value>

</SubString>

</Object>

</Label>

</Page>

</Pages>

</PrintData>

<Message ID="1606" GUID="{8A8E8550-C822-4e84-8713-212793DFD6E1}" Severity="Information" Category="Miscellaneous" Response="OK">

<Text>BarTender successfully sent the print job to the spooler.

Job Name: MyJobName

BarTender Document: Document1.btw

Printer: Datamax H-4212 7.1.4 </Text>

</Message>

</Print>

</Command>

</Response>

ClosedRequirements

BTXML Script version 2.0 (BarTender 9.0 and higher)