Description
Description
Enables you to discover the variables (Named Data Sources) available in a BTW file.
Syntax
<GetFormatProperties>
<Format>...</Format>
</GetFormatProperties>
Where ... is replaced with the name and path of the BarTender document.
Child Elements
The following child element tags are supported.
|
Tag |
Required/Optional |
Description |
|---|---|---|
|
Optional |
Sets the BarTender document whose named data sources are exported. If not included, BarTender exports the currently open document. |
Parent Tag
Response
Each time a <GetFormatProperties> command is passed to BarTender, an XML response is generated. This response contains user, server and command information followed by the <GetFormatProperties> command which contains all the returned named data source information.
<?xmlversion="1.0"encoding="utf-16"?>
<ResponseVersion="2.0"AppName="BarTender"AppVersion="2022 R6" AppVersionId="1130" AppVersionMajor="11" AppVersionMinor="30" AppVersionBuild="233295" AppInstancePid="22604"AppInstanceGUID="{A50B0C4A-7307-472B-9533-0AD51B15BA30}">
<User>Administrator</User>
<Server>MyServer</Server>
<CommandName="Job1">
<GetFormatProperties>
...
</GetFormatProperties>
</Command>
</Response>
Remarks
The <GetFormatProperties> tag is the root element encapsulating all format property details. The following tags, returned inside the <GetFormatProperties> tag in a response, provide details about the document data sources.
The <NamedDataSources> section lists named data sources on the template.
The <PrintSetup> section defines the printing parameters for the label format. These settings control the printer selection, number of copies, serialization, and prompting behavior.
The <PageSetup> section configures label layout settings, including label dimensions, margins, and placement.
The <PasswordProtections> section controls access to various functions in the software by requiring a password.
The <DatabaseSetup> section contains database-related settings, including connections and record sets.
Example
<?xmlversion="1.0"encoding="utf-16"?>
<XMLScriptVersion="2.0">
<CommandName="Job1">
<GetFormatProperties>
<Format>Label1.btw</Format>
</GetFormatProperties>
</Command>
</XMLScript>