FsCellsCollection (FsSpreadsheet)

FsCellsCollection Type

Namespace: FsSpreadsheet
Assembly: FsSpreadsheet.dll
Base Type: obj

Constructors

Constructor	Description
`FsCellsCollection()` Full Usage: `FsCellsCollection()` Returns: `FsCellsCollection`	Returns: `FsCellsCollection`

Instance members

Instance member Description

Full Usage: this.Add

Parameters:

cells : FsCell seq

Adds FsCells to the FsCellsCollection.

Derives row- and columnIndeces from the FsAddress of the FsCells.

cells : FsCell seq

Full Usage: this.Add

Parameters:

cell : FsCell

Adds an FsCell to the FsCellsCollection.

Derives row- and columnIndex from the FsAddress of the FsCell.

cell : FsCell

Full Usage: this.Add

Parameters:

row : int32

column : int32

cell : FsCell

Adds an FsCell of given rowIndex and columnIndex to the FsCellsCollection.

row : int32
column : int32
cell : FsCell

Full Usage: this.Clear

Returns: FsCellsCollection

Empties the whole FsCellsCollection.

Returns: FsCellsCollection


                
                  
                    
                      this.ContainsCellAt

Full Usage: this.ContainsCellAt

Parameters:

rowIndex : int

colIndex : int

Returns: bool

Checks if an FsCell exists at given row- and columnIndex.

rowIndex : int
colIndex : int

Returns: bool

Full Usage: this.Copy

Returns: FsCellsCollection

Creates a deep copy of the FsCellsCollection.

Returns: FsCellsCollection

Full Usage: this.Count


                
                  
                    
                      this.GetCells

Full Usage: this.GetCells

Parameters:

startAddress : FsAddress

lastAddress : FsAddress

Returns: FsCell seq

Returns the FsCells from given startAddress to lastAddress.

startAddress : FsAddress
lastAddress : FsAddress

Returns: FsCell seq


                
                  
                    
                      this.GetCells

Full Usage: this.GetCells

Parameters:

rowStart : int32

columnStart : int32

rowEnd : int32

columnEnd : int32

Returns: FsCell seq

Returns the FsCells from given rowStart to rowEnd and columnStart to columnEnd.

rowStart : int32
columnStart : int32
rowEnd : int32
columnEnd : int32

Returns: FsCell seq


                
                  
                    
                      this.GetCells

Full Usage: this.GetCells

Parameters:

startAddress : FsAddress

lastAddress : FsAddress

predicate : FsCell -> bool

Returns: FsCell seq

Returns the FsCells from given startAddress to lastAddress and fulfilling the predicate.

startAddress : FsAddress
lastAddress : FsAddress
predicate : FsCell -> bool

Returns: FsCell seq


                
                  
                    
                      this.GetCells

Full Usage: this.GetCells

Parameters:

rowStart : int32

columnStart : int32

rowEnd : int32

columnEnd : int32

predicate : FsCell -> bool

Returns: FsCell seq

Returns the FsCells from given rowStart to rowEnd and columnStart to columnEnd and fulfilling the predicate.

rowStart : int32
columnStart : int32
rowEnd : int32
columnEnd : int32
predicate : FsCell -> bool

Returns: FsCell seq


                
                  
                    
                      this.GetCells

Full Usage: this.GetCells

Returns: FsCell seq

Returns all FsCells of the FsCellsCollection.

Returns: FsCell seq


                
                  
                    
                      this.GetCellsInColumn

Full Usage: this.GetCellsInColumn

Parameters:

colIndex : int32

Returns: FsCell seq

Returns all FsCells in the given columnIndex.

colIndex : int32

Returns: FsCell seq


                
                  
                    
                      this.GetCellsInRow

Full Usage: this.GetCellsInRow

Parameters:

rowIndex : int32

Returns: FsCell seq

Returns all FsCells in the given rowIndex.

rowIndex : int32

