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

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

public class Cell 
extends java.lang.Object

Encapsulates the object that represents a single Workbook cell.

Example:

Workbook excel = new Workbook();
   Cells cells = excel.getWorksheets().get(0).getCells();
   
   //Put a string into a cell
   Cell cell = cells.get(0, 0);
   cell.putValue("Hello");
   
   String first = cell.getStringValue();
       
   //Put an integer into a cell
   cell = cells.get("B1");
   cell.putValue(12);
   
   int second = cell.getIntValue();
   
   //Put a double into a cell
   cell = cells.get(0, 2);
   cell.putValue(-1.234);
   
   double third = cell.getDoubleValue();
   
   //Put a formula into a cell
   cell = cells.get("D1");
   cell.setFormula("=B1 + C1");
   
   //Put a combined formula: "sum(average(b1,c1), b1)" to cell at b2
   cell = cells.get("b2");
   cell.setFormula("=sum(average(b1,c1), b1)");
   
   //Set style of a cell
   Style style = cell.getStyle();
   //Set background color
   style.setBackgroundColor(Color.getYellow());
   //Set format of a cell
   style.getFont().setName("Courier New");
   style.setVerticalAlignment(TextAlignmentType.TOP);
cell.setStyle(style);


Property Getters/Setters Summary
booleangetBoolValue()
           Gets the boolean value contained in the cell.
intgetColumn()
           Gets column number (zero based) of the cell.
CommentgetComment()
           Gets the comment of this cell.
booleancontainsExternalLink()
           Indicates whether this cell contains an external link. Only applies when the cell is a formula cell.
com.aspose.cells.DateTimegetDateTimeValue()
           Gets the DateTime value contained in the cell.
java.lang.StringgetDisplayStringValue()
           Gets the formatted string value of this cell by cell's display style.
doublegetDoubleValue()
           Gets the double value contained in the cell.
floatgetFloatValue()
           Gets the float value contained in the cell.
java.lang.StringgetFormula()
voidsetFormula(java.lang.String)
           Gets or sets a formula of the Cell.
java.lang.StringgetFormulaLocal()
voidsetFormulaLocal(java.lang.String)
           Get the locale formatted formula of the cell.
java.lang.StringgetHtmlString()
voidsetHtmlString(java.lang.String)
           Gets and sets the html string which contains data and some formats in this cell.
intgetIntValue()
           Gets the integer value contained in the cell.
booleanisArrayFormula()
           Indicates whether the cell formula is an array formula.
booleanisArrayHeader()
           Indicates the cell's formula is and array formula and it is the first cell of the array.
booleanisErrorValue()
           Checks if the value of this cell is an error.
booleanisFormula()
           Represents if the specified cell contains formula.
booleanisInArray()
           Indicates whether the cell formula is an array formula.
booleanisInTable()
           Indicates whether this cell is part of table formula.
booleanisMerged()
           Checks if a cell is part of a merged range or not.
booleanisNumericValue()
           Indicates whether the inner value of this cell is numeric(int, double and datetime)
booleanisSharedFormula()
           Indicates whether the cell formula is part of shared formula.
booleanisStyleSet()
           Indicates if the cell's style is set. If return false, it means this cell has a default cell format.
booleanisTableFormula()
           Indicates whether this cell is part of table formula.
java.lang.StringgetName()
           Gets the name of the cell.
intgetNumberCategoryType()
           Represents the category type of this cell's number formatting. The value of the property is NumberCategoryType integer constant.
java.lang.StringgetR1C1Formula()
voidsetR1C1Formula(java.lang.String)
           Gets or sets a R1C1 formula of the Cell.
intgetRow()
           Gets row number (zero based) of the cell.
intgetSharedStyleIndex()
           Gets cell's shared style index in the style pool.
java.lang.StringgetStringValue()
           Gets the string value contained in the cell. If the type of this cell is string, then return the string value itself. For other cell types, the formatted string value (formatted with the specified style of this cell) will be returned. The formatted cell value is same with what you can get from excel when copying a cell as text(such as copying cell to text editor or exporting to csv).
