# SpreadsheetRangeReference

Immutable, typed spreadsheet address syntax.

Class 

`OfficeIMO.Spreadsheet`

**Namespace**

`OfficeIMO.Spreadsheet`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[SpreadsheetAddressSyntax.cs:90](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L90)

**Modifiers**

sealed

Immutable, typed spreadsheet address syntax. The parser understands quoting, absolute markers, whole-row and whole-column ranges without splitting semantic text on punctuation.

## Inheritance

- object
- SpreadsheetRangeReference

## Usage

Explore 5 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 4

- Property [SpreadsheetFormulaSyntaxNode.Reference](/api/core/officeimo-spreadsheet-spreadsheetformulasyntaxnode/#property-reference)
- Method [SpreadsheetRangeReference.FromCell](/api/core/officeimo-spreadsheet-spreadsheetrangereference/#method-fromcell-int32-int64)
- Method [SpreadsheetRangeReference.Parse](/api/core/officeimo-spreadsheet-spreadsheetrangereference/#method-parse-string-officeimo-spreadsheet-spreadsheetaddressdialect)
- Property [SpreadsheetReferenceSequence.References](/api/core/officeimo-spreadsheet-spreadsheetreferencesequence/#property-references)

### Accepted by parameters 1

- Method [SpreadsheetRangeReference.TryParse](/api/core/officeimo-spreadsheet-spreadsheetrangereference/#method-tryparse-string-officeimo-spreadsheet-spreadsheetaddressdialect-officeimo-spreadsheet-spreadsheetrangereference) parameter `reference`

Filter members 

Show inherited

## Methods

`public string Format(SpreadsheetAddressDialect dialect)` [#](#method-format-officeimo-spreadsheet-spreadsheetaddressdialect)

[SpreadsheetAddressSyntax.cs:130](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L130)

Formats this address using the requested grammar.

Parameters

**dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect required**

Returns

`string`

`public string FormatBaseCell(SpreadsheetAddressDialect dialect)` [#](#method-formatbasecell-officeimo-spreadsheet-spreadsheetaddressdialect)

[SpreadsheetAddressSyntax.cs:160](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L160)

Formats the first cell using the requested grammar.

Parameters

**dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect required**

Returns

`string`

`public static SpreadsheetRangeReference FromCell(int column, long row)` [#](#method-fromcell-int32-int64)

[SpreadsheetAddressSyntax.cs:90](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L90)

Creates a relative, unqualified single-cell address from one-based coordinates.

Parameters

**column int required**

One-based column index.

**row long required**

One-based row index.

Returns

`SpreadsheetRangeReference`

`public static SpreadsheetRangeReference Parse(string text, SpreadsheetAddressDialect dialect)` [#](#method-parse-string-officeimo-spreadsheet-spreadsheetaddressdialect)

[SpreadsheetAddressSyntax.cs:94](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L94)

Parses a complete address using the requested grammar.

Parameters

**text string required**

**dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect required**

Returns

`SpreadsheetRangeReference`

`public override string ToString()` [#](#method-tostring)

[SpreadsheetAddressSyntax.cs:170](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L170)

Returns a string that represents the current object.

Returns

`string` A string that represents the current object.

`public bool TryFormat(SpreadsheetAddressDialect dialect, out string formatted)` [#](#method-tryformat-officeimo-spreadsheet-spreadsheetaddressdialect-string)

[SpreadsheetAddressSyntax.cs:138](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L138)

Attempts to format this address without changing relative-sheet or cross-sheet range semantics.

Parameters

**dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect required**

**formatted string required**

Returns

`bool`

`public static bool TryParse(string? text, SpreadsheetAddressDialect dialect, out SpreadsheetRangeReference? reference)` [#](#method-tryparse-string-officeimo-spreadsheet-spreadsheetaddressdialect-officeimo-spreadsheet-spreadsheetrangereference)

[SpreadsheetAddressSyntax.cs:106](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L106)

Attempts to parse a complete address using the requested grammar.

Parameters

**text string? required**

**dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect required**

**reference OfficeIMO.Spreadsheet.SpreadsheetRangeReference? required**

Returns

`bool`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

## Properties

`public SpreadsheetCellReference Start { get; }` [#](#property-start)

[SpreadsheetAddressSyntax.cs:77](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L77)

Gets the first endpoint.

`public SpreadsheetCellReference? End { get; }` [#](#property-end)

[SpreadsheetAddressSyntax.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L80)

Gets the optional second endpoint.

`public bool IsRange { get; }` [#](#property-isrange)

[SpreadsheetAddressSyntax.cs:83](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs#L83)

Gets whether the syntax represents a range.

<!-- PowerForge markdown artifact sha256:9B1F866C4F03FF02898E22D61366948B8E65B7F688E9CCD4AEDB63C38BAA4F45 -->
