Actions YAML Reference
Properties | List of all members
BarTenderCommandLineAction Class Reference

Prints a BarTender document by using the command-line interface.
More...

Inherits PrintActionBase.

Properties

ActionTextEncoding DatabaseFileEncoding [get, set]
 Specifies the text encoding scheme to use when the database text file is read. The default value is WindowsDefault. For more options, see ActionTextEncoding. More...
 
DataTarget CommandLine [get, set]
 Specifies the command-line parameters. More...
 
string CommandResponseVariable [get, set]
 Places the response into a variable. The default value is "Response". More...
 
string CommandPrintToFileNameVariable [get, set]
 Places the output file name into a variable. The default value is "PrintToFileName". More...
 
bool PromptForDataInput [get, set]
 Specifies whether the print job requires a prompt for data input. The default value is false. More...
 
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. More...
 
bool ResendFailedJobs [get, set]
 Specifies whether to resend the print job if it fails. The default value is true. More...
 
bool ReturnPrintData [get, set]
 Specifies whether print data is included in the response. The default value is false. More...
 
bool ReturnPrintSummary [get, set]
 Specifies whether the print summary is included in the response. The default value is false. More...
 
bool ReturnLabelData [get, set]
 Specifies whether label data is included in the response. The default value is false. More...
 
bool ReturnChecksum [get, set]
 Specifies whether the checksum is included in the response. The default value is false. More...
 
bool QueueAndContinue [get, set]
 Specifies whether to queue the print request and continue immediately. The default value is false. More...
 
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. More...
 
string Description [get, set]
 Specifies the description. The default value is "". More...
 
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. More...
 
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. More...
 
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. More...
 

Detailed Description

Prints a BarTender document by using the command-line interface.

For common action properties, see PrintActionBase and IntegrationAction.
Example:

Actions:
- BarTenderCommandLineAction:
Name: BarTender Command Line
CommandLine: /AF="C:\MyLabelFiles\UPS_Domestic.btw" /P /C=3 /Close
CommandResponseVariable: PrintResponse
# The following are common print action properties:
# And more common action properties
...
bool PromptForDataInput
Specifies whether the print job requires a prompt for data input. The default value is false.
Definition: BarTenderCommandLineAction.Properties.cs:103
string CommandPrintToFileNameVariable
Places the output file name into a variable. The default value is "PrintToFileName".
Definition: BarTenderCommandLineAction.Properties.cs:96
string CommandResponseVariable
Places the response into a variable. The default value is "Response".
Definition: BarTenderCommandLineAction.Properties.cs:89
DataTarget CommandLine
Specifies the command-line parameters.
Definition: BarTenderCommandLineAction.Properties.cs:82
bool ReturnChecksum
Specifies whether the checksum is included in the response. The default value is false.
Definition: PrintActionBase.Properties.cs:59
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 QueueAndContinue
Specifies whether to queue the print request and continue immediately. The default value is false.
Definition: PrintActionBase.Properties.cs:67
bool ReturnPrintSummary
Specifies whether the print summary is included in the response. The default value is false.
Definition: PrintActionBase.Properties.cs:43
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87
Definition: ActionConditionExpression.cs:11

Property Documentation

◆ DatabaseFileEncoding

ActionTextEncoding DatabaseFileEncoding
getset

Specifies the text encoding scheme to use when the database text file is read. The default value is WindowsDefault. For more options, see ActionTextEncoding.


◆ CommandLine

DataTarget CommandLine
getset

Specifies the command-line parameters.

Example:

CommandLine: /AF="C:\MyLabelFiles\UPS_Domestic.btw" /P /C=3

◆ CommandResponseVariable

string CommandResponseVariable
getset

Places the response into a variable. The default value is "Response".

◆ CommandPrintToFileNameVariable

string CommandPrintToFileNameVariable
getset

Places the output file name into a variable. The default value is "PrintToFileName".

◆ PromptForDataInput

bool PromptForDataInput
getset

Specifies whether the print job requires a prompt for data input. The default value is false.

◆ MaximumRetriesOnFailure

int MaximumRetriesOnFailure
getset

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.

◆ ResendFailedJobs

bool ResendFailedJobs
getset

Specifies whether to resend the print job if it fails. The default value is true.

◆ ReturnPrintData

bool ReturnPrintData
getsetinherited

Specifies whether print data is included in the response. The default value is false.

◆ ReturnPrintSummary

bool ReturnPrintSummary
getsetinherited

Specifies whether the print summary is included in the response. The default value is false.

◆ ReturnLabelData

bool ReturnLabelData
getsetinherited

Specifies whether label data is included in the response. The default value is false.

◆ ReturnChecksum

bool ReturnChecksum
getsetinherited

Specifies whether the checksum is included in the response. The default value is false.

◆ QueueAndContinue

bool QueueAndContinue
getsetinherited

Specifies whether to queue the print request and continue immediately. The default value is false.

◆ Name

string Name
getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

◆ Description

string Description
getsetinherited

Specifies the description. The default value is "".

◆ RunType

ActionRunType RunType
getsetinherited

Runs the action by using one of the following types:

  • Always (default)
  • Never

◆ IgnoreErrors

bool IgnoreErrors
getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

◆ FailureRetries

int FailureRetries
getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

◆ RetryInterval

int RetryInterval
getsetinherited

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.


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