java.lang.StringgetStringValueWithoutFormat()
           Gets cell's value as string without any format.
intgetType()
           Represents cell value type. The value of the property is CellValueType integer constant.
java.lang.ObjectgetValue()
voidsetValue(java.lang.Object)
           Gets the value contained in this cell.
WorksheetgetWorksheet()
           Gets the parent worksheet.
 
Method Summary
voidcalculate(boolean ignoreError, ICustomFunction customFunction)
           Calculates the formula of the cell.
voidcalculate(CalculationOptions options)
           Calculates the formula of the cell.
FontSettingcharacters(int startIndex, int length)
           Returns a Characters object that represents a range of characters within the cell text.
voidcopy(Cell cell)
           Copies data from a source cell.
booleanequals(Cell cell)
           Checks whether this object refers to the same cell with another cell object.
booleanequals(java.lang.Object obj)
           Checks whether this object refers to the same cell with another.
CellAreagetArrayRange()
           Gets the array range if the cell's formula is an array formula.
com.aspose.cells.FontSetting[]getCharacters()
           Returns all Characters objects that represents a range of characters within the cell text.
com.aspose.cells.FontSetting[]getCharacters(boolean flag)
           Returns all Characters objects that represents a range of characters within the cell text.
ConditionalFormattingResultgetConditionalFormattingResult()
           Get the result of the conditional formatting.
com.aspose.cells.Cell[]getDependents(boolean isAll)
           Get all cells whose formula references to this cell directly.
java.util.IteratorgetDependentsInCalculation(boolean recursive)
           Gets all cells whose calculated result depends on this cell.
StylegetDisplayStyle()
           Gets the display style of the cell. If this cell is also affected by other settings such as conditional formatting, list objects, etc., then the display style may be different from cell.GetStyle().
StylegetDisplayStyle(boolean includeMergedBorders)
           Gets the display style of the cell. If the cell is conditional formatted, the display style is not same as the cell.GetStyle().
com.aspose.cells.FormatConditionCollection[]getFormatConditions()
           Gets format conditions which applies to this cell.
java.lang.StringgetFormula(boolean isR1C1, boolean isLocal)
           Get the formula of this cell.
intgetHeightOfValue()
           Gets the height of the value in unit of pixels.
java.lang.StringgetHtmlString(boolean html5)
           Gets the html string which contains data and some formats in this cell.
java.util.IteratorgetLeafs()
           Get all cells which reference to this cell directly and need to be updated when this cell is modified.
java.util.IteratorgetLeafs(boolean recursive)
           Get all cells which will be updated when this cell is modified.
RangegetMergedRange()
           Returns a Range object which represents a merged range.
ReferredAreaCollectiongetPrecedents()
           Gets all references appearing in this cell's formula.
java.util.IteratorgetPrecedentsInCalculation()
           Gets all precedents(reference to cells in current workbook) used by this cell's formula while calculating it.
java.lang.StringgetStringValue(int formatStrategy)
           Gets the string value by specific formatted strategy.
StylegetStyle()
           Gets the cell style.
StylegetStyle(boolean checkBorders)
           If checkBorders is true, check whether other cells' borders will effect the style of this cell.
ListObjectgetTable()
           Gets the table which contains this cell.
ValidationgetValidation()
           Gets the validation applied to this cell.
booleangetValidationValue()
           Gets the value of validation which applied to this cell.
intgetWidthOfValue()
           Gets the width of the value in unit of pixels.
inthashCode()
           Serves as a hash function for a particular type.
booleanisRichText()
           Indicates whether the cell string value is a rich text.
voidputValue(boolean boolValue)
           Puts a boolean value into the cell.
voidputValue(com.aspose.cells.DateTime dateTime)
           Puts a DateTime value into the cell.
voidputValue(double doubleValue)
           Puts a double value into the cell.
voidputValue(int intValue)
           Puts an integer value into the cell.
voidputValue(java.lang.Object objectValue)
           Puts an object value into the cell.
voidputValue(java.lang.String stringValue)
           Puts a string value into the cell.
