com.aspose.cells

Class CellsHelper

java.lang.Object

com.aspose.cells.CellsHelper

public class CellsHelper
extends java.lang.Object

Provides helper functions.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addAddInFunction(java.lang.String function, int minCountOfParameters, int maxCountOfParameters, int[] paramersType, int functionValueType) Deprecated. Use WorksheetCollection.RegisterAddInFunction() methods instead.
static java.lang.String	cellIndexToName(int row, int column) Gets cell name according to its row and column indexes.
static int[]	cellNameToIndex(java.lang.String cellName) Gets the cell row and column indexes according to its name.
static java.lang.String	columnIndexToName(int column) Gets column name according to column index.
static int	columnNameToIndex(java.lang.String columnName) Gets column index according to column name.
static java.lang.String	convertA1FormulaToR1C1(java.lang.String formula, int row, int column) Deprecated. Use Worksheet.ConvertFormulaReferenceStyle() method instead.
static java.lang.String	convertR1C1FormulaToA1(java.lang.String r1c1Formula, int row, int column) Deprecated. Use Worksheet.ConvertFormulaReferenceStyle() method instead.
static java.lang.String	createSafeSheetName(java.lang.String nameProposal) Checks given sheet name and create a valid one when needed.
static java.lang.String	createSafeSheetName(java.lang.String nameProposal, char replaceChar) Checks given sheet name and create a valid one when needed.
static java.lang.String	getAltStartPath() Gets the alternate startup path, which is referred to by some external formula references.
static java.lang.String	getCacheFolder() Gets the folder for temporary files that may be used as data cache.
static CustomImplementationFactory	getCustomImplementationFactory() Gets the factory for creating instances with special implementation.
static DateTime	getDateTimeFromDouble(double doubleValue, boolean date1904) Convert the double value to the date time value.
static double	getDoubleFromDateTime(DateTime dateTime, boolean date1904) Convert the date time to double value.
static double	getDPI() Gets the DPI of the machine.
static java.lang.String	getLibraryPath() Gets the library path which is referred to by some external formula references.
static int	getSignificantDigits() Deprecated. Use SignificantDigitsType property instead.
static int	getSignificantDigitsType() Gets the default type of significant digits for outputing numeric values.
static java.lang.String	getStartupPath() Gets the startup path, which is referred to by some external formula references.
static double	getTextWidth(java.lang.String text, Font font, double scaling) Get width of text in unit of points.
static Color[]	getUsedColors(Workbook workbook) Gets all used colors in the workbook.
static java.lang.String	getVersion() Get the release version.
static boolean	isCloudPlatform() Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,
static void	mergeFiles(java.lang.String[] files, java.lang.String cachedFile, java.lang.String destFile) Merges some large xls files to a xls file.
static boolean	needQuoteInFormula(java.lang.String sheetName) Indicates whether the name of the sheet should be enclosed in single quotes
static java.lang.String	rowIndexToName(int row) Gets row name according to row index.
static int	rowNameToIndex(java.lang.String rowName) Gets row index according to row name.
static void	setAltStartPath(java.lang.String value) Sets the alternate startup path, which is referred to by some external formula references.
static void	setCacheFolder(java.lang.String cache) Sets the folder for temporary files that may be used as data cache.
static void	setCloudPlatform(boolean value) Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,
static void	setCustomImplementationFactory(CustomImplementationFactory value) Sets the factory for creating instances with special implementation.
static void	setDPI(double value) Gets the DPI of the machine.
static void	setLibraryPath(java.lang.String value) Sets the library path which is referred to by some external formula references.
static void	setSignificantDigits(int value) Deprecated. Use SignificantDigitsType property instead.
static void	setSignificantDigitsType(int value) Sets the default type of significant digits for outputing numeric values.
static void	setStartupPath(java.lang.String value) Sets the startup path, which is referred to by some external formula references.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSignificantDigits

public static int getSignificantDigits()

Deprecated. Use SignificantDigitsType property instead.

Gets the number of significant digits. The default value is 17.

Remarks

Only could be 15 or 17 now. NOTE: This member is now obsolete. Instead, please use WorkbookSettings.getSignificantDigitsType(). This property will be removed 12 months later since June 2025. Aspose apologizes for any inconvenience you may have experienced.

setSignificantDigits

public static void setSignificantDigits(int value)

Deprecated. Use SignificantDigitsType property instead.

Sets the number of significant digits. The default value is 17.

Remarks

Only could be 15 or 17 now. NOTE: This member is now obsolete. Instead, please use WorkbookSettings.getSignificantDigitsType(). This property will be removed 12 months later since June 2025. Aspose apologizes for any inconvenience you may have experienced.

getSignificantDigitsType

public static int getSignificantDigitsType()

Gets the default type of significant digits for outputing numeric values. Default value is SignificantDigitsType.G_17.

See WorkbookSettings.getSignificantDigitsType().

setSignificantDigitsType

public static void setSignificantDigitsType(int value)

Sets the default type of significant digits for outputing numeric values. Default value is SignificantDigitsType.G_17.

See WorkbookSettings.getSignificantDigitsType().

getDPI

public static double getDPI()

Gets the DPI of the machine.

Remarks

setDPI

public static void setDPI(double value)

Gets the DPI of the machine.

Remarks

getTextWidth

public static double getTextWidth(java.lang.String text,
                  Font font,
                  double scaling)

Get width of text in unit of points.

Parameters:

text - The text.

font - The font of the text.

scaling - The scaling of text.

Returns:

getVersion

public static java.lang.String getVersion()

Get the release version.

Returns:

The release version.

cellNameToIndex

public static int[] cellNameToIndex(java.lang.String cellName)

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

