CellsHelper

CellsHelper class

Provides helper functions.

Properties

Name	Type	Description
SignificantDigits	int	Gets and sets the number of significant digits. The default value is 17. Only could be 15 or 17 now.
SignificantDigitsType	int	The value of the property is SignificantDigitsType integer constant.
DPI	float	Gets the DPI of the machine.
StartupPath	String	Gets or sets the startup path, which is referred to by some external formula references.
AltStartPath	String	Gets or sets the alternate startup path, which is referred to by some external formula references.
LibraryPath	String	Gets or sets the library path which is referred to by some external formula references.
CustomImplementationFactory	CustomImplementationFactory	Gets or sets the factory for creating instances with special implementation.
IsCloudPlatform	boolean	Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,

Methods

Name	Description
getTextWidth	Get width of text in unit of points.
getVersion	Get the release version.
cellNameToIndex	Gets the cell row and column indexes according to its name.
cellIndexToName	Gets cell name according to its row and column indexes.
columnIndexToName	Gets column name according to column index.
columnNameToIndex	Gets column index according to column name.
rowIndexToName	Gets row name according to row index.
rowNameToIndex	Gets row index according to row name.
convertR1C1FormulaToA1	Converts the r1c1 formula of the cell to A1 formula.

NOTE: This member is now obsolete. Instead, please use Worksheet.C | | convertA1FormulaToR1C1 | Converts A1 formula of the cell to the r1c1 formula.

NOTE: This member is now obsolete. Instead, please use WorksheetCollection.RegisterAddInFunction() | | mergeFiles | Merges some large xls files to a xls file.

This method only supports merging data, style and formulas to the new file. | | getCacheFolder | | | setCacheFolder | | | createSafeSheetName | Checks given sheet name and create a valid one when needed. If given sheet name conforms to the rules of excel sheet nam | | needQuoteInFormula | Indicates whether the name of the sheet should be enclosed in single quotes |

CellsHelper.SignificantDigits property

Gets and sets the number of significant digits. The default value is 17. Only could be 15 or 17 now.

Type: int

CellsHelper.SignificantDigitsType property

The value of the property is SignificantDigitsType integer constant.

Type: int

CellsHelper.DPI property

Gets the DPI of the machine.

Type: float

CellsHelper.StartupPath property

Gets or sets the startup path, which is referred to by some external formula references.

Type: String

CellsHelper.AltStartPath property

Gets or sets the alternate startup path, which is referred to by some external formula references.

Type: String

CellsHelper.LibraryPath property

Gets or sets the library path which is referred to by some external formula references.

Type: String

CellsHelper.CustomImplementationFactory property

Gets or sets the factory for creating instances with special implementation.

Type: CustomImplementationFactory

CellsHelper.IsCloudPlatform property

Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,

Type: boolean

getTextWidth(text, font, scaling)

Get width of text in unit of points.

Parameter	Type	Description
text	String	The text.
font	Font	The font of the text.
scaling	float	The scaling of text.

getVersion()

Get the release version.

Returns: The release version.

cellNameToIndex(cellName)

Gets the cell row and column indexes according to its name.

Parameter	Type	Description
cellName	String	Name of cell

Returns: [0] is the row index and [1] is the column index.

cellIndexToName(row, column)

Gets cell name according to its row and column indexes.

Parameter	Type	Description
row	int	Row index.
column	int	Column index.

Returns: Name of cell.

columnIndexToName(column)

Gets column name according to column index.

Parameter	Type	Description
column	int	Column index.

Returns: Name of column.

columnNameToIndex(columnName)

Gets column index according to column name.

Parameter	Type	Description
columnName	String	Column name.

Returns: Column index.

rowIndexToName(row)

Gets row name according to row index.

Parameter	Type	Description
row	int	Row index.

Returns: Name of row.

rowNameToIndex(rowName)

Gets row index according to row name.

Parameter	Type	Description
rowName	String	Row name.

Returns: Row index.

convertR1C1FormulaToA1(r1c1Formula, row, column)

Converts the r1c1 formula of the cell to A1 formula.

NOTE: This member is now obsolete. Instead, please use Worksheet.ConvertFormulaReferenceStyle() method. This property will be removed 12 months later since August 2023. Aspose apologizes for any inconvenience you may have experienced.

Parameter	Type	Description
r1c1Formula	String	The r1c1 formula.
row	int	The row index of the cell.
column	int	The column index of the cell.

Returns: The A1 formula.

convertA1FormulaToR1C1(formula, row, column)

Converts A1 formula of the cell to the r1c1 formula.

Parameter	Type	Description
formula	String	The A1 formula.
row	int	The row index of the cell.
column	int	The column index of the cell.

Returns: The R1C1 formula.

getDateTimeFromDouble(doubleValue, date1904)

Convert the double value to the date time value.

Parameter	Type	Description
doubleValue	float	The double value.
date1904	boolean	Date 1904 system.

getDoubleFromDateTime(dateTime, date1904)

Convert the date time to double value.

Parameter	Type	Description
dateTime	DateTime	The date time.
date1904	boolean	Date 1904 system.

getUsedColors(workbook)

Gets all used colors in the workbook.

Parameter	Type	Description
workbook	Workbook	The workbook object.

Returns: The used colors.

addAddInFunction(function, minCountOfParameters, maxCountOfParameters, paramersType, functionValueType)

Add addin function.

NOTE: This member is now obsolete. Instead, please use WorksheetCollection.RegisterAddInFunction() methods. This method will be removed 12 months later since January 2022. Aspose apologizes for any inconvenience you may have experienced.

Parameter	Type	Description
function	String	The function name.
minCountOfParameters	int	Minimum number of parameters this function requires
maxCountOfParameters	int	Maximum number of parameters this function allows.
paramersType	Number Array	The excepted parameters type of the function
functionValueType	int	A ParameterType value. The function value type.

mergeFiles(files, cachedFile, destFile)

Merges some large xls files to a xls file.

This method only supports merging data, style and formulas to the new file. The cached file is used to store some temporary data.

Parameter	Type	Description
files	String[]	The files.
cachedFile	String	The cached file.
destFile	String	The dest file.

getCacheFolder()

setCacheFolder(cache)

createSafeSheetName(nameProposal) (1 of 2)

Checks given sheet name and create a valid one when needed. If given sheet name conforms to the rules of excel sheet name, then return it. Otherwise string will be truncated if length exceeds the limit and invalid characters will be replaced with ’ ‘, then return the rebuilt string value.

Parameter	Type	Description
nameProposal	String	sheet name to be used

createSafeSheetName(nameProposal, replaceChar) (2 of 2)

Parameter	Type	Description
nameProposal	String	sheet name to be used
replaceChar	char	character which will be used to replace invalid characters in given sheet name

needQuoteInFormula(sheetName)

Indicates whether the name of the sheet should be enclosed in single quotes

Parameter	Type	Description
sheetName	String	The name of the sheet

CellsFactory Class CellsUnitType Enum