voidputValue(java.lang.String stringValue, boolean isConverted)
           Puts a string value into the cell and converts the value to other data type if appropriate.
voidputValue(java.lang.String stringValue, boolean isConverted, boolean setStyle)
           Puts a value into the cell, if appropriate the value will be converted to other data type and cell's number format will be reset.
voidremoveArrayFormula(boolean leaveNormalFormula)
           Remove array formula.
voidsetArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber)
           Sets an array formula(legacy array formula entered via CTRL+SHIFT+ENTER in ms excel) to a range of cells.
voidsetArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber, boolean isR1C1, boolean isLocal)
           Sets an array formula to a range of cells.
voidsetArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber, FormulaParseOptions options)
           Sets an array formula to a range of cells.
voidsetArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber, FormulaParseOptions options, java.lang.Object[][] values)
           Sets an array formula to a range of cells.
voidsetCharacters(com.aspose.cells.FontSetting[] characters)
           Sets rich text format of the cell.
CellAreasetDynamicArrayFormula(java.lang.String arrayFormula, FormulaParseOptions options, boolean calculateValue)
           Sets dynamic array formula and make the formula spill into neighboring cells if possible.
CellAreasetDynamicArrayFormula(java.lang.String arrayFormula, FormulaParseOptions options, java.lang.Object[][] values, boolean calculateRange, boolean calculateValue)
           Sets dynamic array formula and make the formula spill into neighboring cells if possible.
voidsetFormula(java.lang.String formula, boolean isR1C1, boolean isLocal, java.lang.Object value)
           Set the formula and the value of the formula.
voidsetFormula(java.lang.String formula, FormulaParseOptions options, java.lang.Object value)
           Set the formula and the value of the formula.
voidsetFormula(java.lang.String formula, java.lang.Object value)
           Set the formula and the value of the formula.
voidsetSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber)
           Sets a formula to a range of cells.
voidsetSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber, boolean isR1C1, boolean isLocal)
           Sets a formula to a range of cells.
voidsetSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber, FormulaParseOptions options)
           Sets a formula to a range of cells.
voidsetSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber, FormulaParseOptions options, java.lang.Object[][] values)
           Sets a formula to a range of cells.
voidsetStyle(Style style)
           Sets the cell style.
voidsetStyle(Style style, boolean explicitFlag)
           Apply the cell style.
voidsetStyle(Style style, StyleFlag flag)
           Apply the cell style.
java.lang.StringtoString()
           Returns a string represents the current Cell object.
 

Property Getters/Setters Detail

getWorksheet

public Worksheet getWorksheet()
Gets the parent worksheet.

getDateTimeValue

public com.aspose.cells.DateTime getDateTimeValue()
Gets the DateTime value contained in the cell.

getRow

public int getRow()
Gets row number (zero based) of the cell. Cell row number

getColumn

public int getColumn()
Gets column number (zero based) of the cell.

isFormula

public boolean isFormula()
Represents if the specified cell contains formula.

getType

public int getType()
Represents cell value type. The value of the property is CellValueType integer constant.

getName

public java.lang.String getName()
Gets the name of the cell. A cell name includes its column letter and row number. For example, the name of a cell in row 0 and column 0 is A1.

isErrorValue

public boolean isErrorValue()
Checks if the value of this cell is an error. Also applies to formula cell to check whether the calculated result is an error.

isNumericValue

public boolean isNumericValue()
Indicates whether the inner value of this cell is numeric(int, double and datetime) Also applies to formula cell to check the calculated result

getStringValue

public java.lang.String getStringValue()
Gets the string value contained in the cell. If the type of this cell is string, then return the string value itself. For other cell types, the formatted string value (formatted with the specified style of this cell) will be returned. The formatted cell value is same with what you can get from excel when copying a cell as text(such as copying cell to text editor or exporting to csv).

getStringValueWithoutFormat

public java.lang.String getStringValueWithoutFormat()
Gets cell's value as string without any format. NOTE: This method is now obsolete. Instead, User should get the value object and format it according to the value type and the specific requirement. This property will be removed 12 months later since December 2020. Aspose apologizes for any inconvenience you may have experienced.

