Header menu logo FsSpreadsheet

FsAddress Type

Constructors

Constructor Description

FsAddress(cellAddressString)

Full Usage: FsAddress(cellAddressString)

Parameters:
    cellAddressString : string

Returns: FsAddress
cellAddressString : string
Returns: FsAddress

FsAddress(rowNumber, columnNumber)

Full Usage: FsAddress(rowNumber, columnNumber)

Parameters:
    rowNumber : int
    columnNumber : int

Returns: FsAddress
rowNumber : int
columnNumber : int
Returns: FsAddress

FsAddress(rowNumber, columnLetter, fixedRow, fixedColumn)

Full Usage: FsAddress(rowNumber, columnLetter, fixedRow, fixedColumn)

Parameters:
    rowNumber : int
    columnLetter : string
    fixedRow : bool
    fixedColumn : bool

Returns: FsAddress
rowNumber : int
columnLetter : string
fixedRow : bool
fixedColumn : bool
Returns: FsAddress

FsAddress(rowNumber, columnNumber, fixedRow, fixedColumn)

Full Usage: FsAddress(rowNumber, columnNumber, fixedRow, fixedColumn)

Parameters:
    rowNumber : int
    columnNumber : int
    fixedRow : bool
    fixedColumn : bool

Returns: FsAddress
rowNumber : int
columnNumber : int
fixedRow : bool
fixedColumn : bool
Returns: FsAddress

Instance members

Instance member Description

this.Address

Full Usage: this.Address

this.ColumnNumber

Full Usage: this.ColumnNumber

this.Compare

Full Usage: this.Compare

Parameters:
Returns: bool Returns true if both FsAddresses are equal.

Compares the FsAddress with a given other one.

address : FsAddress
Returns: bool

Returns true if both FsAddresses are equal.

this.Copy

Full Usage: this.Copy

Returns: FsAddress

Creates a deep copy of the FsAddress.

Returns: FsAddress

this.FixedColumn

Full Usage: this.FixedColumn

Returns: bool
Returns: bool

this.FixedRow

Full Usage: this.FixedRow

Returns: bool
Returns: bool

this.RowNumber

Full Usage: this.RowNumber

this.ToIndices

Full Usage: this.ToIndices

Returns: int * int A tuple consisting of the rowIndex (fst) and the columnIndex (snd).

Returns the row- and the columnIndex of the FsAddress.

Returns: int * int

A tuple consisting of the rowIndex (fst) and the columnIndex (snd).

this.UpdateIndices

Full Usage: this.UpdateIndices

Parameters:
    rowIndex : int
    colIndex : int

Updates the row- and columnIndex respective to the given indices.

rowIndex : int
colIndex : int

Static members

Static member Description

FsAddress.compare address1 address2

Full Usage: FsAddress.compare address1 address2

Parameters:
Returns: bool

Checks if 2 FsAddresses are equal.

address1 : FsAddress
address2 : FsAddress
Returns: bool

FsAddress.copy address

Full Usage: FsAddress.copy address

Parameters:
Returns: FsAddress

Returns a deep copy of the given FsAddress.

address : FsAddress
Returns: FsAddress

FsAddress.toIndices address

Full Usage: FsAddress.toIndices address

Parameters:
Returns: int * int A tuple consisting of the rowIndex (fst) and the columnIndex (snd).

Returns the row- and the columnIndex of a given FsAddress.

address : FsAddress
Returns: int * int

A tuple consisting of the rowIndex (fst) and the columnIndex (snd).

FsAddress.updateIndices rowIndex colIndex address

Full Usage: FsAddress.updateIndices rowIndex colIndex address

Parameters:
    rowIndex : int
    colIndex : int
    address : FsAddress

Returns: FsAddress

Updates the row- and columnIndex of a given FsAddress respective to the given indices.

rowIndex : int
colIndex : int
address : FsAddress
Returns: FsAddress

Type something to start searching.