com.aspose.cells.CellsHelper.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aspose-cells Show documentation

Aspose.Cells for Java

There is a newer version: 23.1






CellsHelper





com.aspose.cells

Class CellsHelper
java.lang.Object
    com.aspose.cells.CellsHelper



public class CellsHelper extends java.lang.Object





            Provides helper functions.
            












Property Getters/Setters Summary



static java.lang.String getAltStartPath() 
static void setAltStartPath(java.lang.String) 
          
            Gets or sets the alternate startup path, which is referred to by some external formula references. 
            



static CustomImplementationFactory getCustomImplementationFactory() 
static void setCustomImplementationFactory(CustomImplementationFactory) 
          
            Gets or sets the factory for creating instances with special implementation.
            



static double getDPI() 
static void setDPI(double) 
          
            Gets the DPI of the machine.
            



static boolean isCloudPlatform() 
static void setCloudPlatform(boolean) 
          
            Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,
            



static java.lang.String getLibraryPath() 
static void setLibraryPath(java.lang.String) 
          
            Gets or sets the library path which is referred to by some external formula references.  
            



static int getSignificantDigits() 
static void setSignificantDigits(int) 
          
            Gets and sets the number of significant digits.
            The default value is 17.
            



static java.lang.String getStartupPath() 
static void setStartupPath(java.lang.String) 
          
            Gets or sets the startup path, which is referred to by some external formula references.  
            

 







Method Summary




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




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) 
          
            Converts A1 formula of the cell to the r1c1 formula.
            




static java.lang.String convertR1C1FormulaToA1(java.lang.String r1c1Formula, int row, int column) 
          
            Converts the r1c1 formula of the cell to A1 formula.
            




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.
            




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.
            




static com.aspose.cells.DateTime getDateTimeFromDouble(double doubleValue, boolean date1904) 
          
            Convert the double value to the date time value.
            




static double getDoubleFromDateTime(com.aspose.cells.DateTime dateTime, boolean date1904) 
          
            Convert the date time to double value.
            




static double getTextWidth(java.lang.String text, Font font, double scaling) 
          
            Get width of text in unit of points.
            




static com.aspose.cells.Color[] getUsedColors(Workbook workbook) 
          
            Gets all used colors in the workbook.
            




static java.lang.String getVersion() 
          
            Get the release version.
            




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 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.
            

 








Property Getters/Setters Detail



getSignificantDigits/setSignificantDigits 
public static int getSignificantDigits() / public static void setSignificantDigits(int value)


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

            Only could be 15 or 17 now.
            



setSignificantDigits 
public static void setSignificantDigits(int value)


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

            Only could be 15 or 17 now.
            




getDPI/setDPI 
public static double getDPI() / public static void setDPI(double value)


            Gets the DPI of the machine.
            




setDPI 
public static void setDPI(double value)


            Gets the DPI of the machine.
            





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


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



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


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




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


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



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


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




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


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



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


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




getCustomImplementationFactory/setCustomImplementationFactory 
public static CustomImplementationFactory getCustomImplementationFactory() / public static void setCustomImplementationFactory(CustomImplementationFactory value)


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



setCustomImplementationFactory 
public static void setCustomImplementationFactory(CustomImplementationFactory value)


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




isCloudPlatform/setCloudPlatform 
public static boolean isCloudPlatform() / public static void setCloudPlatform(boolean value)


            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,
            








Method Detail



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

            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)

            Converts the r1c1 formula of the cell to A1 formula.
            
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)

            Converts A1 formula of the cell to the r1c1 formula.
            
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 com.aspose.cells.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(com.aspose.cells.DateTime dateTime, boolean date1904)

            Convert the date time to double value.
            
Parameters:
dateTime - The date time.
date1904 - Date 1904 system.
Returns:





getUsedColors 
public static com.aspose.cells.Color[] getUsedColors(Workbook workbook)

            Gets all used colors in the workbook.
            
Parameters:
workbook - The workbook object.
Returns:
The used colors.