Returns: FsCell seq


                
                  
                    
                      this.GetFirstAddress

Full Usage: this.GetFirstAddress

Returns: FsAddress

Returns the upper left corner of the FsCellsCollection.

Returns: FsAddress


                
                  
                    
                      this.GetLastAddress

Full Usage: this.GetLastAddress

Returns: FsAddress

Returns the lower right corner of the FsCellsCollection.

Returns: FsAddress


                
                  
                    
                      this.MaxColumnNumber

Full Usage: this.MaxColumnNumber

Returns: int32

The highest columnIndex in The FsCellsCollection.

Do not confuse with the number of columns in the FsCellsCollection.

Returns: int32


                
                  
                    
                      this.MaxRowNumber

Full Usage: this.MaxRowNumber

Returns: int32

The highest rowIndex in The FsCellsCollection.

Do not confuse with the number of rows in the FsCellsCollection.

Returns: int32


                
                  
                    
                      this.RemoveCellAt

Full Usage: this.RemoveCellAt

Parameters:

row : int32

column : int32

Removes an FsCell of given rowIndex and columnIndex from the FsCellsCollection.

row : int32
column : int32


                
                  
                    
                      this.RemoveValueAt

Full Usage: this.RemoveValueAt

Parameters:

rowIndex : int

colIndex : int

Removes the value of an FsCell at given row- and columnIndex from the FsCollection.

rowIndex : int
colIndex : int

ArgumentNullException	if rowIndex or columnIndex is null.
KeyNotFoundException	if row or column at the given index does not exist.


                
                  
                    
                      this.TryGetCell

Full Usage: this.TryGetCell

Parameters:

row : int32

column : int32

Returns: FsCell option

Returns the FsCell at given rowIndex and columnIndex if it exists. Otherwise returns None.

row : int32
column : int32

Returns: FsCell option


                
                  
                    
                      this.TryRemoveValueAt

Full Usage: this.TryRemoveValueAt

Parameters:

rowIndex : int

colIndex : int

Removes the value of an FsCell at given row- and columnIndex if it exists from the FsCollection.

Does nothing if the row or column of given index does not exist.

rowIndex : int
colIndex : int

ArgumentNullException

if columnIndex is null.

Static members

Static member Description


                
                  
                    
                      FsCellsCollection.addCell cell cellsCollection

Full Usage: FsCellsCollection.addCell cell cellsCollection

Parameters:

cell : FsCell

cellsCollection : FsCellsCollection

Returns: FsCellsCollection

Adds an FsCell to an FsCellsCollection.

Derives row- and columnIndex from the FsAddress of the FsCell.

cell : FsCell
cellsCollection : FsCellsCollection

Returns: FsCellsCollection


                
                  
                    
                      FsCellsCollection.addCellWithIndeces rowIndex colIndex cell cellsCollection

Full Usage: FsCellsCollection.addCellWithIndeces rowIndex colIndex cell cellsCollection

Parameters:

rowIndex : int32

colIndex : int32

cell : FsCell

cellsCollection : FsCellsCollection

Adds an FsCell of given rowIndex and columnIndex to an FsCellsCollection.

rowIndex : int32
colIndex : int32
cell : FsCell
cellsCollection : FsCellsCollection


                
                  
                    
                      FsCellsCollection.addCells cells cellsCollection

Full Usage: FsCellsCollection.addCells cells cellsCollection

Parameters:

cells : FsCell seq

cellsCollection : FsCellsCollection

Returns: FsCellsCollection

Adds FsCells to an FsCellsCollection.

Derives row- and columnIndeces from the FsAddress of the FsCells.

cells : FsCell seq
cellsCollection : FsCellsCollection

Returns: FsCellsCollection


                
                  
                    
                      FsCellsCollection.containsCellAt rowIndex colIndex cellsCollection

Full Usage: FsCellsCollection.containsCellAt rowIndex colIndex cellsCollection

Parameters:

rowIndex : int

colIndex : int

