FsCell (FsSpreadsheet)

FsCell Type

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

Constructors

Constructor Description

Constructor	Description
`FsCell(value, ?dataType, ?address)` Full Usage: `FsCell(value, ?dataType, ?address)` Parameters: value : `IConvertible` ?dataType : `DataType` ?address : `FsAddress` Returns: `FsCell`	value : `IConvertible` ?dataType : `DataType` ?address : `FsAddress` Returns: `FsCell`
`FsCell(value, ?dataType, ?address)` Full Usage: `FsCell(value, ?dataType, ?address)` Parameters: value : `obj` ?dataType : `DataType` ?address : `FsAddress` Returns: `FsCell`	value : `obj` ?dataType : `DataType` ?address : `FsAddress` Returns: `FsCell`


                
                  
                    
                      FsCell(value, ?dataType, ?address)

Full Usage: FsCell(value, ?dataType, ?address)

Parameters:

value : IConvertible

?dataType : DataType

?address : FsAddress

Returns: FsCell

value : IConvertible
?dataType : DataType
?address : FsAddress

Returns: FsCell


                
                  
                    
                      FsCell(value, ?dataType, ?address)

Full Usage: FsCell(value, ?dataType, ?address)

Parameters:

value : obj

?dataType : DataType

?address : FsAddress

Returns: FsCell

value : obj
?dataType : DataType
?address : FsAddress

Returns: FsCell

Instance members

Instance member Description


                
                  
                    
                      this.Address

Full Usage: this.Address

Gets this FsCell's address, relative to the FsWorksheet.


                
                  
                    
                      this.ColumnNumber

Full Usage: this.ColumnNumber

Gets or sets the columnIndex of the FsCell.

Full Usage: this.Copy

Returns: FsCell

Creates a deep copy of this FsCell.

Returns: FsCell


                
                  
                    
                      this.CopyFrom

Full Usage: this.CopyFrom

Parameters:

otherCell : FsCell

Copies and replaces DataType and Value from a given FsCell into this one.

otherCell : FsCell


                
                  
                    
                      this.CopyTo

Full Usage: this.CopyTo

Parameters:

target : FsCell

Copies DataType and Value from this FsCell to a given one and replaces theirs.

target : FsCell


                
                  
                    
                      this.DataType

Full Usage: this.DataType

Gets or sets the DataType of this FsCell's data.

Changing the data type will cause FsSpreadsheet to convert the current value to the new DataType.

An exception will be thrown if the current value cannot be converted to the new DataType.

ArgumentException


                
                  
                    
                      this.RowNumber

Full Usage: this.RowNumber

Gets or sets the rowIndex of the FsCell.


                
                  
                    
                      this.SetValueAs

Full Usage: this.SetValueAs

Parameters:

value : obj

Sets the FsCell's value.

FsSpreadsheet will try to translate it to the corresponding type, if it cannot, the value will be left as a string.

value : obj


                
                  
                    
                      this.StructurallyEquals

Full Usage: this.StructurallyEquals

Parameters:

other : FsCell

Returns: bool

other : FsCell

Returns: bool

Full Usage: this.Value

Gets or sets the cell's value. To get or set a strongly typed value, use the GetValue and SetValue methods.


                
                  
                    
                      this.ValueAsBool

Full Usage: this.ValueAsBool

Returns: bool

Gets the value as bool

Returns: bool


                
                  
                    
                      this.ValueAsChar

Full Usage: this.ValueAsChar

Returns: char

Gets the value as char

Returns: char


                
                  
                    
                      this.ValueAsDateTime

Full Usage: this.ValueAsDateTime

Returns: DateTime

Gets the value as DateTime

Returns: DateTime


                
                  
                    
                      this.ValueAsDecimal

Full Usage: this.ValueAsDecimal

Returns: decimal

Gets the value as decimal

Returns: decimal


                
                  
                    
                      this.ValueAsDouble

Full Usage: this.ValueAsDouble

Returns: float

Gets the value as double

Returns: float


                
                  
                    
                      this.ValueAsFloat

Full Usage: this.ValueAsFloat

Returns: float

Gets the value as float

Returns: float


                
                  
                    
                      this.ValueAsGuid

Full Usage: this.ValueAsGuid

Returns: Guid

Gets the value as Guid

Returns: Guid


                
                  
                    
                      this.ValueAsInt

Full Usage: this.ValueAsInt

Returns: int

Gets the value as int

Returns: int


                
                  
                    
                      this.ValueAsLong

Full Usage: this.ValueAsLong

Returns: int64

Gets the value as long

Returns: int64


                
                  
                    
                      this.ValueAsString

Full Usage: this.ValueAsString

Returns: string

Gets the value as string

Returns: string


                
                  
                    
                      this.ValueAsUInt

Full Usage: this.ValueAsUInt

Returns: uint32

Gets the value as uint

Returns: uint32


                
                  
                    
                      this.ValueAsULong

Full Usage: this.ValueAsULong

Returns: uint64

Gets the value as ulong

Returns: uint64

Static members

