All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::PDF::Print Class Reference

#include <Print.h>

Static Public Member Functions

static void StartPrintJob (PDFDoc &in_pdfdoc, const UString &in_printerName, const UString &in_jobName, const UString &in_outputFileName, PageSet *in_pagesToPrint=NULL, PrinterMode *in_printerMode=NULL, volatile bool *in_cancel=NULL, OCG::Context *in_context=NULL)
 
static void StartPrintJob (PDFDoc &in_pdfdoc, const char *in_printerName, const char *in_jobName, const char *in_outputFileName, PageSet *in_pagesToPrint=NULL, PrinterMode *in_printerMode=NULL, volatile bool *in_cancel=NULL, OCG::Context *in_context=NULL)
 
static void StartPrintJob (PDFDoc &in_pdfdoc, const UString &in_printerName, const UString &in_jobName, const UString &in_outputFileName, const std::vector< UChar > &in_devmode_data, PageSet *in_pagesToPrint=NULL, PrinterMode *in_printerMode=NULL, volatile bool *in_cancel=NULL, OCG::Context *in_context=NULL)
 
static void StartPrintJob (PDFDoc &in_pdfdoc, const char *in_printerName, const char *in_jobName, const char *in_outputFileName, const std::vector< UChar > &in_devmode_data, PageSet *in_pagesToPrint=NULL, PrinterMode *in_printerMode=NULL, volatile bool *in_cancel=NULL, OCG::Context *in_context=NULL)
 

Detailed Description

Definition at line 23 of file Print.h.

Member Function Documentation

static void pdftron::PDF::Print::StartPrintJob ( PDFDoc &  in_pdfdoc,
const UString &  in_printerName,
const UString &  in_jobName,
const UString &  in_outputFileName,
PageSet *  in_pagesToPrint = NULL,
PrinterMode *  in_printerMode = NULL,
volatile bool *  in_cancel = NULL,
OCG::Context *  in_context = NULL 
)
static

(Windows Only) Print the PDFDoc to a printer. Depending on the OS and installed libraries, the PDFDoc will be sent using the GDI or the XPS print path. This function will block until the print job is done at the OS level.

Note
If the printer is grayscale, only grayscale data will be sent.
Parameters
in_pdfdocthe PDFDoc to be printed
in_printerNamethe name of the printer to print to
in_jobNamethe name of the job for print queue monitoring, can be empty.
in_outputFileNameif not empty, the name of the output file to save the printout into. This could be a PostScript, PCL, XPS or other file.
in_pagesToPrinta PageSet specifying which pages to print.
in_printModeoptions for the printer, see the PrinterMode class below.
in_cancelset this to true to cancel the print job.
in_context(Optional) Optional Content Group setting, for example from PDFViewCtrl::GetOCGContext.

Throws a trn::Common::Exception on failure.

static void pdftron::PDF::Print::StartPrintJob ( PDFDoc &  in_pdfdoc,
const char *  in_printerName,
const char *  in_jobName,
const char *  in_outputFileName,
PageSet *  in_pagesToPrint = NULL,
PrinterMode *  in_printerMode = NULL,
volatile bool *  in_cancel = NULL,
OCG::Context *  in_context = NULL 
)
static

(Windows Only) Print the PDFDoc to a printer. Depending on the OS and installed libraries, the PDFDoc will be sent using the GDI or the XPS print path. This function will block until the print job is done at the OS level.

Note
Same functionality as other StartPrintJob but with char * types for printer name, job name, output file name
If the printer is grayscale, only grayscale data will be sent.
Parameters
in_pdfdocthe PDFDoc to be printed
in_printerNamethe name of the printer to print to
in_jobNamethe name of the job for print queue monitoring, can be empty.
in_outputFileNameif not empty, the name of the output file to save the printout into. This could be a PostScript, PCL, XPS or other file.
in_pagesToPrinta PageSet specifying which pages to print.
in_printModeoptions for the printer, see the PrinterMode class below.
in_cancelset this to true to cancel the print job.
in_context(Optional) Optional Content Group setting, for example from PDFViewCtrl::GetOCGContext.

Throws a trn::Common::Exception on failure.

static void pdftron::PDF::Print::StartPrintJob ( PDFDoc &  in_pdfdoc,
const UString &  in_printerName,
const UString &  in_jobName,
const UString &  in_outputFileName,
const std::vector< UChar > &  in_devmode_data,
PageSet *  in_pagesToPrint = NULL,
PrinterMode *  in_printerMode = NULL,
volatile bool *  in_cancel = NULL,
OCG::Context *  in_context = NULL 
)
static

(Windows Only) Print the PDFDoc to a printer. Depending on the OS and installed libraries, the PDFDoc will be sent using the GDI or the XPS print path. This function will block until the print job is done at the OS level.

Note
If the printer is grayscale, only grayscale data will be sent.
Parameters
in_pdfdocthe PDFDoc to be printed
in_printerNamethe name of the printer to print to
in_jobNamethe name of the job for print queue monitoring, can be empty.
in_outputFileNameif not empty, the name of the output file to save the printout into. This could be a PostScript, PCL, XPS or other file.
in_devmode_dataarray of bytes containing the DEVMODEW data for the destination printer. If in_printerMode then some settings from there will be merged in to the devmode. The resulting devmode will be validated by the printer driver, some values may be altered as needed by the printer. For example, the user sets in PrinterMode a paper size that the printer does not support, then the printer will fallback to a default size.
in_pagesToPrinta PageSet specifying which pages to print.
in_printModeoptions for the printer, see the PrinterMode class below.
in_cancelset this to true to cancel the print job.
in_context(Optional) Optional Content Group setting, for example from PDFViewCtrl::GetOCGContext.

Throws a trn::Common::Exception on failure.

static void pdftron::PDF::Print::StartPrintJob ( PDFDoc &  in_pdfdoc,
const char *  in_printerName,
const char *  in_jobName,
const char *  in_outputFileName,
const std::vector< UChar > &  in_devmode_data,
PageSet *  in_pagesToPrint = NULL,
PrinterMode *  in_printerMode = NULL,
volatile bool *  in_cancel = NULL,
OCG::Context *  in_context = NULL 
)
static

(Windows Only) Print the PDFDoc to a printer. Depending on the OS and installed libraries, the PDFDoc will be sent using the GDI or the XPS print path. This function will block until the print job is done at the OS level.

Note
Same functionality as other StartPrintJob but with char * types for printer name, job name, output file name
If the printer is grayscale, only grayscale data will be sent.
Parameters
in_pdfdocthe PDFDoc to be printed
in_printerNamethe name of the printer to print to
in_jobNamethe name of the job for print queue monitoring, can be empty.
in_outputFileNameif not empty, the name of the output file to save the printout into. This could be a PostScript, PCL, XPS or other file.
in_devmode_dataarray of bytes containing the DEVMODEW data for the destination printer. If in_printerMode tdevmode will be validated by the printer driver, some values may be altered as needed by the printer. For example, the user sets in PrinterMode a paper size that the printer does not support, then the printer will fallback to a default size.
in_pagesToPrinta PageSet specifying which pages to print.
in_printModeoptions for the printer, see the PrinterMode class below.
in_cancelset this to true to cancel the print job.
in_context(Optional) Optional Content Group setting, for example from PDFViewCtrl::GetOCGContext.

Throws a trn::Common::Exception on failure.


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