CellRange.GetReferenceA1() Method

Gets the relative cell or cell range reference in the A1 reference style.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

string GetReferenceA1()

VB.NET

Function GetReferenceA1 As String

Returns

Type	Description
String	A String value that specifies the A1-style relative reference to a cell or range of cells.

Remarks

Use the CellRange.GetReferenceR1C1 method to get cell references in the R1C1 reference style.

Example

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

C#

using DevExpress.Spreadsheet;
// ...

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

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

// Returns the relative range reference - "B3:D5".
string refRel = range.GetReferenceA1();

// Returns the relative range reference that includes the worksheet name - "Sheet1!B3:D5".
string refSheet = range.GetReferenceA1(ReferenceElement.IncludeSheetName);

// Returns the absolute range reference - "$B$3:$D$5".
string refAbs = range.GetReferenceA1(ReferenceElement.ColumnAbsolute | ReferenceElement.RowAbsolute);

// Returns the mixed range reference (with absolute row and relative column) 
// that includes the worksheet name - "Sheet1!B$3:D$5".
string refMixed = range.GetReferenceA1(ReferenceElement.RowAbsolute | ReferenceElement.IncludeSheetName);

VB.NET

Imports DevExpress.Spreadsheet
' ...

Dim workbook As IWorkbook = spreadsheetControl1.Document
Dim worksheet As Worksheet = workbook.Worksheets(0)

Dim range As CellRange = worksheet.Range("B3:D5")

' Returns the relative range reference - "B3:D5".
Dim refRel As String = range.GetReferenceA1()

' Returns the relative range reference that includes the worksheet name - "Sheet1!B3:D5".
Dim refSheet As String = range.GetReferenceA1(ReferenceElement.IncludeSheetName)

' Returns the absolute range reference - "$B$3:$D$5".
Dim refAbs As String = range.GetReferenceA1(ReferenceElement.ColumnAbsolute Or ReferenceElement.RowAbsolute)

' Returns the mixed range reference (with absolute row and relative column) 
' that includes the worksheet name - "Sheet1!B$3:D$5".
Dim refMixed As String = range.GetReferenceA1(ReferenceElement.RowAbsolute Or ReferenceElement.IncludeSheetName)

Related GitHub Examples

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

winforms-spreadsheet-control-create-a-data-entry-form/CS/DataEntryFormSample/SpreadsheetBindingManager.cs#L229

{
    string reference = e.Cell.GetReferenceA1();
    string propertyName = cellBindings.SingleOrDefault(p => p.Value == reference).Key;

wpf-spreadsheet-control-create-a-data-entry-form/CS/WpfDataEntryFormSample/SpreadsheetBindingManager.cs#L217

{
    string reference = e.Cell.GetReferenceA1();
    string propertyName = cellBindings.SingleOrDefault(p => p.Value == reference).Key;

wpf-spreadsheet-bind-spreadsheet-to-ms-sql-server-database/CS/WpfSpreadsheet_BindToDataSource/MainWindow.xaml.cs#L51

Worksheet sheet = spreadsheetControl.ActiveWorksheet;
string cellReference = cell.GetReferenceA1();
// If the "Save" cell is clicked in the data entry form,

wpf-spreadsheetcontrol-api-part-1/CS/SpreadsheetControl_WPF_API/SpreadsheetActions/CellActions.cs#L396

CommentRunCollection commentRunsE2 = commentE2.Runs;
commentRunsE2[1].Text = "This comment is copied from the cell " + commentedCell.GetReferenceA1();
#endregion #AddComment

spreadsheet-document-api-export-worksheet-range-to-datatable/CS/ExportToDataTableWorkbookExample/Form1.cs#L45

void exporter_CellValueConversionError(object sender, CellValueConversionErrorEventArgs e) {
    MessageBox.Show("Error in cell " + e.Cell.GetReferenceA1());
    e.DataTableValue = null;

VB.NET

winforms-spreadsheet-control-create-a-data-entry-form/VB/DataEntryFormSample/SpreadsheetBindingManager.vb#L198

If e.SheetName = SheetName Then
    Dim reference As String = e.Cell.GetReferenceA1()
    Dim propertyName As String = cellBindings.SingleOrDefault(Function(p) p.Value = reference).Key

wpf-spreadsheet-control-create-a-data-entry-form/VB/WpfDataEntryFormSample/SpreadsheetBindingManager.vb#L195

If e.SheetName = SheetName Then
    Dim reference As String = e.Cell.GetReferenceA1()
    Dim propertyName As String = cellBindings.SingleOrDefault(Function(p) p.Value = reference).Key

wpf-spreadsheet-bind-spreadsheet-to-ms-sql-server-database/VB/WpfSpreadsheet_BindToDataSource/MainWindow.xaml.vb#L50

Dim sheet As Worksheet = Me.spreadsheetControl.ActiveWorksheet
Dim cellReference As String = cell.GetReferenceA1()
' If the "Save" cell is clicked in the data entry form,

wpf-spreadsheetcontrol-api-part-1/VB/SpreadsheetControl_WPF_API/SpreadsheetActions/CellActions.vb#L387

                Dim commentRunsE2 As CommentRunCollection = commentE2.Runs
                commentRunsE2(1).Text = "This comment is copied from the cell " & commentedCell.GetReferenceA1()
'                #End Region ' #AddComment

spreadsheet-document-api-export-worksheet-range-to-datatable/VB/ExportToDataTableWorkbookExample/Form1.vb#L50

Private Sub exporter_CellValueConversionError(ByVal sender As Object, ByVal e As CellValueConversionErrorEventArgs)
    MessageBox.Show("Error in cell " & e.Cell.GetReferenceA1())
    e.DataTableValue = Nothing