Actions YAML Reference
Loading...
Searching...
No Matches
Properties | List of all members
PrintBTWAction Class Reference

Prints a BarTender document. More...

Inherits PrintActionBase.

Properties

FileTarget DocumentFile [get, set]
 Specifies the file path of the BarTender document.
Currently, only Librarian and Windows file system paths are supported.
 
bool CloseDocumentAfterPrint [get, set]
 Specifies whether to close the document after printing. The default value is false.
 
bool SaveAfterPrint [get, set]
 Specifies whether to save the document after printing. The default value is true.
 
bool SkipGenerateThumbnail [get, set]
 Specifies whether to skip generating a thumbnail preview after printing. Valid only when the value of SaveAfterPrint is true. The default value is true.
 
string Printer [get, set]
 Specifies the printer to use for the document print job. The default value is "", which specifies that the setting in the document is used.
 
string PaperTray [get, set]
 Specifies the paper tray to use for the print job. The default value is "", which specifies that the setting in the document is used.
 
string HorizontalOffset [get, set]
 Specifies the horizontal offset for the print job. The value should include a unit, for example "1.5 mm" or "0.1 in". The default value is "", which specifies that the setting in the document is used.
 
string VerticalOffset [get, set]
 Specifies the vertical offset for the print job. The value should include a unit, for example "2.0 mm" or "0.2 in". The default value is "", which specifies that the setting in the document is used.
 
string Copies [get, set]
 Specifies the number of copies to print per serial number. The default value is "", which specifies that the setting in the document is used.
 
string SerialNumbers [get, set]
 Specifies the number of serialized labels to print. The default value is "", which specifies that the setting in the document is used.
 
string RecordRange [get, set]
 Specifies the range of records to print. The default value is "", which specifies that the setting in the document is used.
 
string JobName [get, set]
 Specifies the name of the print job. The default value is "".
 
bool AllowStaticGraphics [get, set]
 Specifies whether static graphics are allowed. This property depends on the capability of the printer.
 
bool AllowStaticObjects [get, set]
 Specifies whether static objects are allowed. This property depends on the capability of the printer.
 
bool AllowSerialization [get, set]
 Specifies whether serialization is allowed. This property depends on the capability of the printer.
 
bool AllowVariableDataOptimization [get, set]
 Specifies whether variable data optimization is allowed.
 
bool AllowGraphicsCaching [get, set]
 Specifies whether graphics caching is allowed. This property depends on the capability of the printer.
 
bool AllowFormatCaching [get, set]
 Specifies whether template caching is allowed. This property depends on the capability of the printer. The default value is false .
 
bool WarnWhenUsingTrueTypeFonts [get, set]
 Specifies whether a warning message is displayed when TrueType fonts are used. This property depends on the capability of the printer.
 
MediaHandling MediaHandling [get, set]
 Specifies the printer media handling method. This property depends on the capability of the printer.
For more examples, see MediaHandling.
Example: More...
 
List< RecordSetData > DatabaseOverrides [get, set]
 Lists database override settings.
Example in which the TextDB1 database is overridden by TextDB1 from a text file and the TextDB2 database is overridden by TextDB2 from an EventData variable: More...
 
bool VerifyPrintJobIsComplete [get, set]
 Verifies that the print job has been printed before continuing. When the value of QueueAndContinue is true, the value of VerifyPrintJobIsComplete must be false, and vice versa. The default value is false.
The various combinations of QueueAndContinue and VerifyPrintJobIsComplete have the following meanings: More...
 
int PrintJobTimeout [get, set]
 Specifies the amount of time, in milliseconds, that elapses while the print job is verified to be complete before the operation times out. Valid when VerifyPrintJobIsComplete is true. A value of -1 specifies that the operation waits until the print job is complete. The default value is 0.
 
SerializableBinaryStringDictionary NamedDataSources [get, set]
 Specifies a dictionary of named data sources to use to override the values in the document before printing.