getNumberCategoryType

public int getNumberCategoryType()
Represents the category type of this cell's number formatting. The value of the property is NumberCategoryType integer constant.

getDisplayStringValue

public java.lang.String getDisplayStringValue()
Gets the formatted string value of this cell by cell's display style.

getIntValue

public int getIntValue()
Gets the integer value contained in the cell.

getDoubleValue

public double getDoubleValue()
Gets the double value contained in the cell.

getFloatValue

public float getFloatValue()
Gets the float value contained in the cell.

getBoolValue

public boolean getBoolValue()
Gets the boolean value contained in the cell.

getSharedStyleIndex

public int getSharedStyleIndex()
Gets cell's shared style index in the style pool.

getFormula/setFormula

public java.lang.String getFormula() / public void setFormula(java.lang.String value)
Gets or sets a formula of the Cell. A formula string always begins with an equal sign (=). And please always use comma(,) as parameters delimiter, such as "=SUM(A1, E1, H2)".

Example:

Workbook excel = new Workbook();
Cells cells = excel.getWorksheets().get(0).getCells();
cells.get("B6").setFormula("=SUM(B2:B5, E1) + sheet1!A1");

getFormulaLocal/setFormulaLocal

public java.lang.String getFormulaLocal() / public void setFormulaLocal(java.lang.String value)
Get the locale formatted formula of the cell.

getR1C1Formula/setR1C1Formula

public java.lang.String getR1C1Formula() / public void setR1C1Formula(java.lang.String value)
Gets or sets a R1C1 formula of the Cell.

containsExternalLink

public boolean containsExternalLink()
Indicates whether this cell contains an external link. Only applies when the cell is a formula cell.

isArrayHeader

public boolean isArrayHeader()
Indicates the cell's formula is and array formula and it is the first cell of the array.

isArrayFormula

public boolean isArrayFormula()
Indicates whether the cell formula is an array formula.

isInArray

public boolean isInArray()
Indicates whether the cell formula is an array formula. NOTE: This class is now obsolete. Instead, please use Cell.IsArrayFormula to check whether the cell formula is an array formula. This property will be removed 12 months later since May 2018. Aspose apologizes for any inconvenience you may have experienced.

isSharedFormula

public boolean isSharedFormula()
Indicates whether the cell formula is part of shared formula.

isTableFormula

public boolean isTableFormula()
Indicates whether this cell is part of table formula.

isInTable

public boolean isInTable()
Indicates whether this cell is part of table formula. NOTE: This class is now obsolete. Instead, please use Cell.IsTableFormula to check whether the cell formula is part of table formula. This property will be removed 12 months later since May 2018. Aspose apologizes for any inconvenience you may have experienced.

getValue/setValue

public java.lang.Object getValue() / public void setValue(java.lang.Object value)
Gets the value contained in this cell. Possible type:

null,

Boolean,

DateTime,

Double,

Integer

String.

For int value, it may be returned as an Integer object or a Double object. And there is no guarantee that the returned value will be kept as the same type of object always.

isStyleSet

public boolean isStyleSet()
Indicates if the cell's style is set. If return false, it means this cell has a default cell format.

isMerged

public boolean isMerged()
Checks if a cell is part of a merged range or not.

getComment

public Comment getComment()
Gets the comment of this cell. If there is no comment applies to the cell, returns null.

getHtmlString/setHtmlString

public java.lang.String getHtmlString() / public void setHtmlString(java.lang.String value)
Gets and sets the html string which contains data and some formats in this cell.

Method Detail

setDynamicArrayFormula

public CellArea setDynamicArrayFormula(java.lang.String arrayFormula, FormulaParseOptions options, boolean calculateValue)
Sets dynamic array formula and make the formula spill into neighboring cells if possible.
Parameters:
arrayFormula - the formula expression
options - options to parse formula. "Parse" option will be ignored and the formula will always be parsed immediately
calculateValue - whether calculate this dynamic array formula for those cells in the spilled range.
Returns:
the range that the formula should spill into.

