PrintOptions Class

Namespace:
GemBox.Spreadsheet
Assembly:
GemBox.Spreadsheet.dll

Specifies information about how a spreadsheet 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(MemoryStream)

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

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

An XML stream that describes a print job and conforms to the Print Schema.

Exceptions
System.ArgumentNullException

xmlStream is null.

See Also
System.Printing.PrintTicket
System.Printing.PrintTicket.GetXmlStream

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

DocumentName

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

Default value is 'Spreadsheet'.

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

The name of the printed document in the print queue.

ExtendedOptions

Gets the extended save options that are not natively supported by spreadsheet formats.

public ExtendedSaveOptions ExtendedOptions { get; }
Public ReadOnly Property ExtendedOptions As ExtendedSaveOptions
Property Value
ExtendedSaveOptions

Extended save options that are not natively supported by spreadsheet formats.

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
Remarks

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

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
Remarks

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

SelectionType

Gets or sets a value indicating whether to save the whole ExcelFile or just ActiveWorksheet.

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

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
Remarks

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

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