com.aspose.cells
Classes 
AboveAverage
AbstractCalculationEngine
AbstractCalculationMonitor
AbstractGlobalizationSettings
AbstractInterruptMonitor
AbstractTextLoadOptions
ActiveXControl
ActiveXControlBase
ArcShape
Area
AutoFilter
AutoFitterOptions
AutomaticFill
AutoNumberedBulletValue
Axis
AxisBins
BaseShapeGuide
Bevel
Border
BorderCollection
BuiltInDocumentPropertyCollection
Bullet
BulletValue
Button
CalculationCell
CalculationData
CalculationOptions
Cell
CellArea
Cells
CellsColor
CellsDataTableFactory
CellsDrawing
CellsException
CellsFactory
CellsHelper
CellWatch
CellWatchCollection
CharacterBulletValue
Chart
ChartArea
ChartCollection
ChartDataTable
ChartFrame
ChartGlobalizationSettings
ChartPoint
ChartPointCollection
ChartShape
ChartTextFrame
CheckBox
CheckBoxActiveXControl
CheckBoxCollection
CollectionBase
Color
ColorFilter
ColorHelper
ColorScale
Column
ColumnCollection
ComboBox
ComboBoxActiveXControl
CommandButtonActiveXControl
Comment
CommentCollection
CommentShape
ConditionalFormattingCollection
ConditionalFormattingIcon
ConditionalFormattingIconCollection
ConditionalFormattingResult
ConditionalFormattingValue
ConditionalFormattingValueCollection
ConnectionParameter
ConnectionParameterCollection
ContentTypeProperty
ContentTypePropertyCollection
CopyOptions
CustomDocumentPropertyCollection
CustomFilter
CustomFilterCollection
CustomGeometry
CustomImplementationFactory
CustomProperty
CustomPropertyCollection
CustomXmlPart
CustomXmlPartCollection
CustomXmlShape
DataBar
DataBarBorder
DataLabels
DataSorter
DataSorterKey
DataSorterKeyCollection
DateTime
DateTimeGroupItem
DBConnection
DefaultStyleSettings
DeleteOptions
DialogBox
DifSaveOptions
DigitalSignature
DigitalSignatureCollection
DisplayUnitLabel
DocumentProperty
DocumentPropertyCollection
DocxSaveOptions
DrawObject
DrawObjectEventHandler
DropBars
DxfCollection
DynamicFilter
Encoding
ErrorBar
ErrorCheckOption
ErrorCheckOptionCollection
ExportObjectEvent
ExportRangeToJsonOptions
ExportTableOptions
ExternalConnection
ExternalConnectionCollection
ExternalLink
ExternalLinkCollection
FileFontSource
FileFormatInfo
FileFormatUtil
Fill
FillFormat
FilterColumn
FilterColumnCollection
FindOptions
Floor
FolderFontSource
Font
FontConfigs
FontSetting
FontSettingCollection
FontSourceBase
Format3D
FormatCondition
FormatConditionCollection
FormulaParseOptions
FormulaSettings
Geometry
GlobalizationSettings
GlowEffect
GradientFill
GradientStop
GradientStopCollection
GroupBox
GroupFill
GroupShape
HeaderFooterCommand
HorizontalPageBreak
HorizontalPageBreakCollection
HtmlLoadOptions
HtmlSaveOptions
Hyperlink
HyperlinkCollection
IconFilter
IconSet
ImageActiveXControl
ImageFormat
ImageOrPrintOptions
ImageSaveOptions
ImportTableOptions
IndividualFontConfigs
InsertOptions
InterruptMonitor
JsonLayoutOptions
JsonLoadOptions
JsonSaveOptions
JsonUtility
Label
LabelActiveXControl
Legend
LegendEntry
LegendEntryCollection
License
Line
LineFormat
LineShape
ListBox
ListBoxActiveXControl
ListColumn
ListColumnCollection
ListObject
ListObjectCollection
LoadFilter
LoadOptions
MarkdownSaveOptions
Marker
MemoryFontSource
MetadataOptions
Metered
MsoFillFormat
MsoFillFormatHelper
MsoFormatPicture
MsoLineFormat
MsoLineFormatHelper
MsoTextFrame
MultipleFilterCollection
Name
NameCollection
NegativeBarFormat
NoneBulletValue
NoneFill
OdsCellField
OdsCellFieldCollection
OdsLoadOptions
OdsPageBackground
OdsSaveOptions
OleObject
OleObjectCollection
OoxmlSaveOptions
Outline
Oval
PageEndSavingArgs
PageSavingArgs
PageSetup
PageStartSavingArgs
PaginatedSaveOptions
PaneCollection
PasteOptions
PatternFill
PdfBookmarkEntry
PdfSaveOptions
PdfSecurityOptions
PicFormatOption
Picture
PictureBulletValue
PictureCollection
PivotField
PivotFieldCollection
PivotFilter
PivotFilterCollection
PivotFormatCondition
PivotFormatConditionCollection
PivotItem
PivotItemCollection
PivotOptions
PivotPageFields
PivotTable
PivotTableCollection
PlotArea
PptxSaveOptions
ProtectedRange
ProtectedRangeCollection
Protection
QueryTable
QueryTableCollection
RadioButton
RadioButtonActiveXControl
Range
RangeCollection
RectangleShape
ReferredArea
ReferredAreaCollection
ReflectionEffect
ReplaceOptions
Revision
RevisionAutoFormat
RevisionCellChange
RevisionCellComment
RevisionCellMove
RevisionCollection
RevisionCustomView
RevisionDefinedName
RevisionFormat
RevisionInsertDelete
RevisionInsertSheet
RevisionLog
RevisionLogCollection
RevisionMergeConflict
RevisionQueryTable
RevisionRenameSheet
Row
RowCollection
SaveOptions
Scenario
ScenarioCollection
ScenarioInputCell
ScenarioInputCellCollection
ScrollBar
ScrollBarActiveXControl
Series
SeriesCollection
SeriesLayoutProperties
ShadowEffect
Shape
ShapeCollection
ShapeFormat
ShapeGuide
ShapeGuideCollection
ShapePath
ShapePathCollection
ShapePathPoint
ShapePathPointCollection
ShapePropertyCollection
ShapeSegmentPath
ShapeSegmentPathCollection
ShapeTextAlignment
SheetPrintingPreview
SheetRender
SheetSet
SignatureLine
Slicer
SlicerCache
SlicerCacheItem
SlicerCacheItemCollection
SlicerCollection
SmartArtShape
SmartTag
SmartTagCollection
SmartTagOptions
SmartTagProperty
SmartTagPropertyCollection
SmartTagSetting
SolidFill
Sparkline
SparklineCollection
SparklineGroup
SparklineGroupCollection
SpinButtonActiveXControl
Spinner
SpreadsheetML2003SaveOptions
StreamProviderOptions
Style
StyleFlag
SubtotalSetting
SvgSaveOptions
SxRng
TableStyle
TableStyleCollection
TableStyleElement
TableStyleElementCollection
TableToRangeOptions
TextBox
TextBoxActiveXControl
TextBoxCollection
TextEffectFormat
TextOptions
TextParagraph
TextParagraphCollection
TextTabStop
TextTabStopCollection
TextureFill
ThemeColor
ThreadedComment
ThreadedCommentAuthor
ThreadedCommentAuthorCollection
ThreadedCommentCollection
ThreeDFormat
TickLabelItem
TickLabels
TilePicOption
Timeline
TimelineCollection
Title
ToggleButtonActiveXControl
Top10
Top10Filter
Trendline
TrendlineCollection
TxtLoadOptions
TxtSaveOptions
UnionRange
UnknownControl
Validation
ValidationCollection
VbaModule
VbaModuleCollection
VbaProject
VbaProjectReference
VbaProjectReferenceCollection
VerticalPageBreak
VerticalPageBreakCollection
VmlShapeGuide
Walls
WarningInfo
WebExtension
WebExtensionBinding
WebExtensionBindingCollection
WebExtensionCollection
WebExtensionProperty
WebExtensionPropertyCollection
WebExtensionReference
WebExtensionReferenceCollection
WebExtensionShape
WebExtensionTaskPane
WebExtensionTaskPaneCollection
WebQueryConnection
Workbook
WorkbookDesigner
WorkbookMetadata
WorkbookPrintingPreview
WorkbookRender
WorkbookSettings
Worksheet
WorksheetCollection
WriteProtection
XlsbSaveOptions
XlsSaveOptions
XmlColumnProperty
XmlDataBinding
XmlLoadOptions
XmlMap
XmlMapCollection
XmlSaveOptions
XpsSaveOptions
Interfaces 
ICellsDataTable
ICustomFunction
ICustomParser
IExportObjectListener
IFilePathProvider
IPageSavingCallback
ISmartMarkerCallBack
IStreamProvider
IWarningCallback
LightCellsDataHandler
LightCellsDataProvider
Constants 
AccessCacheOptions
ActiveXPersistenceType
AutoFillType
AutoFitMergedCellsType
AutoFitWrappedTextType
AutoShapeType
AxisType
BackgroundMode
BackgroundType
Bar3DShapeType
BevelPresetType
BevelType
BorderType
BubbleSizeRepresents
BuiltinStyleType
BulletType
CalcModeType
CalculationPrecisionStrategy
CategoryType
CellBorderType
CellValueFormatStrategy
CellValueType
ChartLineFormattingType
ChartMarkerType
ChartSplitType
ChartTextDirectionType
ChartType
CheckValueType
ColorDepth
ColorType
CommentTitleType
ConnectionDataSourceType
ConnectionParameterType
ConsolidationFunction
ControlBorderType
ControlCaptionAlignmentType
ControlListStyle
ControlMatchEntryType
ControlMousePointerType
ControlPictureAlignmentType
ControlPicturePositionType
ControlPictureSizeMode
ControlScrollBarType
ControlScrollOrientation
ControlSpecialEffectType
ControlType
CopyFormatType
CountryCode
CredentialsMethodType
CrossType
DataBarAxisPosition
DataBarBorderType
DataBarFillType
DataBarNegativeColorType
DataLabelShapeType
DataLabelsSeparatorType
DataLablesSeparatorType
DateTimeGroupingType
DefaultEditLanguage
DirectoryType
DisplayDrawingObjects
DisplayUnitType
DrawObjectEnum
DropButtonStyle
DynamicFilterType
EmfRenderSetting
EncryptionType
ErrorBarDisplayType
ErrorBarType
ErrorCheckType
ExceptionType
ExternalLinkType
FileFormatType
FillPattern
FillPictureType
FillType
FilterOperatorType
FilterType
FontSchemeType
FontSourceType
FontUnderlineType
FormatConditionType
FormatConditionValueType
FormatSetType
FormattingType
GradientColorType
GradientDirectionType
GradientFillType
GradientPresetType
GradientStyleType
GridlineType
HeaderFooterCommandType
HtmlCrossType
HtmlExportDataOptions
HtmlFormatHandlingType
HtmlHiddenColDisplayType
HtmlHiddenRowDisplayType
HtmlLinkTargetType
IconSetType
ImageType
InputMethodEditorMode
LabelPositionType
LegendPositionType
LightRigDirectionType
LightRigType
LineCapType
LineJoinType
LineSpaceSizeType
LineType
LoadDataFilterOptions
LoadFormat
LookAtType
LookInType
MapChartLabelLayout
MapChartProjectionType
MapChartRegionType
MemorySetting
MetadataType
MirrorType
MsoArrowheadLength
MsoArrowheadStyle
MsoArrowheadWidth
MsoDrawingType
MsoLineDashStyle
MsoLineStyle
MsoPresetTextEffect
MsoPresetTextEffectShape
NameScopeType
NumberCategoryType
OdsCellFieldType
OdsGeneratorType
OdsPageBackgroundGraphicPositionType
OdsPageBackgroundGraphicType
OdsPageBackgroundType
OLEDBCommandType
OoxmlCompliance
OoxmlCompressionType
OperatorType
PageLayoutAlignmentType
PageOrientationType
PaneStateType
PaperSizeType
ParameterType
PasteOperationType
PasteType
PdfCompliance
PdfCompressionCore
PdfCustomPropertiesExport
PdfFontEncoding
PdfOptimizationType
PivotConditionFormatRuleType
PivotConditionFormatScopeType
PivotFieldDataDisplayFormat
PivotFieldSubtotalType
PivotFieldType
PivotFilterType
PivotGroupByType
PivotItemPosition
PivotMissingItemLimitType
PivotTableAutoFormatType
PivotTableStyleType
PlacementType
PlotDataByType
PlotEmptyCellsType
PresetCameraType
PresetMaterialType
PresetShadowType
PresetWordArtStyle
PrintCommentsType
PrintErrorsType
PrintingPageType
PrintOrderType
PrintSizeType
PropertyType
ProtectionType
QuartileCalculationType
ReConnectionMethodType
RectangleAlignmentType
ReflectionEffectType
RenameStrategy
ResourceLoadingType
RevisionActionType
RevisionType
SaveFormat
SelectionType
ShapeAnchorType
ShapeLockType
ShapePathType
SheetType
ShiftType
ShowDropButtonType
SlicerCacheCrossFilterType
SlicerCacheItemSortType
SlicerStyleType
SmartTagShowType
SortOnType
SortOrder
SparklineAxisMinMaxType
SparklinePresetStyleType
SparklineType
SqlDataType
StyleModifyFlag
TableDataSourceType
TableStyleElementType
TableStyleType
TargetModeType
TextAlignmentType
TextAutonumberScheme
TextCapsType
TextCrossType
TextDirectionType
TextFontAlignType
TextNodeType
TextOrientationType
TextOverflowType
TextStrikeType
TextTabAlignmentType
TextureType
TextVerticalType
ThemeColorType
TickLabelPositionType
TickMarkType
TiffCompression
TimePeriodType
TimeUnit
TotalsCalculation
TrendlineType
TxtLoadStyleStrategy
TxtValueQuoteType
UpdateLinksType
ValidationAlertType
ValidationType
VbaModuleType
VbaProjectReferenceType
ViewType
VisibilityType
WarningType
WebExtensionStoreType
WeightType
XAdESType

