PrintOptions Class

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Specifies information about how a document is printed.

public sealed class PrintOptions
Public NotInheritable Class PrintOptions
Inheritance:
System.Object
PrintOptions

Constructors

PrintOptions()

Initializes a new instance of the PrintOptions class.

public PrintOptions()
Public Sub New

PrintOptions(Stream)

Initializes a new instance of the PrintOptions class.

public PrintOptions(Stream xmlStream)
Public Sub New(xmlStream As Stream)
Parameters
xmlStream
System.IO.Stream

Initializes a new instance of the PrintOptions class by using an XML stream (that contains a System.Printing.PrintTicket document) that complies with the XML Print Schema.

Properties

CopyCount

Gets or sets the number of copies of the document to print.

public int CopyCount { get; set; }
Public Property CopyCount As Integer
Property Value
System.Int32

The number of copies of the document to print.

Exceptions
System.ArgumentException

Value must be positive.

DocumentName

Gets or sets the name of the printed document in the print queue.

Default value is 'Document'.

public string DocumentName { get; set; }
Public Property DocumentName As String
Property Value
System.String

The name of the printed document in the print queue.

FontSettings

Gets or sets the font-related settings used when printing the document.

If this property is null, then static members of the FontSettings are used to resolve font-related settings.

public FontSettings FontSettings { get; set; }
Public Property FontSettings As FontSettings
Property Value
FontSettings

The font-related settings used when printing the document.

FromPage

Gets or sets the page index of the first page to print.

public int FromPage { get; set; }
Public Property FromPage As Integer
Property Value
System.Int32

The page index of the first page to print.

Remarks

Document pages are zero-indexed meaning that first page in the document has index 0 (zero).

Exceptions
System.ArgumentException

Value cannot be negative.

PagesPerSheet

Gets or sets the number of pages that print on each printed side of a sheet of paper.

public int PagesPerSheet { get; set; }
Public Property PagesPerSheet As Integer
Property Value
System.Int32

The number of pages that print on each printed side of a sheet of paper.

Remarks

Only a limited range of 1, 2, 4, 6, 8 or 16 pages per sheet side are supported.

Exceptions
System.ArgumentException

Value must be 1, 2, 4, 6, 8 or 16.

ToPage

Gets or sets the index of the last page to print.

public int ToPage { get; set; }
Public Property ToPage As Integer
Property Value
System.Int32

The index of the last page to print.

Remarks

Use System.Int32.MaxValue value to print to the last page.

Exceptions
System.ArgumentException

Value cannot be lower than FromPage.

UseAdvancedTextFormatting

Gets or sets a value indicating whether to do text layout using advanced text formatting implementation such as those from Windows Presentation Foundation (WPF) or HarfBuzz text-shaping engine, or to use the default primitive implementation.

Default value is false for improved performance and stability of the output because advanced text formatting is required only for complex scripts or advanced typography features.

public bool UseAdvancedTextFormatting { get; set; }
Public Property UseAdvancedTextFormatting As Boolean
Property Value
System.Boolean

true to do text layout using advanced text formatting implementation; otherwise false to use the default primitive implementation.

Examples