GetFormatProperties Response Tag

The <NamedDataSources> section of the response contains the named data sources on the template.

<DataSource> identifies a named data source.

Attribute:

ID: The identifier for the named data source.

Name: The name for the named data source.

<Value> contains the value of the named data source.

<Forms/> indicates whether forms are enabled and contain input controls capable of linking to a data source such as Template Fields, Query Prompts, or Printers.

Attributes:

Enabled: Indicates that forms are enabled. This field uses a Boolean value. If the value is false the <Forms/> tag is omitted entirely.

<NamedDataSources> lists the named data sources on the template.

Attributes:

ID: A unique internal identifier.

Name: The name of the data source.

Although not an attribute, this tag always holds its default value in a nested <Value> tag.

The <PrintSetup> section defines the printing parameters for the label format. These settings control the printer selection, number of copies, serialization, and prompting behavior.

<PrinterName> specifies the name of the printer to be used for printing the labels.

<PrinterNameSource> indicates the source of the printer name, such as a data entry form.

<AutoPrintAgain> determines whether the label should automatically print again after the previous job completes (true or false).

<EnablePrompting> defines whether the user should be prompted with the Record Picker before printing (true or false).

<SupportsIdenticalCopies> indicates whether the printer supports identical copies of a label (true or false).

<IdenticalCopiesOfLabel> specifies the number of identical copies to print.

<SupportsSerializedLabels> determines whether serialization (incrementing label data) is supported. The format does not support serialized labels if the value of the serialized labels is data sourced, or if there are no substrings set to serialize on the label.

<HasSerializationSetByDataSource> indicates whether serialization is set dynamically from a data source.

<NumberOfSerializedLabels> specifies the total number of serialized labels to print on the page.

<StartingPosition> indicates the starting position of the first label on the page.

<PromptForStartingPosition> determines whether the user is prompted to select a starting position.

<StartingPositionRow> specifies the row index of the page where printing should begin.

<StartingPositionCol> specifies the column index of the page where printing should begin.

<StartingPositionUsesRowColumn> indicates whether the starting position uses row and column values (true or false).

The <PageSetup> section configures label layout settings, including label dimensions, margins, and placement.

<LabelRows> defines the number of label rows per printed page.

<LabelColumns> defines the number of label columns per printed page.

<RulerUnits> specifies the measurement units for the label dimensions (e.g., Inches).

<PaperWidth> defines the width of the page/paper sheet in multiple units (Mils, Millimeters, Centimeters, Inches).

<PaperHeight> defines the height of the page/paper sheet in multiple units (Mils, Millimeters, Centimeters, Inches).

<MarginTop>, <MarginBottom>, <MarginLeft>, and <MarginRight> define the margins around the label area in multiple units (Mils, Millimeters, Centimeters, Inches).

<LabelShape> specifies the shape of the label (e.g., Rectangle).

<LabelCorners> defines the corner shape of the label (SquareCorners or RoundCorners).

<StartingCorner> determines the starting corner on a page with multiple rows and/or columns.

<StartingPositionDirection> defines whether the label numbering moves horizontally or vertically.

<StartingPositionSelectionMethods> specifies how the starting position is determined (LabelNumber or RowColumn).

The <PasswordProtections> section controls access to various functions in the software by requiring a password.

<OpenDocument> determines whether a password is required to open the document (true or false).

<SaveDocument> controls whether the document can be saved without a password.

<SaveCopyOfDocument> defines if saving a copy of the document requires a password.

<Print> specifies whether a password is required to print the document.

<ModifyTemplateDesign> controls whether modifying the label design requires a password.

<ModifyProtectedVBScript> determines whether password protection applies to editing VBScript in the template.

<ModifyPrintDialogOptions> specifies if modifying print dialog settings is restricted by a password.

<ModifyPageSetup> controls whether page setup modifications require a password.

<ModifyDatabaseSetup> determines whether modifying database connections requires authentication.

<ModifyLayers> specifies whether editing layers in the document requires a password.

<PasswordHint> is an optional field to store a password hint for users.

The <DatabaseSetup> section of the response contains database-related settings, such as connections and record sets.

<DatabaseConnections> lists all database connections directly connected to the label.

<DatabaseConnection> contains the database connection string.

Attributes:

Name: The identifier for the connection.

Type: Indicates the type of database (e.g., ExcelOnline, MySQL).

<RecordSets> lists all record sets from the database connections.

<MultiRecordSet> lists record sets and their relationships to each other for multi-database joins. While always the child of <RecordSets> tag, it also contains a nested <RecordSets> tag along with the <Joins> tag.

Attributes:

Name: The name of the record set.

Primary: Indicates whether this is the primary record set.

<Joins> Contains join conditions between record sets.

<Join> Specifies a single join condition.

Attributes:

Type: Specifies the join type (e.g., Inner, Outer).

<RecordSet> lists the record set details, including the query string, fields, and use on the label.

Attributes:

Name: The name of the record set.

Connection: References the associated database connection. Note that in the case of a named (shared) database connection, this is the only reference since the <DatabaseConnections> section is removed.

SharedConnectionID: The cloud implementation of the named database connection that is not yet implemented (only added to cloud BTWs).

Primary: Indicates whether this is the primary record set.

Type: The database connection provider type. This can have internal type like ExcelCData.

FrontEndType: The internal database connection provider type used to distinguish connection types that use the same provider type in BarTender (only added to cloud BTWs).

<SelectCommand> provides the SQL-like command used to retrieve data.

<ProviderParameters> is used for additional provider-specific parameters.

<LastKnownSchema> contains schema details as determined by the last successful data retrieval.

<Field> defines a field in the schema with attributes such as Name, Type, and, optionally, Used.

Attributes:

Name: The fully qualified field name from recordset schema (“[recordset].[table].[column]”).

Type: The .NET Type conversion from the database provider specific type (e.g., String, DateTime).

SAPIDoc.Concatenation: The SAP IDoc database connection configuration rule.

Used: Indicates the field is used in the label.

<Alias> defines alias for components in a fully qualified field name (recordset, table, or column).

Attributes:

Name: The alias identifier for Target.

Target:The real/original identifier for Name.

Type: The fully qualified field name component type (e.g., Field, Table).

<FilterVariables> lists variables used to filter these records.

<FilterVariable> defines a single filter variable.

Attributes:

Name:The filter variable's name.

SourceType: Indicates how the filter variable value will be determined (QueryPriompt or NamedDataSource)

DefaultValue: Default value if none is entered.

<FeatureNotCompatibleInSaaS> indicates the document has a feature that is incompatible with Seagull's cloud products.