Worksheet.GetUsedRange() Method

Returns the used range on the specified worksheet.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

CellRange GetUsedRange()

VB.NET

Function GetUsedRange As CellRange

Returns

Type	Description
CellRange	A CellRange object that is the range of modified cells.

Remarks

In the Spreadsheet document model, empty cells in a worksheet do not exist until they are accessed in some way or modified. The GetUsedRange method returns a worksheet range that complies with the requirements listed below.

1. The used range is a continuous range of non-empty cells. The top-left cell of the used range is a cell located at the intersection of the topmost row and the leftmost column containing non-empty cells. The bottom-right cell of the used range is a cell located at the intersection of the lowest row and the rightmost column containing non-empty cells.

   Note

   The cell is not empty if it contains a CellRange.Value, CellRange.Formula, or has any Formatting properties which are not null.

   

2. The used range is extended to include the leftmost and rightmost empty columns containing visual formatting (fill or border). However, the returned range cannot include more than 8192 columns. Hidden columns that contain no data or formatting options applied, as well as empty columns with a custom width are not included in the used range.

   

3. The used range is extended to include the topmost and bottommost empty rows containing visual formatting (fill or border).

   

4. The used range includes all the tables regardless their visibility state (a table occupies a range determined by the Table.Range property).

   

5. Drawing objects(pictures,shapes and charts) are not included in the used range.

   

6. Merged cells are included in the used range, even if they are located in hidden columns or rows.

   

7. Conditional formatting is ignored.

The following example shows how to use the GetUsedRange method to restrict the number of visible rows and columns in a worksheet:

C#

// Access the active worksheet.
Worksheet worksheet = spreadsheetControl.ActiveWorksheet;
// Get the range containing non-empty cells.
CellRange usedRange = worksheet.GetUsedRange();
// Restrict the worksheet's visible area to the used range.
spreadsheetControl.WorksheetDisplayArea.SetSize(worksheet.Index, usedRange.ColumnCount, usedRange.RowCount);

VB.NET

' Access the active worksheet.
Dim worksheet As Worksheet = spreadsheetControl.ActiveWorksheet
' Get the range containing non-empty cells.
Dim usedRange As CellRange = worksheet.GetUsedRange()
' Restrict the worksheet's visible area to the used range.
spreadsheetControl.WorksheetDisplayArea.SetSize(worksheet.Index, usedRange.ColumnCount, usedRange.RowCount)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetUsedRange() 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.

C#

how-to-import-data-from-different-data-sources-and-use-tables/CS/DataImportExample/Form1.cs#L18

Worksheet worksheet = spreadsheetControl1.Document.Worksheets[0];
worksheet.Clear(worksheet.GetUsedRange());
ImportDataTable();

wpf-spreadsheet-chart-api/CS/SpreadsheetWPFChartAPISamples/MainWindow.xaml.cs#L59

Worksheet firstSheet = workbook.Worksheets[0];
CellRange usedRange = firstSheet.GetUsedRange();
firstSheet.SelectedCell = usedRange[usedRange.RowCount * usedRange.ColumnCount - 1].Offset(1, 1);

wpf-spreadsheet-pivot-table-api-examples/CS/SpreadsheetWPFPivotTableExamples/MainWindow.xaml.cs#L51

Worksheet firstSheet = workbook.Worksheets[0];
CellRange usedRange = firstSheet.GetUsedRange();
firstSheet.SelectedCell = usedRange[usedRange.RowCount * usedRange.ColumnCount - 1].Offset(1, 1);

winforms-spreadsheet-use-a-spreadsheet-control-as-inplace-editor/CS/WindowsFormsApplication1/Form1.cs#L54

Worksheet workSheet = spreadSheet.Document.Worksheets[0];
CellRange usedRange = workSheet.GetUsedRange();

winforms-spreadsheet-chart-api/CS/SpreadsheetChartAPISamples/Form1.cs#L118

if (active != null) {
    CellRange usedRange =active.GetUsedRange();
    active.SelectedCell = usedRange[usedRange.RowCount * usedRange.ColumnCount - 1].Offset(1, 1);

VB.NET

how-to-import-data-from-different-data-sources-and-use-tables/VB/DataImportExample/Form1.vb#L19

Dim worksheet As Worksheet = spreadsheetControl1.Document.Worksheets(0)
worksheet.Clear(worksheet.GetUsedRange())
ImportDataTable()

wpf-spreadsheet-chart-api/VB/SpreadsheetWPFChartAPISamples/MainWindow.xaml.vb#L61

Dim firstSheet As Worksheet = workbook.Worksheets(0)
Dim usedRange As CellRange = firstSheet.GetUsedRange()
firstSheet.SelectedCell = usedRange(usedRange.RowCount * usedRange.ColumnCount - 1).Offset(1, 1)

wpf-spreadsheet-pivot-table-api-examples/VB/SpreadsheetWPFPivotTableExamples/MainWindow.xaml.vb#L50

Dim firstSheet As Worksheet = workbook.Worksheets(0)
Dim usedRange As CellRange = firstSheet.GetUsedRange()
firstSheet.SelectedCell = usedRange(usedRange.RowCount * usedRange.ColumnCount - 1).Offset(1, 1)

winforms-spreadsheet-use-a-spreadsheet-control-as-inplace-editor/VB/WindowsFormsApplication1/Form1.vb#L49

Dim workSheet As Worksheet = spreadSheet.Document.Worksheets(0)
Dim usedRange As CellRange = workSheet.GetUsedRange()
For i As Integer = 0 To usedRange.ColumnCount - 1

winforms-spreadsheet-chart-api/VB/SpreadsheetChartAPISamples/Form1.vb#L114

If active IsNot Nothing Then
    Dim usedRange As CellRange = active.GetUsedRange()
    active.SelectedCell = usedRange(usedRange.RowCount * usedRange.ColumnCount - 1).Offset(1, 1)