addAddInFunction 
public static void addAddInFunction(java.lang.String function, int minCountOfParameters, int maxCountOfParameters, int[] paramersType, int 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.Parameters:
function - The function name.
minCountOfParameters - Minimum number of parameters this function requires
maxCountOfParameters - Maximum number of parameters this function allows.
paramersType - The excepted parameters type of the function
functionValueType - A ParameterType value. The function value type.




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

            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.
            Parameters:
files - The files.
cachedFile - The cached file.
destFile - The dest file.




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:





See Also:


          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.

          Aspose.Cells Support Forum - our preferred method of support.
We guarantee a prompt response to any inquiry!
© 2003-2022 Aspose Pty Ltd. All rights reserved.

Property Getters/Setters Summary
`static java.lang.String`	`getAltStartPath()`
`static void`	`setAltStartPath(java.lang.String)`
	Gets or sets the alternate startup path, which is referred to by some external formula references.
`static CustomImplementationFactory`	`getCustomImplementationFactory()`
`static void`	`setCustomImplementationFactory(CustomImplementationFactory)`
	Gets or sets the factory for creating instances with special implementation.
`static double`	`getDPI()`
`static void`	`setDPI(double)`
	Gets the DPI of the machine.
`static boolean`	`isCloudPlatform()`
`static void`	`setCloudPlatform(boolean)`
	Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,
`static java.lang.String`	`getLibraryPath()`
`static void`	`setLibraryPath(java.lang.String)`
	Gets or sets the library path which is referred to by some external formula references.
`static int`	`getSignificantDigits()`
`static void`	`setSignificantDigits(int)`
	Gets and sets the number of significant digits. The default value is 17.
`static java.lang.String`	`getStartupPath()`
`static void`	`setStartupPath(java.lang.String)`
	Gets or sets the startup path, which is referred to by some external formula references.

Method Summary
`static void`	`addAddInFunction(java.lang.String function, int minCountOfParameters, int maxCountOfParameters, int[] paramersType, int functionValueType)`
`static void`	Add addin function.
`static java.lang.String`	`cellIndexToName(int row, int column)`
`static java.lang.String`	Gets cell name according to its row and column indexes.
`static int[]`	`cellNameToIndex(java.lang.String cellName)`
`static int[]`	Gets the cell row and column indexes according to its name.
`static java.lang.String`	`columnIndexToName(int column)`
`static java.lang.String`	Gets column name according to column index.
`static int`	`columnNameToIndex(java.lang.String columnName)`
`static int`	Gets column index according to column name.
`static java.lang.String`	`convertA1FormulaToR1C1(java.lang.String formula, int row, int column)`
`static java.lang.String`	Converts A1 formula of the cell to the r1c1 formula.
`static java.lang.String`	`convertR1C1FormulaToA1(java.lang.String r1c1Formula, int row, int column)`
`static java.lang.String`	Converts the r1c1 formula of the cell to A1 formula.
`static java.lang.String`	`createSafeSheetName(java.lang.String nameProposal)`
`static java.lang.String`	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.
`static java.lang.String`	`createSafeSheetName(java.lang.String nameProposal, char replaceChar)`
`static java.lang.String`	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.
`static com.aspose.cells.DateTime`	`getDateTimeFromDouble(double doubleValue, boolean date1904)`
`static com.aspose.cells.DateTime`	Convert the double value to the date time value.
`static double`	`getDoubleFromDateTime(com.aspose.cells.DateTime dateTime, boolean date1904)`
`static double`	Convert the date time to double value.
`static double`	`getTextWidth(java.lang.String text, Font font, double scaling)`
`static double`	Get width of text in unit of points.
`static com.aspose.cells.Color[]`	`getUsedColors(Workbook workbook)`
`static com.aspose.cells.Color[]`	Gets all used colors in the workbook.
`static java.lang.String`	`getVersion()`
`static java.lang.String`	Get the release version.
`static void`	`mergeFiles(java.lang.String[] files, java.lang.String cachedFile, java.lang.String destFile)`
`static void`	Merges some large xls files to a xls file.
`static java.lang.String`	`rowIndexToName(int row)`
`static java.lang.String`	Gets row name according to row index.
`static int`	`rowNameToIndex(java.lang.String rowName)`
`static int`	Gets row index according to row name.

getSignificantDigits/setSignificantDigits
public static int getSignificantDigits() / public static void setSignificantDigits(int value)

setSignificantDigits
public static void setSignificantDigits(int value)

getDPI/setDPI
public static double getDPI() / public static void setDPI(double value)

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

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

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

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

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

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

getCustomImplementationFactory/setCustomImplementationFactory
public static CustomImplementationFactory getCustomImplementationFactory() / public static void setCustomImplementationFactory(CustomImplementationFactory value)

setCustomImplementationFactory
public static void setCustomImplementationFactory(CustomImplementationFactory value)

isCloudPlatform/setCloudPlatform
public static boolean isCloudPlatform() / public static void setCloudPlatform(boolean value)

setCloudPlatform
public static void setCloudPlatform(boolean value)

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

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

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

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

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

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

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

com.aspose.cells.CellsHelper.html Maven / Gradle / Ivy

com.aspose.cells Class CellsHelper

getSignificantDigits/setSignificantDigits

setSignificantDigits

getDPI/setDPI

setDPI

getStartupPath/setStartupPath

setStartupPath

getAltStartPath/setAltStartPath

setAltStartPath

getLibraryPath/setLibraryPath

setLibraryPath

getCustomImplementationFactory/setCustomImplementationFactory

setCustomImplementationFactory

isCloudPlatform/setCloudPlatform

setCloudPlatform

getTextWidth

getVersion

cellNameToIndex

cellIndexToName

columnIndexToName

columnNameToIndex

rowIndexToName

rowNameToIndex

convertR1C1FormulaToA1

convertA1FormulaToR1C1

getDateTimeFromDouble

getDoubleFromDateTime

getUsedColors

addAddInFunction

mergeFiles

createSafeSheetName

createSafeSheetName

com.aspose.cells
Class CellsHelper

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

getDateTimeFromDouble
public static com.aspose.cells.DateTime getDateTimeFromDouble(double doubleValue, boolean date1904)

getDoubleFromDateTime
public static double getDoubleFromDateTime(com.aspose.cells.DateTime dateTime, boolean date1904)

getUsedColors
public static com.aspose.cells.Color[] getUsedColors(Workbook workbook)

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

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

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