Header menu logo FsSpreadsheet

Range Module

The areas marks the area in which the table lies.

Functions and values

Function or value Description

extendLeft amount area

Full Usage: extendLeft amount area

Parameters:
    amount : int
    area : string

Returns: string

Extends the left boundary of the area by the given amount (positive amount decreases the area to left and vice versa).

amount : int
area : string
Returns: string

extendRight amount area

Full Usage: extendRight amount area

Parameters:
    amount : int
    area : string

Returns: string

Extends the right boundary of the area by the given amount (positive amount increases area to right and vice versa).

amount : int
area : string
Returns: string

isCorrect area

Full Usage: isCorrect area

Parameters:
    area : string

Returns: bool

Returns true if the A1:A1-style area is of correct format.

area : string
Returns: bool

leftBoundary area

Full Usage: leftBoundary area

Parameters:
    area : string

Returns: uint32

Gets the left boundary of the area.

area : string
Returns: uint32

lowerBoundary area

Full Usage: lowerBoundary area

Parameters:
    area : string

Returns: uint32

Gets the lower boundary of the area.

area : string
Returns: uint32

moveHorizontal amount area

Full Usage: moveHorizontal amount area

Parameters:
    amount : int
    area : string

Returns: string

Moves both start and end of the area by the given amount (positive amount moves area to right and vice versa).

amount : int
area : string
Returns: string

moveVertical amount area

Full Usage: moveVertical amount area

Parameters:
    amount : int
    area : string

Returns: string

Moves both start and end of the area by the given amount (positive amount moves area to right and vice versa).

amount : int
area : string
Returns: string

ofBoundaries fromCellReference toCellReference

Full Usage: ofBoundaries fromCellReference toCellReference

Parameters:
    fromCellReference : string
    toCellReference : string

Returns: string

Given A1-based top left start and bottom right end indices, returns a "A1:A1"-style area-

fromCellReference : string
toCellReference : string
Returns: string

referenceExceedsArea reference area

Full Usage: referenceExceedsArea reference area

Parameters:
    reference : string
    area : string

Returns: bool

Returns true if the reference does not lie in the boundary of the area.

reference : string
area : string
Returns: bool

referenceExceedsAreaAbove reference area

Full Usage: referenceExceedsAreaAbove reference area

Parameters:
    reference : string
    area : string

Returns: bool

Returns true if the column index of the reference exceeds the upper boundary of the area.

reference : string
area : string
Returns: bool

referenceExceedsAreaBelow reference area

Full Usage: referenceExceedsAreaBelow reference area

Parameters:
    reference : string
    area : string

Returns: bool

Returns true if the column index of the reference exceeds the lower boundary of the area.

reference : string
area : string
Returns: bool

referenceExceedsAreaLeft reference area

Full Usage: referenceExceedsAreaLeft reference area

Parameters:
    reference : string
    area : string

Returns: bool

Returns true if the column index of the reference exceeds the left boundary of the area.

reference : string
area : string
Returns: bool

referenceExceedsAreaRight reference area

Full Usage: referenceExceedsAreaRight reference area

Parameters:
    reference : string
    area : string

Returns: bool

Returns true if the column index of the reference exceeds the right boundary of the area.

reference : string
area : string
Returns: bool

rightBoundary area

Full Usage: rightBoundary area

Parameters:
    area : string

Returns: uint32

Gets the right boundary of the area.

area : string
Returns: uint32

toBoundaries area

Full Usage: toBoundaries area

Parameters:
    area : string

Returns: string * string

Given a "A1:A1"-style area, returns A1-based cell start and end cellReferences.

area : string
Returns: string * string

upperBoundary area

Full Usage: upperBoundary area

Parameters:
    area : string

Returns: uint32

Gets the Upper boundary of the area.

area : string
Returns: uint32

Type something to start searching.