PrintUserParams Class

class PrintUserParams : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

A structure used to set parameters for print jobs.

Two structures provide settings for setting parameters for print jobs, PrintUserParams and PrintParams. PrintUserParams was created first, and then PrintParams was created as an extension of PrintUserParams, to provide more settings to account for changing technology.

When the system seeks to print a document it will pass the content and the print parameters, such as the page size, paper tray, and landscape v. portrait, to the print API in APDFL. If the setting is in PrintParams it will pass the document and parameters to PrintParams and then to PrintUserParams and from there to the print API to complete the printing process.

The print logic may take different code paths depending on whether or not the print content is being sent to a printer or to a file, or if the printing uses PostScript or not. When you see a print setting that appears in both PrintUserParams and PrintParams, such as "ShrinktoFit," set the appropriate value in both of these classes. Also, PrintParams offers a variety of settings related to PostScript, but the use of PrintParams is not limited to PostScript.

Referenced by

Document PrintUserParams

Uses types

Document FarEastFont PrintParams PrintUserParams

Constructor & Destructor Documentation

PrintUserParams()

Constructs a PrintUserParams with default settings.

Initializes the print parameters to default values: paper size set to use the media box, emit to printer enabled, emit to file disabled, and zero copies. On macOS, also initializes the system print session, print settings, and page format.

Property Documentation

int BinaryOK[get, set]

bool Collate[get, set]

string Command[get, set]

string DeviceName[get, set]

int DoOPP[get, set]

string DriverName[get, set]

int EmitHalftones[get, set]

bool EmitToFile[get, set]

bool EmitToPrinter[get, set]

int EndPage[get, set]

FarEastFont FarEastFontOpt[get, set]

string InFileName[get, set]

int NCopies[get, set]

string OutFileName[get, set]

ushort PaperHeight[get, set]

int PaperSource[get, set]

ushort PaperWidth[get, set]

string PortName[get, set]

int PrintAnnots[get, set]

PrintParams PrintParams[get]

int PsLevel[get, set]

int Reverse[get, set]

bool ShrinkToFit[get, set]

int StartPage[get, set]

int StartResult[get, set]

int TransQuality[get, set]

bool UseCustomPaperSize[get, set]

Field Documentation

static UseCropBox

When paper height and width are initialized to this value the crop box of each individual page will be used to determine the paper size.

static UseMediaBox

When paper height and width are initialized to this value the printed product more closely resembles what comes out of most PDF Viewers. This can eliminate some print problems, including PCL blank page problems.

Member Function Documentation

void ChoosePaperSourceBySize(double width, double height)

Parameters

width: double: the desired width of the output in user units
height: double: the desired height of the output in user units

Returns:

void

Choose the best paper source for a given width and height.

Searches the printer's paper list for the smallest paper size that is greater than or equal to the given width and height, including with rotation, and sets up the job to print with that paper size.

To obtain width and height, specify the Right - Left and Top - Bottom of the MediaBox of a representative Page.

The printerName and portName must be set.

If you use this call in conjunction with PosePrintDialog, UseDefaultPrinter, or UpdateFromPrinterSettings, call this function after those functions.

Setting RotateAndCenter to True is recommended with this function.

void Dispose()

Returns:

void

System.Collections.Generic.IList< System.String > EnumeratePaperSources()

Returns:

System.Collections.Generic.IList< System.String >

Set of the tray/bin names.

Enumerates available tray/bin names for the specified printer.

int PaperSourceIdByName(string trayName)

Parameters

trayName: string: the tray/bin's name whose number need to obtain.

Returns:

int

Tray/Bin number corresponding to the specified name.

Obtain tray/bin number by its name.

bool PosePrintDialog(Document doc)

Parameters

doc: Document: a Document which will be used to set the maximum page range in the dialog box.

Returns:

bool

true if the user accepted the dialog box, false if it was cancelled

Set the print parameters by posing a dialog box to the user. The parameters set include the printer, page range, paper size, number of copies, and duplexing mode.

Changes to these parameters made by the user will be copied into the corresponding PrintUserParams fields. If you want to override the user's choices, change these fields after calling PosePrintDialog().

void UpdateFromPrinterSettings(System.Drawing.Printing.PrinterSettings settings)

Parameters

settings: System.Drawing.Printing.PrinterSettings: Printer settings

Returns:

void

Update the PrintUserParams from System.Drawing.Printing.PrinterSettings.

The following items are updated:

startPage

endPage

driverName

deviceName

portName

nCopies

paperWidth

paperHeight

DEVMODE

Use this if you pose the print settings dialog box in your own code.

void UseDefaultPrinter(Document doc)

Parameters

doc: Document: a Document which will be used to set the maximum page range.

Returns:

void

Set the print parameters to the defaults. The parameters set include the printer, page range, paper size, number of copies, and duplexing mode.

Operating system defaults for these parameters will be copied into the corresponding PrintUserParams fields. If you want to override the system defaults, change these fields after calling UseDefaultPrinter().