com.aspose.cells
Class CellsHelper

java.lang.Object
    extended by com.aspose.cells.CellsHelper

public class CellsHelper 
extends java.lang.Object

Provides helper functions.


Property Getters/Setters Summary
static java.lang.StringgetAltStartPath()
static voidsetAltStartPath(java.lang.String)
           Gets or sets the alternate startup path, which is referred to by some external formula references.
static CustomImplementationFactorygetCustomImplementationFactory()
static voidsetCustomImplementationFactory(CustomImplementationFactory)
           Gets or sets the factory for creating instances with special implementation.
static doublegetDPI()
static voidsetDPI(double)
           Gets the DPI of the machine.
static booleanisCloudPlatform()
static voidsetCloudPlatform(boolean)
           Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,
static java.lang.StringgetLibraryPath()
static voidsetLibraryPath(java.lang.String)
           Gets or sets the library path which is referred to by some external formula references.
static intgetSignificantDigits()
static voidsetSignificantDigits(int)
           Gets and sets the number of significant digits. The default value is 17.
static java.lang.StringgetStartupPath()
static voidsetStartupPath(java.lang.String)
           Gets or sets the startup path, which is referred to by some external formula references.
 
Method Summary
static voidaddAddInFunction(java.lang.String function, int minCountOfParameters, int maxCountOfParameters, int[] paramersType, int functionValueType)
           Add addin function.
