ClassCellValueFactory
Factory for creating cell value instances from various input types; use to convert strings, numbers, dates, and formulas into appropriate ICellValue implementations.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public static class CellValueFactoryInheritance: objectCellValueFactory
Methods
Create(DateTime)
Creates a number cell value from a DateTime by converting it to Excel's date serial number format.
Declaration
public static ICellValue Create(DateTime value)Parameters
value
The value.
Returns
The ICellValue instance.
Create(bool)
Creates a boolean cell value from a bool.
Declaration
public static ICellValue Create(bool value)Parameters
value
The value.
Returns
The ICellValue instance.
Create(double)
Creates a number cell value from a double.
Declaration
public static ICellValue Create(double value)Parameters
value
The value.
Returns
The ICellValue instance.
Create(string, Worksheet, CellIndex, CellValueFormat, out ICellValue, out CellValueFormat)
Creates a cell value from a string by parsing its content and determining the appropriate format; outputs both the cell value and any detected format.
Declaration
public static void Create(string value, Worksheet worksheet, CellIndex cellIndex, CellValueFormat currentFormatValue, out ICellValue cellValue, out CellValueFormat newFormatValue)Parameters
value
The value.
worksheet
The worksheet.
cellIndex
Index of the cell.
currentFormatValue
The current format value.
cellValue
The cell value.
newFormatValue
The new format value.
Create(string, Worksheet, int, int, CellValueFormat, out ICellValue, out CellValueFormat)
Creates a cell value from a string by parsing its content at the specified location and determining the appropriate format; outputs both the cell value and any detected format.
Declaration
public static void Create(string value, Worksheet worksheet, int rowIndex, int columnIndex, CellValueFormat currentFormatValue, out ICellValue cellValue, out CellValueFormat newFormatValue)Parameters
value
The value.
worksheet
The worksheet.
rowIndex
Index of the row.
columnIndex
Index of the column.
currentFormatValue
The current format value.
cellValue
The cell value.
newFormatValue
The format value.
CreateFormulaCellValue(string, Worksheet, int, int)
Creates a formula cell value by parsing the string as an Excel formula expression at the specified location.
Declaration
public static ICellValue CreateFormulaCellValue(string value, Worksheet worksheet, int rowIndex, int columnIndex)Parameters
value
The value.
worksheet
The worksheet.
rowIndex
Index of the row.
columnIndex
Index of the column.
Returns
The ICellValue instance.
CreateTextCellValue(string)
Creates a text cell value from a string without parsing or type detection.
Declaration
public static ICellValue CreateTextCellValue(string value)Parameters
value
The value.
Returns
The ICellValue instance.
GetCellValueType(ConstantExpression)
Determines the cell value type that corresponds to a constant expression; returns the appropriate CellValueType for the expression's result.
Declaration
public static CellValueType GetCellValueType(this ConstantExpression value)Parameters
value
The expression.
Returns
The cell value type.
ToCellValue(CellIndex, Worksheet)
Retrieves the cell value at the specified cell index from the worksheet.
Declaration
public static ICellValue ToCellValue(this CellIndex value, Worksheet worksheet)Parameters
value
The value.
worksheet
The worksheet.
Returns
The ICellValue instance.
ToCellValue(DateTime)
Converts a DateTime value to a number cell value representing the date; apply a date format to the cell to display as a date instead of a number.
Declaration
public static ICellValue ToCellValue(this DateTime value)Parameters
value
The value.
Returns
The ICellValue instance.
Remarks
Please note the date is stored as number value. If a date number format is not set to the cell the value will be shown as number.
ToCellValue(bool)
Converts a boolean value to a boolean cell value.
Declaration
public static ICellValue ToCellValue(this bool value)Parameters
value
The value.
Returns
The ICellValue instance.
ToCellValue(double)
Converts a double value to a number cell value.
Declaration
public static ICellValue ToCellValue(this double value)Parameters
value
The value.
Returns
The ICellValue instance.
ToCellValue(string, Worksheet, CellIndex)
Converts a string to a cell value by parsing its content at the specified cell location; string is analyzed to determine if it contains a number, date, formula, or text.
Declaration
public static ICellValue ToCellValue(this string value, Worksheet worksheet, CellIndex cellIndex)Parameters
value
The value.
worksheet
The worksheet.
cellIndex
Index of the cell.
Returns
The ICellValue instance.
Remarks
Please note that the string value is parsed to find its type. This process is slow. If you know the type of your data use the other overloads of this method.
ToCellValue(string, Worksheet, int, int)
Converts a string to a cell value by parsing its content at the specified row and column; string is analyzed to determine if it contains a number, date, formula, or text.
Declaration
public static ICellValue ToCellValue(this string value, Worksheet worksheet, int rowIndex, int columnIndex)Parameters
value
The value.
worksheet
The worksheet.
rowIndex
Index of the row.
columnIndex
Index of the column.
Returns
The ICellValue instance.
Remarks
Please note that the string value is parsed to find its type. This process is slow. If you know the type of your data use the other overloads of this method.
ToFormulaCellValue(string, Worksheet, int, int)
Converts a string to a formula cell value by parsing it as an Excel formula at the specified location.
Declaration
public static ICellValue ToFormulaCellValue(this string value, Worksheet worksheet, int rowIndex, int columnIndex)Parameters
value
The value.
worksheet
The worksheet.
rowIndex
Index of the row.
columnIndex
Index of the column.
Returns
The FormulaCellValue instance.
ToTextCellValue(string)
Converts a string to a text cell value without parsing; use when you want to store the string as literal text regardless of content.
Declaration
public static ICellValue ToTextCellValue(this string value)Parameters
value
The value.
Returns
The TextCellValue instance.