V4 V5

Note: In V4, printing and page breaks are available in the WinForms edition.

Auto Paging

When a worksheet is to be printed, ReoGrid performs paging automatically. The paging operation scans the worksheet and determines the print range for each page according to the paging settings. For example, the following image shows a worksheet that has been paged vertically.

108

Like Excel, ReoGrid finds the maximum number of cells that will fit on each page. Any cells that cannot be printed entirely are moved to the next page, as shown below:

109

Perform auto paging or reset page breaks

To perform auto paging or reset the current page breaks at any time:

sheet.AutoSplitPage();

Note: This method reads the paper size from PrintSettings, so it runs very quickly (< 10 ms).

Show page break lines

To show page break lines on screen:

sheet.EnableSettings(WorksheetSettings.View_ShowPageBreaks);

Result: 120

Auto-check printable boundary

If no printable range is specified, ReoGrid will automatically find the used range of cells and set it as the printable range.

121

Change printable range

Use the PrintableRange property of the worksheet to change the printable range.

sheet.PrintableRange = new RangePosition(1, 1, 9, 9);

122

If the printable range is larger than the paper size, it will be split automatically. Cells outside the printable range will not be printed.

Change paging order

Use the PrintSettings.PageOrder property to change the paging direction.

112

sheet.PrintSettings.PageOrder = PrintPageOrder.DownThenOver;

Change page settings

Use the PrintSettings property of the worksheet to change paper settings.

// change page to landscape
sheet.PrintSettings.Landscape = true;

// set page margins
sheet.PrintSettings.Margins = new PageMargins(0.5f);

Example: Auto paging to landscape

123

You can set the print scaling using the PageScaling property of PrintSettings.

sheet.PrintSettings.PageScaling = 0.7f;    // scale to 70%

Note: After changing PageScaling, call AutoSplitPage() to recalculate the page breaks.

Fit to pages

Since v4.6, FitToPage shrinks the printable range so that it fits into FitToPagesWide × FitToPagesTall pages, like Excel’s Fit to option. Both counts default to 1, so turning FitToPage on alone fits the sheet on one page. Set a count to 0 to leave that direction unconstrained.

// Fit the whole sheet on one page
sheet.PrintSettings.FitToPage = true;
sheet.AutoSplitPage();

// One page wide, as many pages tall as needed
sheet.PrintSettings.FitToPage = true;
sheet.PrintSettings.FitToPagesWide = 1;
sheet.PrintSettings.FitToPagesTall = 0;
sheet.AutoSplitPage();

While FitToPage is on, AutoSplitPage decides PageScaling. It only ever shrinks — a sheet that already fits prints at 100% — and, as in Excel, it ignores manual page breaks.

Center on the page

Since v4.6, the content of each page can be centered between the margins:

sheet.PrintSettings.CenterHorizontally = true;
sheet.PrintSettings.CenterVertically = true;

Fit to pages and centering apply to printing, print preview and PDF export.

Since v4.6, printed pages (WinForms print and print preview) and exported PDF pages carry the worksheet’s header and footer. Set them through Worksheet.HeaderFooter, using Excel’s format codes:

// "Monthly report" on the left, "Page 2 of 5" on the right
sheet.HeaderFooter.OddHeader = "&LMonthly report&RPage &P of &N";

// the sheet name, centered
sheet.HeaderFooter.OddFooter = "&C&A";
CodePrints
&L / &C / &RStarts the left / center / right section
&PPage number within the worksheet
&NTotal pages of the worksheet
&DCurrent date
&TCurrent time
&ASheet name
&&A literal &

OddHeader and OddFooter are used on every page unless one of the following is turned on:

// a different header and footer on the first page
sheet.HeaderFooter.DifferentFirst = true;
sheet.HeaderFooter.FirstHeader = "&CQuarterly sales report";

// different headers and footers on odd and even pages
sheet.HeaderFooter.DifferentOddEven = true;
sheet.HeaderFooter.EvenFooter = "&LPage &P";
sheet.HeaderFooter.OddFooter = "&RPage &P";

The distance from the paper edge to the header and footer is set in inches (0.3 by default, as in Excel):

sheet.PrintSettings.HeaderMargin = 0.5f;
sheet.PrintSettings.FooterMargin = 0.5f;

ScaleWithDocument (the header and footer follow PageScaling) and AlignWithMargins are honored too; both default to true.

The header and footer print on one line in the sheet’s default font, in black. Excel’s font, size and color codes inside the text are skipped, pictures (&G) are not printed, and the file name codes (&F, &Z) print nothing.

Page setup in Excel files