setDynamicArrayFormula

public CellArea setDynamicArrayFormula(java.lang.String arrayFormula, FormulaParseOptions options, java.lang.Object[][] values, boolean calculateRange, boolean calculateValue)
Sets dynamic array formula and make the formula spill into neighboring cells if possible.
Parameters:
arrayFormula - the formula expression
options - options to parse formula. "Parse" option will be ignored and the formula will always be parsed immediately
values - values for those cells with given dynamic array formula
calculateRange - Whether calculate the spilled range for this dynamic array formula. If the "values" parameter is not null and this flag is false, then the spilled range's height will be values.Length and width will be values[0].Length.
calculateValue - whether calculate this dynamic array formula for those cells in the spilled range when "values" is null or corresponding item in "values" for one cell is null.
Returns:
the range that the formula should spill into.

setArrayFormula

public void setArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber)
Sets an array formula(legacy array formula entered via CTRL+SHIFT+ENTER in ms excel) to a range of cells.
Parameters:
arrayFormula - Array formula.
rowNumber - Number of rows to populate result of the array formula.
columnNumber - Number of columns to populate result of the array formula.

setSharedFormula

public void setSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber)
Sets a formula to a range of cells.
Parameters:
sharedFormula - Shared formula.
rowNumber - Number of rows to populate the formula.
columnNumber - Number of columns to populate the formula.

removeArrayFormula

public void removeArrayFormula(boolean leaveNormalFormula)
Remove array formula.
Parameters:
leaveNormalFormula - True represents converting the array formula to normal formula.

copy

public void copy(Cell cell)
Copies data from a source cell.
Parameters:
cell - Source Cell object.

characters

public FontSetting characters(int startIndex, int length)
Returns a Characters object that represents a range of characters within the cell text. This method only works on cell with string value.
Parameters:
startIndex - The index of the start of the character.
length - The number of characters.
Returns:
Characters object.

Example:

Workbook excel = new Workbook();
   Cells cells = excel.getWorksheets().get(0).getCells();
cells.get("A1").putValue("Helloworld");
cells.get("A1").characters(5, 5).getFont().setBold(true);
cells.get("A1").characters(5, 5).getFont().setColor(Color.getBlue());

isRichText

public boolean isRichText()
Indicates whether the cell string value is a rich text.

getCharacters

public com.aspose.cells.FontSetting[] getCharacters()
Returns all Characters objects that represents a range of characters within the cell text.
Returns:
All Characters objects

getCharacters

public com.aspose.cells.FontSetting[] getCharacters(boolean flag)
Returns all Characters objects that represents a range of characters within the cell text.
Parameters:
flag - Indicates whether applying table style to the cell if the cell is in the table.
Returns:
All Characters objects

setCharacters

public void setCharacters(com.aspose.cells.FontSetting[] characters)
Sets rich text format of the cell.
Parameters:
characters - All Characters objects.

getMergedRange

public Range getMergedRange()
Returns a Range object which represents a merged range.
Returns:
Range object. Null if this cell is not merged.

getHtmlString

public java.lang.String getHtmlString(boolean html5)
                    throws java.lang.Exception
Gets the html string which contains data and some formats in this cell.
Parameters:
html5 - Indicates whether the value is compatible for html5
Returns:

toString

public java.lang.String toString()
Returns a string represents the current Cell object.
Returns:

equals

public boolean equals(java.lang.Object obj)
Checks whether this object refers to the same cell with another.
Parameters:
obj - another object
Returns:
true if two objects refers to the same cell.

hashCode

public int hashCode()
Serves as a hash function for a particular type.
Returns:
A hash code for current Cell object.

equals

public boolean equals(Cell cell)
Checks whether this object refers to the same cell with another cell object.
Parameters:
cell - another cell object
Returns:
true if two cell objects refers to the same cell.

getConditionalFormattingResult

public ConditionalFormattingResult getConditionalFormattingResult()
Get the result of the conditional formatting. Returns null if no conditional formatting is applied to this cell,