static java.lang.StringcellIndexToName(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.StringcolumnIndexToName(int column)
           Gets column name according to column index.
static intcolumnNameToIndex(java.lang.String columnName)
           Gets column index according to column name.
static java.lang.StringconvertA1FormulaToR1C1(java.lang.String formula, int row, int column)
           Converts A1 formula of the cell to the r1c1 formula.
static java.lang.StringconvertR1C1FormulaToA1(java.lang.String r1c1Formula, int row, int column)
           Converts the r1c1 formula of the cell to A1 formula.
static java.lang.StringcreateSafeSheetName(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.StringcreateSafeSheetName(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.DateTimegetDateTimeFromDouble(double doubleValue, boolean date1904)
           Convert the double value to the date time value.
static doublegetDoubleFromDateTime(com.aspose.cells.DateTime dateTime, boolean date1904)
           Convert the date time to double value.
static doublegetTextWidth(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.StringgetVersion()
           Get the release version.
static voidmergeFiles(java.lang.String[] files, java.lang.String cachedFile, java.lang.String destFile)
           Merges some large xls files to a xls file.
static java.lang.StringrowIndexToName(int row)
           Gets row name according to row index.
static introwNameToIndex(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.

getDPI/setDPI

public static double getDPI() / 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.

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.

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.

getCustomImplementationFactory/setCustomImplementationFactory

public static CustomImplementationFactory getCustomImplementationFactory() / 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,

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.