Since v4.6, the page setup of an XLSX file is read and saved: paper size, orientation, page scale, fit to pages, page order, centering, printed grid lines, the print area, page margins, and the header and footer. A workbook laid out for printing in Excel prints from your application the way it was designed.

This applies to the WinForms edition. Paper sizes Letter, Tabloid, Ledger, Legal, Executive, A3, A4, A5, JIS B4 and JIS B5 are recognized. A print area with several ranges keeps its first range. Manual page breaks are read but not saved.

Insert a page break

To insert a page break, use the RowPageBreaks and ColumnPageBreaks properties of the worksheet:

// insert page break
sheet.ColumnPageBreaks.Add(5);

Spreadsheet is split into two pages:

124

User page breaks and system page breaks

There are two types of page breaks: solid lines are user page breaks and the edges of the printable range, set through RowPageBreaks, ColumnPageBreaks, the Change…PageBreak methods or the mouse; dashed lines are automatic breaks calculated by AutoSplitPage to split the worksheet into multiple pages.

125

Change page breaks

To change or move a page break index (whether a user or system page break), use the following methods:

void sheet.ChangeColumnPageBreak(int oldIndex, int newIndex);
void sheet.ChangeRowPageBreak(int oldIndex, int newIndex);

Once a page break is changed, it becomes a user page break and will no longer be updated automatically by ReoGrid.

Iterate pages

The IteratePrintPages method of the worksheet is used to iterate over all print pages. This method returns the range position for each page:

sheet.IteratePrintPages( range => {
  Console.WriteLine("Page range is: " + range.ToAddress());
  return true;
});

The output is printed as follows:

Page range is: A1:E11
Page range is: F1:K11

It is also possible to iterate pages in a specified order:

sheet.IteratePrintPages(PrintPageOrder.OverThenDown, range => { ... });

If no paging order is specified, DownThenOver is used, regardless of the print settings.

Disable end-user changing/adjusting the page breaks

To prevent the end-user from changing the page break index with the mouse, set the worksheet setting:

sheet.SetSettings(WorksheetSettings.Behavior_AllowUserChangingPageBreaks, false);

A print session is used to print an entire workbook or specified worksheets. To print an entire workbook or multiple worksheets, create a print session from the workbook instance (the control). To print a single worksheet, create a print session from that worksheet.

263

var session = worksheet.CreatePrintSession();
session.Print();
var session = reoGridControl.CreatePrintSession();
session.Print();
var session = grid.Worksheets["Sheet1"].CreatePrintSession();
session.Worksheets.Add(grid.Worksheets["Sheet3"]);
session.Print();

The following code shows a standard .NET print preview dialog:

var sheet = reoGridControl.CurrentWorksheet;

using (var session = sheet.CreatePrintSession())
{
  using (PrintPreviewDialog ppd = new PrintPreviewDialog())
  {
    ppd.Document = session.PrintDocument;
    ppd.SetBounds(200, 200, 1024, 768);
    ppd.PrintPreviewControl.Zoom = 1d;
    ppd.ShowDialog(this);
  }
}

Print

The following code prints the worksheet using the default print settings.

var session = sheet.CreatePrintSession();
session.Print();

The following code shows a standard print dialog and then prints the specified worksheet.

System.Drawing.Printing.PrintDocument doc = null;

try
{
  doc = worksheet.CreatePrintSession().PrintDocument;
}
catch (Exception ex)
{
  MessageBox.Show(this, ex.Message, this.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Information);
  return;
}

using (var pd = new System.Windows.Forms.PrintDialog())
{
  pd.Document = doc;
  pd.UseEXDialog = true;  // in 64bit Windows

  if (pd.ShowDialog() == System.Windows.Forms.DialogResult.OK)
  {
    doc.PrinterSettings = pd.PrinterSettings;
    doc.Print();
  }
}

if (doc != null) doc.Dispose();

Show system page settings dialog

using (PageSetupDialog psd = new PageSetupDialog())
{
  // transform ReoGrid page settings to System page settings
  psd.PageSettings = worksheet.PrintSettings.CreateSystemPageSettings();

  psd.AllowMargins = true;
  psd.AllowPrinter = true;
  psd.AllowPaper = true;
  psd.EnableMetric = true;

  if (psd.ShowDialog() == System.Windows.Forms.DialogResult.OK)
  {
    // transform System page settings to ReoGrid page settings
    worksheet.PrintSettings.ApplySystemPageSettings(psd.PageSettings);
  }
}

Select printer programmatically

To send output directly to a specific printer without showing a dialog, set PrinterName on the session’s PrintDocument.

var session = sheet.CreatePrintSession();
session.PrintDocument.PrinterSettings.PrinterName = "Microsoft Print to PDF";
session.Print();

