Interface IPrintSetup

Interface that represents list of settings for printing a Excel file.

Namespace: IronXL.Printing
Assembly: IronXL.dll
Syntax
public interface IPrintSetup

When a spreadsheet needs to print the way it does in Excel, fitted to a page, in the right orientation, and at a chosen scale, IPrintSetup carries those settings. A developer uses it to control how a worksheet renders on paper or to a print-ready PDF: paper size, portrait or landscape, page scaling, margins, and the print quality fields that govern resolution and color. It is the contract behind the Page Setup dialog, exposed so that a generated workbook prints correctly without a person opening the file and adjusting it by hand. Each worksheet carries its own print setup, so multi-sheet workbooks can print each tab differently.

A developer reaches an IPrintSetup through the worksheet: WorkSheet.PrintSetup returns the instance for that sheet. There is no constructor, because the print configuration belongs to the worksheet and is edited in place. Settings written through it are stored with the sheet and applied whenever the workbook is printed or exported, so the usual flow loads or builds a WorkSheet, adjusts its PrintSetup, and saves.

The most-used members shape the printed page. PaperSize and PrintOrientation set the sheet and direction, while Scale adjusts print size and FitWidth and FitHeight constrain the content to a number of pages across and down. HeaderMargin and FooterMargin position the running header and footer, Copies and PageStart control the print run, and LeftToRight sets page ordering. The quality and rendering fields, namely HResolution, VResolution, Draft, NoColor, Notes, and UsePage, tune output for fast proofs or grayscale printing. Set PaperSize and PrintOrientation first, then fit-to-page if the content overflows.

IPrintSetup printSetup = sheet.PrintSetup;
printSetup.PaperSize = PaperSize.A4;
printSetup.FitWidth = 1;

The Excel print setup example configures a sheet for printing, covering paper size, orientation, and fit-to-page, the WorkSheet reference documents the PrintSetup property that returns it, and the PaperSize reference lists every supported sheet size.

Properties

Copies

Returns the number of copies to print.

Declaration
short Copies { get; set; }
Property Value
Type Description
System.Int16

Draft

Returns the draft mode.

Declaration
bool Draft { get; set; }
Property Value
Type Description
System.Boolean

FitHeight

Returns the number of pages high to fit the sheet in to.

Declaration
short FitHeight { get; set; }
Property Value
Type Description
System.Int16

FitWidth

Returns the number of pages wide to fit sheet in to.

Declaration
short FitWidth { get; set; }
Property Value
Type Description
System.Int16

FooterMargin

Returns the footer margin.

Declaration
double FooterMargin { get; set; }
Property Value
Type Description
System.Double

HeaderMargin

Returns the header margin.

Declaration
double HeaderMargin { get; set; }
Property Value
Type Description
System.Double

HResolution

Returns the horizontal resolution.

Declaration
short HResolution { get; set; }
Property Value
Type Description
System.Int16

LeftToRight

Returns the left to right print order.

Declaration
bool LeftToRight { get; set; }
Property Value
Type Description
System.Boolean

NoColor

Returns the black and white Setting.

Declaration
bool NoColor { get; set; }
Property Value
Type Description
System.Boolean

Notes

Returns the print notes.

Declaration
bool Notes { get; set; }
Property Value
Type Description
System.Boolean

PageStart

Returns the page start.

Declaration
short PageStart { get; set; }
Property Value
Type Description
System.Int16

PaperSize

Gets or sets the size of the paper.

Declaration
PaperSize PaperSize { get; set; }
Property Value
Type Description
PaperSize

PrintOrientation

Returns the print orientation.

Declaration
PrintOrientation PrintOrientation { get; set; }
Property Value
Type Description
PrintOrientation

Scale

Returns the scale.

Declaration
short Scale { get; set; }
Property Value
Type Description
System.Int16

UsePage

Returns the use page numbers.

Declaration
bool UsePage { get; set; }
Property Value
Type Description
System.Boolean

VResolution

Returns the vertical resolution.

Declaration
short VResolution { get; set; }
Property Value
Type Description
System.Int16