The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

ReferenceElement Enum

Contains values to specify the type of a cell reference to be obtained.

Namespace: DevExpress.Spreadsheet

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

Declaration

[Flags]
public enum ReferenceElement
<Flags>
Public Enum ReferenceElement
[Flags]
public enum ReferenceElement
<Flags>
Public Enum ReferenceElement

Members

Name Description
ColumnAbsolute

The cell reference has the absolute column reference.

IncludeSheetName

The cell reference includes the worksheet name.

RowAbsolute

The cell reference has the absolute row reference.

Remarks

Use this enumeration's values in the Range.GetReferenceA1 and Range.GetReferenceR1C1 methods to specify the type of the cell reference to be returned (relative, absolute or mixed) and whether it should include the worksheet name.

Examples

This example demonstrates how to get R1C1-style references (relative, absolute and mixed) to a range of cells.

using DevExpress.Spreadsheet;
// ...

IWorkbook workbook = spreadsheetControl1.Document;
Worksheet worksheet = workbook.Worksheets["Sheet1"];

Range range = worksheet.Range["B3:D5"];

// Returns the range reference relative to cell E7 - "R[-4]C[-3]:R[-2]C[-1]".
string refRel = range.GetReferenceR1C1(worksheet.Cells["E7"]);

// Returns the range reference relative to cell A4, including the worksheet name - 
// "Sheet1!R[-1]C[1]:R[1]C[3]".
string refSheet = range.GetReferenceR1C1(ReferenceElement.IncludeSheetName, worksheet.Cells["A4"]);

// Returns the mixed range reference (with absolute row reference and column reference relative to cell B2),
// including the worksheet name - "Sheet1!R3C[-1]:R5C[1]".
string refMixed = range.GetReferenceR1C1(ReferenceElement.RowAbsolute | ReferenceElement.IncludeSheetName,
                                        worksheet.Cells["B2"]);

// Returns the absolute range reference - "R3C2:R5C4".
string refAbs = range.GetReferenceR1C1(ReferenceElement.RowAbsolute | ReferenceElement.ColumnAbsolute, null);
See Also