Example: More...
 
bool SavePrintedNamedDataSource [get, set]
 Specifies whether named data source values are copied to variables at the end of the print job. The default value is false.
 
string NamedDataSourcePrefix [get, set]
 Specifies the prefix for the variables to which the named data source values are saved. Valid only when the value of SavePrintedNamedDataSource is true. The default value is "".
 
List< QueryPromptData > QueryPrompts [get, set]
 Specifies a list of query prompts for the print job.
Example: More...
 
string PrintResponseVariable [get, set]
 Specifies the name of the variable to save the print response to. The default value is "Response".
 
string PrintToFileNameVariable [get, set]
 Specifies the variable to save the PDF printer output file name to. Available only when the printer is 'PDF' and the value of ReturnPrintData and ReturnPrintSummary are true. The default value is "PrintToFileName".
 
string PrintToFileFileName [get, set]
 Specifies the PDF output file name. Available only when the printer is 'PDF'.
 
FolderTarget PrintToFileFolder [get, set]
 Specifies the folder in which to save the PDF output files. Available only when the printer is 'PDF'.
 
bool MakeUniqueOutputFile [get, set]
 Specifies that the PDF output file name is made unique by adding a serial number. Available only when the printer is 'PDF'.
 
int MaximumRetriesOnFailure [get, set]
 Specifies the maximum number of times to try to resend a failed print job. Valid only when the value of ResendFailedJobs is true. The default value is 1.
 
bool ResendFailedJobs [get, set]
 Specifies whether to resend the print job if it fails. The default value is true.
 
bool ReturnPrintData [get, set]
 Specifies whether print data is included in the response. The default value is false.
 
bool ReturnPrintSummary [get, set]
 Specifies whether the print summary is included in the response. The default value is false.
 
bool ReturnLabelData [get, set]
 Specifies whether label data is included in the response. The default value is false.
 
bool ReturnChecksum [get, set]
 Specifies whether the checksum is included in the response. The default value is false.
 
bool QueueAndContinue [get, set]
 Specifies whether to queue the print request and continue immediately. The default value is false.
 
CommonActionProperties

Describes the common action properties for Actions and ActionGroups.

string Name [get, set]
 Specifies the name. This property cannot be empty and must be unique in the YAML script.
 
string Description [get, set]
 Specifies the description. The default value is "".
 
ActionRunType RunType [get, set]
 Runs the action by using one of the following types: More...
 
bool IgnoreErrors [get, set]
 Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.
 
int FailureRetries [get, set]
 Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.
 
int RetryInterval [get, set]
 Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.
 

Detailed Description

Prints a BarTender document.

For common action properties, see IntegrationAction.
Example:

