Header menu logo FsSpreadsheet

CellReference Module

Module containing functions to work with "A1" style excel cell references.

Functions and values

Function or value Description

colAdressToIndex columnAdress

Full Usage: colAdressToIndex columnAdress

Parameters:
    columnAdress : string

Returns: uint32

Transforms excel column string indices (e.g. A, B, Z, AA, CD) to index number (starting with A = 1).

columnAdress : string
Returns: uint32

indexPattern

Full Usage: indexPattern

Returns: string
Returns: string

indexRegex

Full Usage: indexRegex

Returns: Regex
Returns: Regex

indexToColAdress i

Full Usage: indexToColAdress i

Parameters:
    i : uint32

Returns: string

Transforms number index to excel column string indices (e.g. A, B, Z, AA, CD) (starting with A = 1).

i : uint32
Returns: string

moveHorizontal amount reference

Full Usage: moveHorizontal amount reference

Parameters:
    amount : int
    reference : string

Returns: string

Changes the column portion of a "A1"-style reference by the given amount (positive amount = increase and vice versa).

amount : int
reference : string
Returns: string

moveVertical amount reference

Full Usage: moveVertical amount reference

Parameters:
    amount : int
    reference : string

Returns: string

Changes the row portion of a "A1"-style reference by the given amount (positive amount = increase and vice versa).

amount : int
reference : string
Returns: string

ofIndices column row

Full Usage: ofIndices column row

Parameters:
    column : uint32
    row : uint32

Returns: string

Maps 1 based column and row indices to "A1" style reference.

column : uint32
row : uint32
Returns: string

setColIndex colI reference

Full Usage: setColIndex colI reference

Parameters:
    colI : uint32
    reference : string

Returns: string

Sets the column index (1 Based indices) of a "A1" style excel cell reference.

colI : uint32
reference : string
Returns: string

setRowIndex rowI reference

Full Usage: setRowIndex rowI reference

Parameters:
    rowI : uint32
    reference : string

Returns: string

Sets the row index (1 Based indices) of a "A1" style excel cell reference.

rowI : uint32
reference : string
Returns: string

toColIndex reference

Full Usage: toColIndex reference

Parameters:
    reference : string

Returns: uint32

Maps a "A1" style excel cell reference to a column (1 Based indices).

reference : string
Returns: uint32

toIndices reference

Full Usage: toIndices reference

Parameters:
    reference : string

Returns: uint32 * uint32

Maps a "A1" style excel cell reference to a column * row index tuple (1 Based indices).

reference : string
Returns: uint32 * uint32

toRowIndex reference

Full Usage: toRowIndex reference

Parameters:
    reference : string

Returns: uint32

Maps a "A1" style excel cell reference to a row (1 Based indices).

reference : string
Returns: uint32

Type something to start searching.