cellsCollection : FsCellsCollection

Returns: bool

Checks if an FsCell exists at given row- and columnIndex of a given FsCellsCollection.

rowIndex : int
colIndex : int
cellsCollection : FsCellsCollection

Returns: bool


                
                  
                    
                      FsCellsCollection.copy cellsCollection

Full Usage: FsCellsCollection.copy cellsCollection

Parameters:

cellsCollection : FsCellsCollection

Returns: FsCellsCollection

Returns a deep copy of a given FsCellsCollection.

cellsCollection : FsCellsCollection

Returns: FsCellsCollection


                
                  
                    
                      FsCellsCollection.createFromCells cells

Full Usage: FsCellsCollection.createFromCells cells

Parameters:

cells : FsCell seq

Returns: FsCellsCollection

Creates an FsCellsCollection from the given FsCells.

Derives row- and columnIndices from the FsAddress of the FsCells.

cells : FsCell seq

Returns: FsCellsCollection


                
                  
                    
                      FsCellsCollection.filterCellsFromTo rowStart columnStart rowEnd columnEnd predicate cellsCollection

Full Usage: FsCellsCollection.filterCellsFromTo rowStart columnStart rowEnd columnEnd predicate cellsCollection

Parameters:

rowStart : int32

columnStart : int32

rowEnd : int32

columnEnd : int32

predicate : FsCell -> bool

cellsCollection : FsCellsCollection

Returns: FsCell seq

Returns the FsCells from an FsCellsCollection with given rowStart to rowEnd and columnStart to columnEnd and fulfilling the predicate.

rowStart : int32
columnStart : int32
rowEnd : int32
columnEnd : int32
predicate : FsCell -> bool
cellsCollection : FsCellsCollection

Returns: FsCell seq


                
                  
                    
                      FsCellsCollection.filterCellsFromToAddress startAddress lastAddress predicate cellsCollection

Full Usage: FsCellsCollection.filterCellsFromToAddress startAddress lastAddress predicate cellsCollection

Parameters:

startAddress : FsAddress

lastAddress : FsAddress

predicate : FsCell -> bool

cellsCollection : FsCellsCollection

Returns: FsCell seq

Returns the FsCells from an FsCellsCollection with given startAddress to lastAddress and fulfilling the predicate.

startAddress : FsAddress
lastAddress : FsAddress
predicate : FsCell -> bool
cellsCollection : FsCellsCollection

Returns: FsCell seq


                
                  
                    
                      FsCellsCollection.getCells cellsCollection

Full Usage: FsCellsCollection.getCells cellsCollection

Parameters:

cellsCollection : FsCellsCollection

Returns: FsCell seq

Returns all FsCells of the FsCellsCollection.

cellsCollection : FsCellsCollection

Returns: FsCell seq


                
                  
                    
                      FsCellsCollection.getCellsFromTo rowStart columnStart rowEnd columnEnd cellsCollection

Full Usage: FsCellsCollection.getCellsFromTo rowStart columnStart rowEnd columnEnd cellsCollection

Parameters:

rowStart : int32

columnStart : int32

rowEnd : int32

columnEnd : int32

cellsCollection : FsCellsCollection

Returns: FsCell seq

Returns the FsCells from an FsCellsCollection with given rowStart to rowEnd and columnStart to columnEnd.

rowStart : int32
columnStart : int32
rowEnd : int32
columnEnd : int32
cellsCollection : FsCellsCollection

Returns: FsCell seq


                
                  
                    
                      FsCellsCollection.getCellsFromToAddress startAddress lastAddress cellsCollection

Full Usage: FsCellsCollection.getCellsFromToAddress startAddress lastAddress cellsCollection

Parameters:

startAddress : FsAddress

lastAddress : FsAddress

cellsCollection : FsCellsCollection

Returns: FsCell seq

Returns the FsCells from an FsCellsCollection with given startAddress to lastAddress.

