Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 569 stars PSWriteOfficePowerShell module 164 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

SpreadsheetRangeReference

Edit on GitHub
Namespace OfficeIMO.Spreadsheet
Assembly OfficeIMO.Core
Source ../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:91
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

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

Returned or exposed by

Accepted by parameters

Methods

public String Format(SpreadsheetAddressDialect dialect) #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:131
Returns: String

Formats this address using the requested grammar.

Parameters

dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect requiredposition: 0
public String FormatBaseCell(SpreadsheetAddressDialect dialect) #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:161
Returns: String

Formats the first cell using the requested grammar.

Parameters

dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect requiredposition: 0
public static SpreadsheetRangeReference FromCell(Int32 column, Int64 row) #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:91
Returns: SpreadsheetRangeReference

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

Parameters

column System.Int32 requiredposition: 0
One-based column index.
row System.Int64 requiredposition: 1
One-based row index.
public static SpreadsheetRangeReference Parse(String text, SpreadsheetAddressDialect dialect) #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:95
Returns: SpreadsheetRangeReference

Parses a complete address using the requested grammar.

Parameters

text System.String requiredposition: 0
dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect requiredposition: 1
public override String ToString() #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:171
Returns: String

Returns a string that represents the current object.

Returns

A string that represents the current object.

public Boolean TryFormat(SpreadsheetAddressDialect dialect, out String formatted) #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:139
Returns: Boolean

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

Parameters

dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect requiredposition: 0
formatted System.String@ requiredposition: 1
public static Boolean TryParse(String text, SpreadsheetAddressDialect dialect, out SpreadsheetRangeReference reference) #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:107
Returns: Boolean

Attempts to parse a complete address using the requested grammar.

Parameters

text System.String requiredposition: 0
dialect OfficeIMO.Spreadsheet.SpreadsheetAddressDialect requiredposition: 1
reference OfficeIMO.Spreadsheet.SpreadsheetRangeReference@ requiredposition: 2

Properties

public SpreadsheetCellReference Start { get; } #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:78

Gets the first endpoint.

public SpreadsheetCellReference End { get; } #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:81

Gets the optional second endpoint.

public Boolean IsRange { get; } #
../../../../_/OfficeIMO.Core/Spreadsheet/SpreadsheetAddressSyntax.cs:84

Gets whether the syntax represents a range.