Description
Job.FormatIDType Property |
Description
Sets and returns whether the format ID in a printer code template (the value of the FormatID property) will be determined by the printer driver or will be set to be either a placeholder for variable data or a constant.
Syntax Job.FormatIDType = BtFormatIdValueType
Where BtFormatIdValueType can be one of the following constants:
btFormatIdConstant: The value of the FormatID property will be treated as a literal; has a value of 0.
btFormatIdFromTemplateField: The value of the FormatID property will be treated as a placeholder that the print system will replace with an actual value; has a value of 1.
btFormatIdSetByDriver: The printer driver will determine at print time the value of the FormatID property; has a value of 2.
btFormatIdNotSupported: The printer driver is unable to make this template tag, and the FormatID property has no effect; has a value of 3.
Requirements
|
Version |
BarTender 7.50 or higher |
|
Edition |
Automation, Enterprise |
VB.NET Example
'Declare a BarTender application variable
Dim btApp As BarTender.Application
'Declare a BarTender document variable
Dim btFormat As BarTender.Format
'Declare a BarTender printer code template variable
Dim btPCT As BarTender.PrinterCodeTemplate
'Declare a BarTender job variable
Dim btJob As BarTender.Job
'Declare a BarTender messages variable to hold all messages
Dim btMessages As BarTender.Messages = Nothing
'Create a new instance of BarTender
btApp = New BarTender.Application
'Set the BarTender application visible
btApp.Visible = True
'Open a BarTender document
btFormat = btApp.Formats.Open("c:\Format1.btw", False, "")
'Set the printer code template variable
btPCT = btFormat.PrinterCodeTemplate
'Set the job variable
btJob = btPCT.Job
'Set the format ID type property
btJob.FormatIdType = BarTender.BtFormatIdValueType.btFormatIdConstant
'Set the format ID property
btJob.FormatId = "StandardShippingLabel"
'Export the printer code template
btPCT.Export("SAPscript-ITF", BarTender.BtPctExportType.btPctExportSeparate, "c:\Printer Code Templates\FormatTemplate.prn", "c:\Printer Code Templates\DataTemplate.prn", btMessages)
'End the BarTender process
btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges)
C# Example
// Declare a BarTender application variable
BarTender.Application btApp;
// Declare a BarTender document variable
BarTender.Format btFormat;
// Declare a BarTender printer code template variable
BarTender.PrinterCodeTemplate btPCT;
// Declare a BarTender job variable
BarTender.Job btJob;
// Declare a BarTender messages variable to hold all messages
BarTender.Messages btMessages;
// Declare an object variable
System.Object obj = null;
// Create a new instance of BarTender
btApp = new BarTender.Application();
// Set the BarTender application visible
btApp.Visible = true;
// Open a BarTender document
btFormat = btApp.Formats.Open("c:\\Format1.btw", false, "");
// Set the printer code template variable
btPCT = btFormat.PrinterCodeTemplate;
// Set the job variable
btJob = btPCT.Job;
// Set the format ID type property
btJob.FormatIdType = BarTender.BtFormatIdValueType.btFormatIdConstant;
// Set the format ID property
btJob.FormatId = "StandardShippingLabel";
// Export the printer code template
btPCT.Export("SAPscript-ITF", BarTender.BtPctExportType.btPctExportSeparate, "c:\\Printer Code Templates\\FormatTemplate.prn", "c:\\Printer Code Templates\\DataTemplate.prn", ref obj);
// Set the messages variable to the object
btMessages = obj as BarTender.Messages;
// End the BarTender process
btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);