Worksheet.Item[String] Property

Provides access to a cell range by its reference string.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

Range this[string reference] { get; }

VB.NET

ReadOnly Property Item(reference As String) As Range

Parameters

Name	Type	Description
reference	String	A String value that specifies the range reference in the A1 reference style or a defined name.

Property Value

Type	Description
Range	A Range object.

Remarks

Use the Item method to access worksheet ranges by a cell reference or a defined name.

Note

The Item property requires the cell range reference in the A1 reference style, regardless of which reference style is used in the workbook (DocumentSettings.R1C1ReferenceStyle). If you need to get a cell range by its R1C1 reference, use the IRangeProvider.Parse method.

Example

This example demonstrates how to access ranges of cells in a worksheet. There are several ways to accomplish this.

• The Worksheet.Item property obtains cell ranges defined by a cell reference (using A1 style) or a defined name.
• Ranges defined by a cell reference (using R1C1 or other reference styles), a defined name in a workbook, or by indexes of the bounding rows and columns - use the IRangeProvider.Item, IRangeProvider.Parse and IRangeProvider.FromLTRB members. Access the IRangeProvider object by the Worksheet.Range or IWorkbook.Range property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-e4655

CellActions.cs

// A range that includes cells from the top left cell (A1) to the bottom right cell (B5).
Range rangeA1B5 = worksheet["A1:B5"];

// A rectangular range that includes cells from the top left cell (C5) to the bottom right cell (E7).
Range rangeC5E7 = worksheet["C5:E7"];

// The C4:E7 cell range located in the "Sheet3" worksheet.
Range rangeSheet3C4E7 = workbook.Range["Sheet3!C4:E7"];

// A range that contains a single cell (E7).
Range rangeE7 = worksheet["E7"];

// A range that includes the entire column A.
Range rangeColumnA = worksheet["A:A"];

// A range that includes the entire row 5.
Range rangeRow5 = worksheet["5:5"];

// A minimal rectangular range that includes all listed cells: C6, D9 and E7.
Range rangeC6D9E7 = worksheet.Range.Parse("C6:D9:E7");

// A rectangular range whose left column index is 0, top row index is 0, 
// right column index is 3 and bottom row index is 2. This is the A1:D3 cell range.
Range rangeA1D3 = worksheet.Range.FromLTRB(0, 0, 3, 2);

// A range that includes the intersection of two ranges: C5:E10 and E9:G13. 
// This is the E9:E10 cell range.
Range rangeE9E10 = worksheet["C5:E10 E9:G13"];

// Create a defined name for the D20:G23 cell range.
worksheet.DefinedNames.Add("MyNamedRange", "Sheet1!$D$20:$G$23");
// Access a range by its defined name.
Range rangeD20G23 = worksheet["MyNamedRange"];
Range rangeA1D4 = worksheet["A1:D4"];
Range rangeD5E7 = worksheet["D5:E7"];
Range rangeRow11 = worksheet["11:11"];
Range rangeF7 = worksheet["F7"];

// Create a complex range using the Range.Union method.
Range complexRange1 = worksheet["A7:A9"].Union(rangeD5E7);

// Create a complex range using the IRangeProvider.Union method.
Range complexRange2 = worksheet.Range.Union(new Range[] { rangeRow11, rangeA1D4, rangeF7 });

// Fill the ranges with different colors.
complexRange1.FillColor = myColor1;
complexRange2.FillColor = myColor2;

// Use the Areas property to get access to a component of a complex range.
complexRange2.Areas[2].FillColor = Color.Beige;

CellActions.vb

' A range that includes cells from the top left cell (A1) to the bottom right cell (B5).
Dim rangeA1B5 As Range = worksheet("A1:B5")

' A rectangular range that includes cells from the top left cell (C5) to the bottom right cell (E7).
Dim rangeC5E7 As Range = worksheet("C5:E7")

' The C4:E7 cell range located in the "Sheet3" worksheet.
Dim rangeSheet3C4E7 As Range = workbook.Range("Sheet3!C4:E7")

' A range that contains a single cell (E7).
Dim rangeE7 As Range = worksheet("E7")

' A range that includes the entire column A.
Dim rangeColumnA As Range = worksheet("A:A")

' A range that includes the entire row 5.
Dim rangeRow5 As Range = worksheet("5:5")

' A minimal rectangular range that includes all listed cells: C6, D9 and E7.
Dim rangeC6D9E7 As Range = worksheet.Range.Parse("C6:D9:E7")

' A rectangular range whose left column index is 0, top row index is 0, 
' right column index is 3 and bottom row index is 2. This is the A1:D3 cell range.
Dim rangeA1D3 As Range = worksheet.Range.FromLTRB(0, 0, 3, 2)

' A range that includes the intersection of two ranges: C5:E10 and E9:G13. 
' This is the E9:E10 cell range.
Dim rangeE9E10 As Range = worksheet("C5:E10 E9:G13")

' Create a defined name for the D20:G23 cell range.
worksheet.DefinedNames.Add("MyNamedRange", "Sheet1!$D$20:$G$23")
' Access a range by its defined name.
Dim rangeD20G23 As Range = worksheet("MyNamedRange")
Dim rangeA1D4 As Range = worksheet("A1:D4")
Dim rangeD5E7 As Range = worksheet("D5:E7")
Dim rangeRow11 As Range = worksheet("11:11")
Dim rangeF7 As Range = worksheet("F7")

' Create a complex range using the Range.Union method.
Dim complexRange1 As Range = worksheet("A7:A9").Union(rangeD5E7)

' Create a complex range using the IRangeProvider.Union method.
Dim complexRange2 As Range = worksheet.Range.Union(New Range() { rangeRow11, rangeA1D4, rangeF7 })

' Fill the ranges with different colors.
complexRange1.FillColor = myColor1
complexRange2.FillColor = myColor2

' Use the Areas property to get access to a component of a complex range.
complexRange2.Areas(2).FillColor = Color.Beige