Prints a BarTender document by using a combination of command lines and data.
More...
Inherits PrintActionBase.
|
DataTarget | Script [get, set] |
| Specifies the source of the Commander script commands to run. For more examples, see DataTarget. More...
|
|
bool | PromptForDataInput [get, set] |
| Specifies whether the user is prompted 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...
|
|
|
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...
|
|
Prints a BarTender document by using a combination of command lines and data.
For common action properties, see IntegrationAction.
Example:
Actions:
- PrintCommandScriptAction:
# And more common action properties
...
DataTarget Script
Specifies the source of the Commander script commands to run. For more examples, see DataTarget.
Definition: PrintCommandScriptAction.Properties.cs:55
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87
◆ Script
Specifies the source of the Commander script commands to run. For more examples, see DataTarget.
◆ PromptForDataInput
Specifies whether the user is prompted 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
Specifies whether to resend the print job if it fails. The default value is true.
◆ ReturnPrintData
Specifies whether print data is included in the response. The default value is false.
◆ ReturnPrintSummary
Specifies whether the print summary is included in the response. The default value is false.
◆ ReturnLabelData
Specifies whether label data is included in the response. The default value is false.
◆ ReturnChecksum
Specifies whether the checksum is included in the response. The default value is false.
◆ QueueAndContinue
Specifies whether to queue the print request and continue immediately. The default value is false.
◆ Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
◆ Description
Specifies the description. The default value is "".
◆ RunType
Runs the action by using one of the following types:
◆ IgnoreErrors
Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.
◆ FailureRetries
Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.
◆ RetryInterval
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:
- PrintCommandScriptAction.Properties.cs