getValidation

public Validation getValidation()
Gets the validation applied to this cell.
Returns:

getValidationValue

public boolean getValidationValue()
Gets the value of validation which applied to this cell.
Returns:

getTable

public ListObject getTable()
Gets the table which contains this cell.
Returns:

calculate

public void calculate(CalculationOptions options)
Calculates the formula of the cell.
Parameters:
options - Options for calculation

calculate

public void calculate(boolean ignoreError, ICustomFunction customFunction)
Calculates the formula of the cell. NOTE: This member is now obsolete. Instead, please use Calculate(CalculationOptions) method. This method will be removed 12 months later since August 2020. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
ignoreError - Indicates if hide the error in calculating formulas. The error may be unsupported function, external links, etc.
customFunction - The custom formula calculation functions to extend the calculation engine.

putValue

public void putValue(boolean boolValue)
Puts a boolean value into the cell.
Parameters:
boolValue -

putValue

public void putValue(int intValue)
Puts an integer value into the cell.
Parameters:
intValue - Input value

putValue

public void putValue(double doubleValue)
Puts a double value into the cell.
Parameters:
doubleValue - Input value

putValue

public void putValue(java.lang.String stringValue, boolean isConverted, boolean setStyle)
Puts a value into the cell, if appropriate the value will be converted to other data type and cell's number format will be reset.
Parameters:
stringValue - Input value
isConverted - True: converted to other data type if appropriate.
setStyle - True: set the number format to cell's style when converting to other data type

putValue

public void putValue(java.lang.String stringValue, boolean isConverted)
Puts a string value into the cell and converts the value to other data type if appropriate.
Parameters:
stringValue - Input value
isConverted - True: converted to other data type if appropriate.

putValue

public void putValue(java.lang.String stringValue)
Puts a string value into the cell.
Parameters:
stringValue - Input value

putValue

public void putValue(com.aspose.cells.DateTime dateTime)
Puts a DateTime value into the cell.
Parameters:
dateTime - Input value

putValue

public void putValue(java.lang.Object objectValue)
Puts an object value into the cell.
Parameters:
objectValue - input value

getStringValue

public java.lang.String getStringValue(int formatStrategy)
Gets the string value by specific formatted strategy.
Parameters:
formatStrategy - A CellValueFormatStrategy value. The formatted strategy.
Returns:

getWidthOfValue

public int getWidthOfValue()
                   throws java.lang.Exception
Gets the width of the value in unit of pixels.
Returns:

getHeightOfValue

public int getHeightOfValue()
                    throws java.lang.Exception
Gets the height of the value in unit of pixels.
Returns:

getDisplayStyle

public Style getDisplayStyle()
Gets the display style of the cell. If this cell is also affected by other settings such as conditional formatting, list objects, etc., then the display style may be different from cell.GetStyle().

getDisplayStyle

public Style getDisplayStyle(boolean includeMergedBorders)
Gets the display style of the cell. If the cell is conditional formatted, the display style is not same as the cell.GetStyle().
Parameters:
includeMergedBorders - Indicates whether checking borders of the merged cells.

getFormatConditions

public com.aspose.cells.FormatConditionCollection[] getFormatConditions()
Gets format conditions which applies to this cell.
Returns:
Returns FormatConditionCollection object

getStyle

public Style getStyle()
Gets the cell style. To change the style of the cell, please call Cell.SetStyle() method after changing the style.
Returns:
Style object.

getStyle

public Style getStyle(boolean checkBorders)
If checkBorders is true, check whether other cells' borders will effect the style of this cell.
Parameters:
checkBorders - Check other cells' borders
Returns:
Style object.

setStyle

public void setStyle(Style style)
Sets the cell style. If the border settings are changed, the border of adjust cells will be updated too.
Parameters:
style - The cell style.

setStyle

public void setStyle(Style style, boolean explicitFlag)
Apply the cell style.
Parameters:
style - The cell style.
explicitFlag - True, only overwriting formatting which is explicitly set.

setStyle

