Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

SpreadsheetRangeReference

OfficeIMO.Spreadsheet

Namespace
OfficeIMO.Spreadsheet
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
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.

Accepted by parameters 1

Methods

public string Format(SpreadsheetAddressDialect dialect) #

Formats this address using the requested grammar.

Parameters

dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect required

Returns

string
public string FormatBaseCell(SpreadsheetAddressDialect dialect) #

Formats the first cell using the requested grammar.

Parameters

dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect required

Returns

string
public static SpreadsheetRangeReference FromCell(int column, long row) #

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.
public static SpreadsheetRangeReference Parse(string text, SpreadsheetAddressDialect dialect) #

Parses a complete address using the requested grammar.

Parameters

text string required
dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect required
public override string ToString() #

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) #

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) #

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

Properties

public SpreadsheetCellReference Start { get; } #

Gets the first endpoint.

public SpreadsheetCellReference? End { get; } #

Gets the optional second endpoint.

public bool IsRange { get; } #

Gets whether the syntax represents a range.