startAddress : FsAddress
lastAddress : FsAddress
cellsCollection : FsCellsCollection

Returns: FsCell seq


                
                  
                    
                      FsCellsCollection.getCellsInColumn colIndex cellsCollection

Full Usage: FsCellsCollection.getCellsInColumn colIndex cellsCollection

Parameters:

colIndex : int32

cellsCollection : FsCellsCollection

Returns: FsCell seq

Returns all FsCells in an FsCellsCollection with the given columnIndex.

colIndex : int32
cellsCollection : FsCellsCollection

Returns: FsCell seq


                
                  
                    
                      FsCellsCollection.getCellsInRow rowIndex cellsCollection

Full Usage: FsCellsCollection.getCellsInRow rowIndex cellsCollection

Parameters:

rowIndex : int32

cellsCollection : FsCellsCollection

Returns: FsCell seq

Returns all FsCells in an FsCellsCollection with the given rowIndex.

rowIndex : int32
cellsCollection : FsCellsCollection

Returns: FsCell seq


                
                  
                    
                      FsCellsCollection.getFirstAddress cells

Full Usage: FsCellsCollection.getFirstAddress cells

Parameters:

cells : FsCellsCollection

Returns: FsAddress

Returns the upper left corner of a given FsCellsCollection.

cells : FsCellsCollection

Returns: FsAddress


                
                  
                    
                      FsCellsCollection.getLastAddress cells

Full Usage: FsCellsCollection.getLastAddress cells

Parameters:

cells : FsCellsCollection

Returns: FsAddress

Returns the lower right corner of a given FsCellsCollection.

cells : FsCellsCollection

Returns: FsAddress


                
                  
                    
                      FsCellsCollection.removeCellAt rowIndex colIndex cellsCollection

Full Usage: FsCellsCollection.removeCellAt rowIndex colIndex cellsCollection

Parameters:

rowIndex : int32

colIndex : int32

cellsCollection : FsCellsCollection

Returns: FsCellsCollection

Removes an FsCell of given rowIndex and columnIndex from an FsCellsCollection.

rowIndex : int32
colIndex : int32
cellsCollection : FsCellsCollection

Returns: FsCellsCollection


                
                  
                    
                      FsCellsCollection.removeValueAt rowIndex colIndex cellsCollection

Full Usage: FsCellsCollection.removeValueAt rowIndex colIndex cellsCollection

Parameters:

rowIndex : int

colIndex : int

cellsCollection : FsCellsCollection

Returns: FsCellsCollection

Removes the value of an FsCell at given row- and columnIndex from a given FsCollection.

rowIndex : int
colIndex : int
cellsCollection : FsCellsCollection

Returns: FsCellsCollection

ArgumentNullException	if rowIndex or columnIndex is null.
KeyNotFoundException	if row or column at the given index does not exist.


                
                  
                    
                      FsCellsCollection.tryGetCell rowIndex colIndex cellsCollection

Full Usage: FsCellsCollection.tryGetCell rowIndex colIndex cellsCollection

Parameters:

rowIndex : int32

colIndex : int32

cellsCollection : FsCellsCollection

Returns: FsCell option

Returns the FsCell from an FsCellsCollection at given rowIndex and columnIndex if it exists. Otherwise returns None.

rowIndex : int32
colIndex : int32
cellsCollection : FsCellsCollection

Returns: FsCell option


                
                  
                    
                      FsCellsCollection.tryRemoveValueAt rowIndex colIndex cellsCollection

Full Usage: FsCellsCollection.tryRemoveValueAt rowIndex colIndex cellsCollection

Parameters:

rowIndex : int

colIndex : int

cellsCollection : FsCellsCollection

Returns: FsCellsCollection

Removes the value of an FsCell at given row- and columnIndex if it exists from a given FsCollection.

Does nothing if the row or column of given index does not exist.

rowIndex : int
colIndex : int
cellsCollection : FsCellsCollection

Returns: FsCellsCollection