public void setStyle(Style style, StyleFlag flag)
Apply the cell style.
Parameters:
style - The cell style.
flag - The style flag.

setFormula

public void setFormula(java.lang.String formula, java.lang.Object value)
Set the formula and the value of the formula.
Parameters:
formula - The formula.
value - The value of the formula.

getFormula

public java.lang.String getFormula(boolean isR1C1, boolean isLocal)
Get the formula of this cell.
Parameters:
isR1C1 - Whether the formula needs to be formatted as R1C1.
isLocal - Whether the formula needs to be formatted by locale.
Returns:
the formula of this cell.

setFormula

public void setFormula(java.lang.String formula, boolean isR1C1, boolean isLocal, java.lang.Object value)
Set the formula and the value of the formula. NOTE: This class is now obsolete. Instead, please use Cell.SetFormula(string,FormulaParseOptions,object). This property will be removed 12 months later since December 2019. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
formula - The formula.
isR1C1 - Whether the formula is R1C1 formula.
isLocal - Whether the formula is locale formatted.
value - The value of the formula.

setFormula

public void setFormula(java.lang.String formula, FormulaParseOptions options, java.lang.Object value)
Set the formula and the value of the formula.
Parameters:
formula - The formula.
options - Options for parsing the formula.
value - The value of the formula.

setArrayFormula

public void setArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber, boolean isR1C1, boolean isLocal)
Sets an array formula to a range of cells. NOTE: This class is now obsolete. Instead, please use Cell.SetArrayFormula(string,int,int,FormulaParseOptions). This property will be removed 12 months later since December 2019. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
arrayFormula - Array formula.
rowNumber - Number of rows to populate result of the array formula.
columnNumber - Number of columns to populate result of the array formula.
isR1C1 - whether the formula is R1C1 formula
isLocal - whether the formula is locale formatted

setArrayFormula

public void setArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber, FormulaParseOptions options)
Sets an array formula to a range of cells.
Parameters:
arrayFormula - Array formula.
rowNumber - Number of rows to populate result of the array formula.
columnNumber - Number of columns to populate result of the array formula.
options - Options for parsing the formula.

setArrayFormula

public void setArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber, FormulaParseOptions options, java.lang.Object[][] values)
Sets an array formula to a range of cells.
Parameters:
arrayFormula - Array formula.
rowNumber - Number of rows to populate result of the array formula.
columnNumber - Number of columns to populate result of the array formula.
options - Options for parsing the formula.
values - values for those cells with given array formula

setSharedFormula

public void setSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber, boolean isR1C1, boolean isLocal)
Sets a formula to a range of cells. NOTE: This class is now obsolete. Instead, please use Cell.SetSharedFormula(string,int,int,FormulaParseOptions). This property will be removed 12 months later since December 2019. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
sharedFormula - Shared formula.
rowNumber - Number of rows to populate the formula.
columnNumber - Number of columns to populate the formula.
isR1C1 - whether the formula is R1C1 formula
isLocal - whether the formula is locale formatted

setSharedFormula

public void setSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber, FormulaParseOptions options)
Sets a formula to a range of cells.
Parameters:
sharedFormula - Shared formula.
rowNumber - Number of rows to populate the formula.
columnNumber - Number of columns to populate the formula.
options - Options for parsing the formula.

setSharedFormula

public void setSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber, FormulaParseOptions options, java.lang.Object[][] values)
Sets a formula to a range of cells.
Parameters:
sharedFormula - Shared formula.
rowNumber - Number of rows to populate the formula.
columnNumber - Number of columns to populate the formula.
options - Options for parsing the formula.
values - values for those cells with given shared formula

getPrecedents

public ReferredAreaCollection getPrecedents()
Gets all references appearing in this cell's formula.
  • Returns null if this is not a formula cell.
  • All references appearing in this cell's formula will be returned no matter they are referenced or not while calculating. For example, although cell A2 in formula "=IF(TRUE,A1,A2)" is not used while calculating, it is still taken as the formula's precedents.
  • To get those references which influence the calculation only, please use getPrecedentsInCalculation().
