Worksheet.GetPrintableRange() Method

Returns a worksheet range that can be printed.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

CellRange GetPrintableRange()

VB.NET

Function GetPrintableRange As CellRange

Returns

Type	Description
CellRange	A CellRange object that is the printable worksheet range.

Remarks

The GetPrintableRange method returns a continuous worksheet range that meets the following requirements.

1. The top-left cell of the printable range is the A1 cell. If this cell is hidden, the printable range starts from the top-left cell of the visible area.

   

2. The printable range includes all cells that have data: values (CellRange.Value) or formulas (CellRange.Formula).

3. The printable range includes all cells containing visual formatting (fill or border).

   

4. If a non-empty cell is located in the hidden row or column, it is not included in the printable range.

5. The rightmost empty columns containing visual formatting (fill or border) are not included in the printable range.

   

6. The bottommost empty rows containing visual formatting (fill or border) are not included in the printable range.

   

7. Includes all shapes (pictures and charts).

   

8. Includes all tables (a table occupies a range determined by the Table.Range property). If a table contains hidden rows or columns below or to the right of visible cells, they are excluded from the printable range.

   

9. Merged cells (empty and non-empty) are included in the printable range. If merged cells are hidden, they are not included in the printable range. If merged cells contain no data and occupy the entire row or column, they are not included in the printable range as well.

   

10. Conditional formatting is ignored.
11. The print area (a cell range assigned to the Worksheet.SetPrintRange method and defined by the _xlnm.Print_Area name) is ignored. Use the GetPrintableRange method overload with a boolean parameter to get the printable range corresponding to the specified print area.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetPrintableRange() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

office-file-api-create-thumbnail-images-for-docx-xlsx-pdf-files/VB/ImageExporterHelper.vb#L18

Dim worksheet = excelDocumentAPI.Worksheets.ActiveWorksheet
Dim printableCellRange = worksheet.GetPrintableRange()
Dim docImage As OfficeImage = printableCellRange.ExportToImage()