FsTableField (FsSpreadsheet)

FsTableField Type

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

Creates an FsTableFiled with given name, index, FsRangeColumn, totalRowLabel, and the totalsRowFunction.

Constructors

Constructor	Description
`FsTableField(name, index, column)` Full Usage: `FsTableField(name, index, column)` Parameters: name : `string` index : `int` column : `FsRangeColumn` Returns: `FsTableField`	Creates an FsTableField with the given name, index, and FsRangeColumn. name : `string` index : `int` column : `FsRangeColumn` Returns: `FsTableField`
`FsTableField(name, index)` Full Usage: `FsTableField(name, index)` Parameters: name : `string` index : `int` Returns: `FsTableField`	Creates an FsTableField with the given name and index. name : `string` index : `int` Returns: `FsTableField`
`FsTableField(name)` Full Usage: `FsTableField(name)` Parameters: name : `string` Returns: `FsTableField`	Creates an FsTableField with the given name. name : `string` Returns: `FsTableField`
`FsTableField()` Full Usage: `FsTableField()` Returns: `FsTableField`	Creates an empty FsTableField. Returns: `FsTableField`
`FsTableField(name, index, column, totalsRowLabel, totalsRowFunction)` Full Usage: `FsTableField(name, index, column, totalsRowLabel, totalsRowFunction)` Parameters: name : `string` index : `int` column : `FsRangeColumn` totalsRowLabel : `obj` totalsRowFunction : `obj` Returns: `FsTableField`	name : `string` index : `int` column : `FsRangeColumn` totalsRowLabel : `obj` totalsRowFunction : `obj` Returns: `FsTableField`

Instance members

Instance member Description


                
                  
                    
                      this.Column

Full Usage: this.Column

Gets or sets the FsRangeColumn of this FsTableField.

Full Usage: this.Copy

Returns: FsTableField

Creates a deep copy of this FsTableField.

Returns: FsTableField


                
                  
                    
                      this.DataCells

Full Usage: this.DataCells

Parameters:

cellsCollection : FsCellsCollection - The FsCellsCollection respective to the FsTableField where the data cells are taken from.

Returns: FsCell seq

Gets the collection of data cells for this FsTableField. Excludes the header and footer cells.

cellsCollection : FsCellsCollection: The FsCellsCollection respective to the FsTableField where the data cells are taken from.

Returns: FsCell seq


                
                  
                    
                      this.HeaderCell

Full Usage: this.HeaderCell

Parameters:

cellsCollection : FsCellsCollection

showHeaderRow : bool

Returns: FsCell

Returns the header cell (taken from a given FsCellsCollection) for the FsTableField if `showHeaderRow` is true. Else fails.

cellsCollection : FsCellsCollection
showHeaderRow : bool

Returns: FsCell

Exception

if `showHeaderRow` is false.

Full Usage: this.Index

Gets or sets the 0-based index of the FsTableField inside the associated FsTable. Sets the associated FsRangeColumn's column index accordingly.

Full Usage: this.Name

Returns: string

The name of this FsTableField.

Returns: string


                
                  
                    
                      this.SetName

Full Usage: this.SetName

Parameters:

name : string

cellsCollection : FsCellsCollection

showHeaderRow : bool

Sets the name of the FsTableField. If `showHeaderRow` is true, takes the respective FsCellsCollection and renames the header cell according to the name of the FsTableField.

name : string
cellsCollection : FsCellsCollection
showHeaderRow : bool

Static members

Static member Description


                
                  
                    
                      FsTableField.copy tableField

Full Usage: FsTableField.copy tableField

Parameters:

tableField : FsTableField

Returns: FsTableField

Returns a deep copy of a given FsTableField.

tableField : FsTableField

Returns: FsTableField


                
                  
                    
                      FsTableField.getDataCells cellsCollection tableField

Full Usage: FsTableField.getDataCells cellsCollection tableField

Parameters:

cellsCollection : FsCellsCollection - The FsCellsCollection respective to the FsTableField where the data cells are taken from.

tableField : FsTableField - The FsTableField to get the data cells from.

Returns: FsCell seq

Gets the collection of data cells for a given FsTableField. Excludes the header and footer cells.

cellsCollection : FsCellsCollection: The FsCellsCollection respective to the FsTableField where the data cells are taken from.
tableField : FsTableField: The FsTableField to get the data cells from.

Returns: FsCell seq


                
                  
                    
                      FsTableField.getHeaderCell cellsCollection showHeaderRow tableField

Full Usage: FsTableField.getHeaderCell cellsCollection showHeaderRow tableField

Parameters:

cellsCollection : FsCellsCollection

showHeaderRow : bool

tableField : FsTableField

Returns: FsCell

Returns the header cell (taken from an FsCellsCollection) for a given FsTableField if `showHeaderRow` is true. Else fails.

cellsCollection : FsCellsCollection
showHeaderRow : bool
tableField : FsTableField

Returns: FsCell

Exception

if `showHeaderRow` is false.


                
                  
                    
                      FsTableField.setName name cellsCollection showHeaderRow tableField

Full Usage: FsTableField.setName name cellsCollection showHeaderRow tableField

Parameters:

name : string

cellsCollection : FsCellsCollection

showHeaderRow : bool

tableField : FsTableField

Returns: FsTableField

Sets the name of a given FsTableField. If `showHeaderRow` is true, takes the respective FsCellsCollection and renames the header cell according to the name of the FsTableField.

name : string
cellsCollection : FsCellsCollection
showHeaderRow : bool
tableField : FsTableField

Returns: FsTableField