Static member	Description
`FsCell.copy cell` Full Usage: `FsCell.copy cell` Parameters: cell : `FsCell` Returns: `FsCell`	Returns a deep copy of a given FsCell. cell : `FsCell` Returns: `FsCell`
`FsCell.copyFromTo sourceCell targetCell` Full Usage: `FsCell.copyFromTo sourceCell targetCell` Parameters: sourceCell : `FsCell` targetCell : `FsCell` Returns: `FsCell`	Copies and replaces DataType and Value from a source FsCell into a target FsCell. Returns the target cell. sourceCell : `FsCell` targetCell : `FsCell` Returns: `FsCell`
`FsCell.create rowNumber colNumber value` Full Usage: `FsCell.create rowNumber colNumber value` Parameters: rowNumber : `int` colNumber : `int` value : `'a` Returns: `FsCell`	Create an FsCell from given rowNumber, colNumber, and value. Infers the DataType. rowNumber : `int` colNumber : `int` value : `'a` Returns: `FsCell`
`FsCell.createEmpty ()` Full Usage: `FsCell.createEmpty ()` Returns: `FsCell`	Creates an empty FsCell. Returns: `FsCell`
`FsCell.createEmptyWithAdress adress` Full Usage: `FsCell.createEmptyWithAdress adress` Parameters: adress : `FsAddress` Returns: `FsCell`	Creates an empty FsCell with a given FsAddress. adress : `FsAddress` Returns: `FsCell`
`FsCell.createWithAdress adress value` Full Usage: `FsCell.createWithAdress adress value` Parameters: adress : `FsAddress` value : `'a` Returns: `FsCell`	Creates an FsCell with the given FsAdress and value. Inferes the DataType. adress : `FsAddress` value : `'a` Returns: `FsCell`
`FsCell.createWithDataType dataType rowNumber colNumber value` Full Usage: `FsCell.createWithDataType dataType rowNumber colNumber value` Parameters: dataType : `DataType` rowNumber : `int` colNumber : `int` value : `obj` Returns: `FsCell`	Creates an FsCell with the given DataType, rowNumber, colNumber, and value. dataType : `DataType` rowNumber : `int` colNumber : `int` value : `obj` Returns: `FsCell`
`FsCell.empty ()` Full Usage: `FsCell.empty ()` Returns: `FsCell` Modifiers: inline	Creates an empty FsCell, set at row 0, column 0 (1-based). Returns: `FsCell`
`FsCell.getValueAsBool cell` Full Usage: `FsCell.getValueAsBool cell` Parameters: cell : `FsCell` Returns: `bool`	Gets the value as bool cell : `FsCell` Returns: `bool`
`FsCell.getValueAsChar cell` Full Usage: `FsCell.getValueAsChar cell` Parameters: cell : `FsCell` Returns: `char`	Gets the value as char cell : `FsCell` Returns: `char`
`FsCell.getValueAsDateTime cell` Full Usage: `FsCell.getValueAsDateTime cell` Parameters: cell : `FsCell` Returns: `DateTime`	Gets the value as DateTime cell : `FsCell` Returns: `DateTime`
`FsCell.getValueAsDecimal cell` Full Usage: `FsCell.getValueAsDecimal cell` Parameters: cell : `FsCell` Returns: `decimal`	Gets the value as decimal cell : `FsCell` Returns: `decimal`
`FsCell.getValueAsDouble cell` Full Usage: `FsCell.getValueAsDouble cell` Parameters: cell : `FsCell` Returns: `float`	Gets the value as double cell : `FsCell` Returns: `float`
`FsCell.getValueAsFloat cell` Full Usage: `FsCell.getValueAsFloat cell` Parameters: cell : `FsCell` Returns: `float`	Gets the value as float cell : `FsCell` Returns: `float`
`FsCell.getValueAsGuid cell` Full Usage: `FsCell.getValueAsGuid cell` Parameters: cell : `FsCell` Returns: `Guid`	Gets the value as Guid cell : `FsCell` Returns: `Guid`
`FsCell.getValueAsInt cell` Full Usage: `FsCell.getValueAsInt cell` Parameters: cell : `FsCell` Returns: `int`	Gets the value as int cell : `FsCell` Returns: `int`
`FsCell.getValueAsLong cell` Full Usage: `FsCell.getValueAsLong cell` Parameters: cell : `FsCell` Returns: `int64`	Gets the value as long cell : `FsCell` Returns: `int64`
`FsCell.getValueAsString cell` Full Usage: `FsCell.getValueAsString cell` Parameters: cell : `FsCell` Returns: `string`	Gets the value as string cell : `FsCell` Returns: `string`
`FsCell.getValueAsUInt cell` Full Usage: `FsCell.getValueAsUInt cell` Parameters: cell : `FsCell` Returns: `uint32`	Gets the value as uint cell : `FsCell` Returns: `uint32`
`FsCell.getValueAsULong cell` Full Usage: `FsCell.getValueAsULong cell` Parameters: cell : `FsCell` Returns: `uint64`	Gets the value as ulong cell : `FsCell` Returns: `uint64`
`FsCell.setValueAs value cell` Full Usage: `FsCell.setValueAs value cell` Parameters: value : `obj` cell : `FsCell` Returns: `FsCell`	Sets an FsCell's value. FsSpreadsheet will try to translate it to the corresponding type, if it cannot, the value will be left as a string. value : `obj` cell : `FsCell` Returns: `FsCell`