Returns:
Collection of all references appearing in this cell's formula.

Example:

Workbook workbook = new Workbook();
Cells cells = workbook.getWorksheets().get(0).getCells();
cells.get("A1").setFormula("= B1 + SUM(B1:B10) + [Book1.xls]Sheet1!A1");
 ReferredAreaCollection areas = cells.get("A1").getPrecedents();
for (int i = 0; i < areas.getCount(); i++)
{
    ReferredArea area = areas.get(i);
     StringBuilder stringBuilder = new StringBuilder();
     if (area.isExternalLink())
     {
         stringBuilder.append("[");
          stringBuilder.append(area.getExternalFileName());
          stringBuilder.append("]");
      }
      stringBuilder.append(area.getSheetName());
      stringBuilder.append("!");
      stringBuilder.append(CellsHelper.cellIndexToName(area.getStartRow(), area.getStartColumn()));
      if (area.isArea())
       {
           stringBuilder.append(":");
           stringBuilder.append(CellsHelper.cellIndexToName(area.getEndRow(), area.getEndColumn()));
       }
       System.out.println(stringBuilder.toString());
    }
 workbook.save("C:\\Book2.xls");

getDependents

public com.aspose.cells.Cell[] getDependents(boolean isAll)
Get all cells whose formula references to this cell directly.
  • If one reference containing this cell appears in one cell's formula, that cell will be taken as the dependent of this cell, no matter the reference or this cell is used or not while calculating. For example, although cell A2 in formula "=IF(TRUE,A1,A2)" is not used while calculating, this formula is still be taken as A2's dependent.
  • To get those formulas whose calculated results depend on this cell, please use getDependentsInCalculation(boolean).
  • When tracing dependents for one cell, all formulas in the workbook or worksheet will be analized and checked. So it is a time consumed process. If user need to trace dependents for lots of cells, using this method will cause poor performance. For performance consideration, user should use getDependentsInCalculation(boolean) instead. Or, user may gather precedents map of all cells by getPrecedents() firstly, and then build the dependents map according to the precedents map.
Parameters:
isAll - Indicates whether check formulas in other worksheets

getPrecedentsInCalculation

public java.util.Iterator getPrecedentsInCalculation()
Gets all precedents(reference to cells in current workbook) used by this cell's formula while calculating it. This method can only work with the situation that FormulaSettings.EnableCalculationChain is true for the workbook and the workbook has been fully calculated. If this cell is not a formula or it does not reference to any other cells, null will be returned.
Returns:
Enumerator to enumerate all references(ReferredArea)

getDependentsInCalculation

public java.util.Iterator getDependentsInCalculation(boolean recursive)
Gets all cells whose calculated result depends on this cell. This method can only work with the situation that FormulaSettings.EnableCalculationChain is true for the workbook and the workbook has been fully calculated. If there is no formula reference to this cell, null will be returned.
Parameters:
recursive - Whether returns those dependents which do not reference to this cell directly but reference to other leafs of this cell
Returns:
Enumerator to enumerate all dependents(Cell)

getLeafs

public java.util.Iterator getLeafs()
Get all cells which reference to this cell directly and need to be updated when this cell is modified. NOTE: This class is now obsolete. Instead, please use Cell.GetDependentsInCalculation(bool) to get all dependents in calculation chain. This property will be removed 12 months later since May 2022. Aspose apologizes for any inconvenience you may have experienced.
Returns:
Enumerator to enumerate all dependents(Cell)

getLeafs

public java.util.Iterator getLeafs(boolean recursive)
Get all cells which will be updated when this cell is modified. NOTE: This class is now obsolete. Instead, please use Cell.GetDependentsInCalculation(bool) to get all dependents in calculation chain. This property will be removed 12 months later since May 2022. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
recursive - Whether returns those leafs that do not reference to this cell directly but reference to other leafs of this cell
Returns:
Enumerator to enumerate all dependents(Cell)

getArrayRange

public CellArea getArrayRange()
Gets the array range if the cell's formula is an array formula. Only applies when the cell's formula is an array formula
Returns:
The array range.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.