Actions:
DocumentFile: D:\Temp\ttt.btw
Printer: Zebra 110Xi4(300 dpi)
Copies: 1
Action: PageBreak
Occurrence: AfterEveryRecord
- Name: TextDB
FileTarget: C:\Temp\ttt
- Name: TableDB
Type: VariableName
DataSourceVariableName: CurrentRecord
NamedDS1: 111
NamedDS2: 222
- Name: QueryPrompt1
Value: 111
- Name: QueryPrompt2
Value: 222
Name: Print BTW
# And more common action properties
...
bool ReturnLabelData
Specifies whether label data is included in the response. The default value is false.
Definition: PrintActionBase.Properties.cs:51
bool ReturnPrintData
Specifies whether print data is included in the response. The default value is false.
Definition: PrintActionBase.Properties.cs:35
bool ReturnPrintSummary
Specifies whether the print summary is included in the response. The default value is false.
Definition: PrintActionBase.Properties.cs:43
Prints a BarTender document.
Definition: PrintBTWAction.Properties.cs:58
List< QueryPromptData > QueryPrompts
Specifies a list of query prompts for the print job. Example:
Definition: PrintBTWAction.Properties.cs:452
bool VerifyPrintJobIsComplete
Verifies that the print job has been printed before continuing. When the value of QueueAndContinue is...
Definition: PrintBTWAction.Properties.cs:398
string RecordRange
Specifies the range of records to print. The default value is "", which specifies that the setting in...
Definition: PrintBTWAction.Properties.cs:281
string Printer
Specifies the printer to use for the document print job. The default value is "", which specifies tha...
Definition: PrintBTWAction.Properties.cs:231
string Copies
Specifies the number of copies to print per serial number. The default value is "",...
Definition: PrintBTWAction.Properties.cs:265
MediaHandling MediaHandling
Specifies the printer media handling method. This property depends on the capability of the printer....
Definition: PrintBTWAction.Properties.cs:363
string VerticalOffset
Specifies the vertical offset for the print job. The value should include a unit, for example "2....
Definition: PrintBTWAction.Properties.cs:257
FileTarget DocumentFile
Specifies the file path of the BarTender document. Currently, only Librarian and Windows file system ...
Definition: PrintBTWAction.Properties.cs:188
SerializableBinaryStringDictionary NamedDataSources
Specifies a dictionary of named data sources to use to override the values in the document before pri...
Definition: PrintBTWAction.Properties.cs:419
int PrintJobTimeout
Specifies the amount of time, in milliseconds, that elapses while the print job is verified to be com...
Definition: PrintBTWAction.Properties.cs:407
List< RecordSetData > DatabaseOverrides
Lists database override settings. Example in which the TextDB1 database is overridden by TextDB1 fro...
Definition: PrintBTWAction.Properties.cs:386
string HorizontalOffset
Specifies the horizontal offset for the print job. The value should include a unit,...
Definition: PrintBTWAction.Properties.cs:248
Specifies the file system and path of the target file.
Definition: FileTarget.Properties.cs:73
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:88

Property Documentation

◆ MediaHandling

Specifies the printer media handling method. This property depends on the capability of the printer.
For more examples, see MediaHandling.
Example:

Action: PageBreak
Occurrence: AfterEveryRecord

◆ DatabaseOverrides

List<RecordSetData> DatabaseOverrides
getset

Lists database override settings.
Example in which the TextDB1 database is overridden by TextDB1 from a text file and the TextDB2 database is overridden by TextDB2 from an EventData variable:

- Name: TextDB1
FileTarget: C:\Data\textdb1.txt
- Name: TextDB2
Type: VariableName
DataSourceVariableName: EventData

Example in which the first document database is overridden without specifying a name:

- Type: VariableName
DataSourceVariableName: EventData

◆ VerifyPrintJobIsComplete

bool VerifyPrintJobIsComplete
getset

Verifies that the print job has been printed before continuing. When the value of QueueAndContinue is true, the value of VerifyPrintJobIsComplete must be false, and vice versa. The default value is false.
The various combinations of QueueAndContinue and VerifyPrintJobIsComplete have the following meanings:

  • QueueAndContinue (true), VerifyPrintJobIsComplete (false): Queue the print job and continue immediately.
  • QueueAndContinue (false), VerifyPrintJobIsComplete (false): Verify that the print job has been processed before continuing.
  • QueueAndContinue (false), VerifyPrintJobIsComplete (true): Verify that the print job has been printed before continuing.

◆ NamedDataSources

SerializableBinaryStringDictionary NamedDataSources
getset

Specifies a dictionary of named data sources to use to override the values in the document before printing.
Example:

NamedDS1: 111
NamedDS2: 222

◆ QueryPrompts

List<QueryPromptData> QueryPrompts
getset

Specifies a list of query prompts for the print job.
Example:

- Name: QueryPrompt1
Value: 111
- Name: QueryPrompt2
Value: 222

◆ RunType

ActionRunType RunType
getsetinherited

Runs the action by using one of the following types:

  • Always (default)
  • Never

The documentation for this class was generated from the following file: