PrintPDFAction

Prints a PDF document.

For common action properties, see Action .

A YAML reference document is available that provides complete details about the specific properties for each action and describes how to combine actions into groups and create arrays of actions to be sent as one script to the server. The YAML actions reference is provided online at https://help.seagullscientific.com/BarTenderCloud/Actions_YAML_reference/ .

Properties

DocumentFile[get, set]

FileTarget

Specifies the file path of the PDF document.

Currently, only Librarian file system path is supported.

Printer[get, set]

string

Specifies the printer to use for the document print job.

For BarTender Cloud printing, the printer can be either PDF or the internet printer that is shared by the BarTender Print Gateway service. The printer ID must follow these rules:

Copies[get, set]

string

Specifies the number of copies to print. The default value is "1".

JobName[get, set]

string

Specifies the name of the print job. The default value is "", which specifies the document name is used.

PrintResponseVariable[get, set]

string

Specifies the name of the variable to save the print response to. The default value is "Response".

ReturnPrintData[get, set]

bool

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

ReturnPrintSummary[get, set]

bool

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

ReturnLabelData[get, set]

bool

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

<img src="../Resources/Images/ExternalLink-png.png" style="width: 10px;height: 10px;" />[get, set]

bool

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

QueueAndContinue[get, set]

bool

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

Parameters

DocumentFile

Type: FileTarget

Specifies the file system and path of the target file.

Printer

Type: String

Specifies the printer to use for the document print job. Required.

For BarTender Cloud printing, the printer can be either PDF or the internet printer that is shared by the BarTender Print Gateway service. The printer ID must follow these rules:

Use the "printer:" prefix.
Remove the UNC "\\" prefix.
Replace all spaces with underscores.
Replace all backslashes () in the path with slashes (/).

For example, to specify the following printer:

\\mypc.seagullscientific.com\Zebra 110Xi4(300 dpi)

Use the following printer ID:

printer:mypc.seagullscientific.com/Zebra_110Xi4(300_dpi)

Copies

Type: String

Specifies the number of copies of the PDF file to print.

JobName

Type: String

Specifies the name of the print job.

Examples

Actions:

- PrintPDFAction:

DocumentFile: librarian://main/PDFFiles/SampleFile.pdf

Printer: printer:bobpc.corp.seagullscientific.com/Zebra_140

Copies: 1

JobName: SimpleFile

Name: Print PDF Document

# And more common action properties

...