Parameters:

cellName - Name of cell

Returns:

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

cellIndexToName

public static java.lang.String cellIndexToName(int row,
                               int column)

Gets cell name according to its row and column indexes.

Parameters:

row - Row index.

column - Column index.

Returns:

Name of cell.

columnIndexToName

public static java.lang.String columnIndexToName(int column)

Gets column name according to column index.

Parameters:

column - Column index.

Returns:

Name of column.

columnNameToIndex

public static int columnNameToIndex(java.lang.String columnName)

Gets column index according to column name.

Parameters:

columnName - Column name.

Returns:

Column index.

rowIndexToName

public static java.lang.String rowIndexToName(int row)

Gets row name according to row index.

Parameters:

row - Row index.

Returns:

Name of row.

rowNameToIndex

public static int rowNameToIndex(java.lang.String rowName)

Gets row index according to row name.

Parameters:

rowName - Row name.

Returns:

Row index.

convertR1C1FormulaToA1

public static java.lang.String convertR1C1FormulaToA1(java.lang.String r1c1Formula,
                                      int row,
                                      int column)

Deprecated. Use Worksheet.ConvertFormulaReferenceStyle() method instead.

Converts the r1c1 formula of the cell to A1 formula.

Remarks

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.

Parameters:

r1c1Formula - The r1c1 formula.

row - The row index of the cell.

column - The column index of the cell.

Returns:

The A1 formula.

convertA1FormulaToR1C1

public static java.lang.String convertA1FormulaToR1C1(java.lang.String formula,
                                      int row,
                                      int column)

Deprecated. Use Worksheet.ConvertFormulaReferenceStyle() method instead.

Converts A1 formula of the cell to the r1c1 formula.

Remarks

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.

Parameters:

formula - The A1 formula.

row - The row index of the cell.

column - The column index of the cell.

Returns:

The R1C1 formula.

getDateTimeFromDouble

public static DateTime getDateTimeFromDouble(double doubleValue,
                             boolean date1904)

Convert the double value to the date time value.

Parameters:

doubleValue - The double value.

date1904 - Date 1904 system.

Returns:

getDoubleFromDateTime

public static double getDoubleFromDateTime(DateTime dateTime,
                           boolean date1904)

Convert the date time to double value.

Parameters:

dateTime - The date time.

date1904 - Date 1904 system.

Returns:

getStartupPath

public static java.lang.String getStartupPath()

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

setStartupPath

public static void setStartupPath(java.lang.String value)

Sets the startup path, which is referred to by some external formula references.

getAltStartPath

public static java.lang.String getAltStartPath()

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

setAltStartPath

public static void setAltStartPath(java.lang.String value)

Sets the alternate startup path, which is referred to by some external formula references.

getLibraryPath

public static java.lang.String getLibraryPath()

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

setLibraryPath

public static void setLibraryPath(java.lang.String value)

Sets the library path which is referred to by some external formula references.

getUsedColors

public static Color[] getUsedColors(Workbook workbook)

Gets all used colors in the workbook.

Parameters:

workbook - The workbook object.

Returns:

The used colors.

getCustomImplementationFactory

public static CustomImplementationFactory getCustomImplementationFactory()

Gets the factory for creating instances with special implementation.

setCustomImplementationFactory

public static void setCustomImplementationFactory(CustomImplementationFactory value)

Sets the factory for creating instances with special implementation.

addAddInFunction

public static void addAddInFunction(java.lang.String function,
                    int minCountOfParameters,
                    int maxCountOfParameters,
                    int[] paramersType,
                    int functionValueType)

Deprecated. Use WorksheetCollection.RegisterAddInFunction() methods instead.

Add addin function.

Remarks

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.

Parameters:

function - The function name.

minCountOfParameters - Minimum number of parameters this function requires

maxCountOfParameters - Maximum number of parameters this function allows.

paramersType - ParameterType. The excepted parameters type of the function

functionValueType - ParameterType. The function value type.

mergeFiles

public static void mergeFiles(java.lang.String[] files,
              java.lang.String cachedFile,
              java.lang.String destFile)

Merges some large xls files to a xls file.

Remarks

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

Parameters:

files - The files.

cachedFile - The cached file.

destFile - The dest file.

getCacheFolder

public static java.lang.String getCacheFolder()

Gets the folder for temporary files that may be used as data cache.

Remarks

Cache files are used generally for some features for memory performance consideration, such as saving large data set to xls file, or using memory mode with file cache for cells model.

Returns:

Folder for cache files that has been specified. If it has not been specified, null will be returned and system's temporary path will be used when needed.

setCacheFolder

public static void setCacheFolder(java.lang.String cache)

Sets the folder for temporary files that may be used as data cache.

Remarks

Cache files are used generally for some features for memory performance consideration, such as saving large data set to xls file, or using memory mode with file cache for cells model.

Parameters:

cache - Folder for for temporary files that may be used as data cache.

createSafeSheetName

public static java.lang.String createSafeSheetName(java.lang.String nameProposal)

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.

Parameters:

nameProposal - sheet name to be used

Returns:

createSafeSheetName

public static java.lang.String createSafeSheetName(java.lang.String nameProposal,
                                   char replaceChar)

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 given character, then return the rebuilt string value.

Parameters:

nameProposal - sheet name to be used

replaceChar - character which will be used to replace invalid characters in given sheet name

Returns:

needQuoteInFormula

public static boolean needQuoteInFormula(java.lang.String sheetName)

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

Parameters:

sheetName - The name of the sheet

Returns:

isCloudPlatform

public static boolean isCloudPlatform()

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

setCloudPlatform

public static void setCloudPlatform(boolean value)

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