Export to PDF

To write the pages to a PDF file without a printer, use PDFExporter (v4.6, WinForms). The PDF is paginated exactly as described on this page. See Export as PDF.

By default, grid lines are not printed. Set ShowGridLines to true to include them in the printed output.

sheet.PrintSettings.ShowGridLines = true;

Show margin indicators

When ShowMargins is true, margin boundary marks are drawn at the edges of each printed page (visible in print preview and in the printed output).

sheet.PrintSettings.ShowMargins = true;

Set paper size

Set PaperName together with PaperWidth and PaperHeight. PaperName alone does not change the page size; the dimensions of the predefined paper sizes are available from PaperManager.PaperSizesInch.

Common values: "A3", "A4", "A5", "Letter", "Legal", "Ledger", "B4", "B5", "JIS_B4", "JIS_B5".

var a4 = PaperManager.PaperSizesInch["A4"];
sheet.PrintSettings.PaperName   = "A4";
sheet.PrintSettings.PaperWidth  = a4.Width;
sheet.PrintSettings.PaperHeight = a4.Height;

For a custom size, specify the dimensions directly:

sheet.PrintSettings.PaperName   = "Custom";
sheet.PrintSettings.PaperWidth  = 6.0f;   // inches
sheet.PrintSettings.PaperHeight = 9.0f;   // inches

All sizes are in inches. The Landscape flag swaps width and height automatically when computing the printable area.

Available paper sizes

CategoryNames
ISO A seriesA0 – A8
ISO B seriesB0 – B10
ISO C seriesC2 – C6
JIS B seriesJIS_B0 – JIS_B12
North AmericanLetter, Legal, Ledger, Tabloid, Executive
ANSIANSI_C, ANSI_D, ANSI_E
OtherD0, SRA0 – SRA4, RA0 – RA2, Custom

Set page margins

PageMargins stores four independent margin values in inches. Use the single-value constructor to set all four sides at once, or the four-value constructor for independent control.

// All four margins = 1 inch
sheet.PrintSettings.Margins = new PageMargins(1f);

// Top=0.5, Bottom=0.5, Left=1, Right=1 (inches)
sheet.PrintSettings.Margins = new PageMargins(0.5f, 0.5f, 1f, 1f);

// Adjust individual sides
var m = sheet.PrintSettings.Margins;
m.Left  = 0.75f;
m.Right = 0.75f;
sheet.PrintSettings.Margins = m;

// Remove all margins
sheet.PrintSettings.Margins = PageMargins.Empty;

Reset all page breaks

Call ResetAllPageBreaks() to clear all user-defined breaks and re-run auto paging from scratch.

sheet.ResetAllPageBreaks();

This is equivalent to clearing PrintableRange, removing all entries from RowPageBreaks and ColumnPageBreaks, and calling AutoSplitPage().

PrintableRange changed event

Subscribe to PrintableRangeChanged to be notified whenever the printable range changes.

sheet.PrintableRangeChanged += (s, e) =>
{
    Console.WriteLine("Printable range: " + sheet.PrintableRange.ToAddress());
};

PrintSettings property reference

PropertyTypeDefaultDescription
PrinterNamestringnullNot applied to the output. Set PrinterName on the session’s PrintDocument instead.
PaperNamestring"Letter"Paper size name (key from PaperManager.PaperSizesInch).
PaperWidthfloat8.5fPaper width in inches.
PaperHeightfloat11fPaper height in inches.
Landscapeboolfalsetrue for landscape orientation.
MarginsPageMarginsnew PageMargins(1f)Page margins in inches.
PageOrderPrintPageOrderDownThenOverPage order: DownThenOver or OverThenDown.
PageScalingfloat1fScale factor (0.1 – 4.0). 1f = 100%.
ShowGridLinesboolfalsePrint cell grid lines.
ShowMarginsboolfalseDraw margin boundary marks on pages.
HeaderMarginfloat0.3fDistance from the top edge of the paper to the header, in inches (v4.6).
FooterMarginfloat0.3fDistance from the bottom edge of the paper to the footer, in inches (v4.6).
FitToPageboolfalseShrink the printable range to fit FitToPagesWide × FitToPagesTall pages (v4.6).
FitToPagesWideint1Pages across when FitToPage is on. 0 = unconstrained (v4.6).
FitToPagesTallint1Pages down when FitToPage is on. 0 = unconstrained (v4.6).
CenterHorizontallyboolfalseCenter each page’s content horizontally between the margins (v4.6).
CenterVerticallyboolfalseCenter each page’s content vertically between the margins (v4.6).
Was this article helpful?