com.aspose.cells
Class Cell

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

public class Cell 
extends java.lang.Object

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);

public Worksheet getWorksheet()

Gets the parent worksheet.

public com.aspose.cells.DateTime getDateTimeValue()

Gets the DateTime value contained in the cell.

public int getRow()

Gets row number (zero based) of the cell.

Cell row number

public int getColumn()

Gets column number (zero based) of the cell.

public boolean isFormula()

Represents if the specified cell contains formula.

public int getType()

Represents cell value type. The value of the property is CellValueType integer constant.

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.

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.

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

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

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.

public int getNumberCategoryType()

Represents the category type of this cell's number formatting. The value of the property is NumberCategoryType integer constant.

public java.lang.String getDisplayStringValue()

Gets the formatted string value of this cell by cell's display style.

public int getIntValue()

Gets the integer value contained in the cell.

public double getDoubleValue()

Gets the double value contained in the cell.

public float getFloatValue()

Gets the float value contained in the cell.

public boolean getBoolValue()

Gets the boolean value contained in the cell.

public int getSharedStyleIndex()

Gets cell's shared style index in the style pool.

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");

public void setFormula(java.lang.String value)

public java.lang.String getFormulaLocal() / public void setFormulaLocal(java.lang.String value)

Get the locale formatted formula of the cell.

public void setFormulaLocal(java.lang.String value)

public java.lang.String getR1C1Formula() / public void setR1C1Formula(java.lang.String value)

Gets or sets a R1C1 formula of the Cell.

public void setR1C1Formula(java.lang.String value)

public boolean containsExternalLink()

Indicates whether this cell contains an external link. Only applies when the cell is a formula cell.

public boolean isArrayHeader()

Indicates the cell's formula is and array formula and it is the first cell of the array.

public boolean isArrayFormula()

Indicates whether the cell formula is an array formula.

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.

public boolean isSharedFormula()

Indicates whether the cell formula is part of shared formula.

public boolean isTableFormula()

Indicates whether this cell is part of table formula.

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.

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.

public void setValue(java.lang.Object value)

public boolean isStyleSet()

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

public boolean isMerged()

Checks if a cell is part of a merged range or not.

public Comment getComment()

Gets the comment of this cell.

If there is no comment applies to the cell, returns null.

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.

public void setHtmlString(java.lang.String value)

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.

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.

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.

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.

public void removeArrayFormula(boolean leaveNormalFormula)

Remove array formula.

Parameters:

leaveNormalFormula - True represents converting the array formula to normal formula.

public void copy(Cell cell)

Copies data from a source cell.

Parameters:

cell - Source Cell object.

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());

public boolean isRichText()

Indicates whether the cell string value is a rich text.

public com.aspose.cells.FontSetting[] getCharacters()

Returns all Characters objects that represents a range of characters within the cell text.

Returns:

All Characters objects

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

public void setCharacters(com.aspose.cells.FontSetting[] characters)

Sets rich text format of the cell.

Parameters:

characters - All Characters objects.

public Range getMergedRange()

Returns a Range object which represents a merged range.

Returns:

Range object. Null if this cell is not merged.

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:

public java.lang.String toString()

Returns a string represents the current Cell object.

Returns:

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.

public int hashCode()

Serves as a hash function for a particular type.

Returns:

A hash code for current Cell object.

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.

public ConditionalFormattingResult getConditionalFormattingResult()

Get the result of the conditional formatting.

Returns null if no conditional formatting is applied to this cell,

public Validation getValidation()

Gets the validation applied to this cell.

Returns:

public boolean getValidationValue()

Gets the value of validation which applied to this cell.

Returns:

public ListObject getTable()

Gets the table which contains this cell.

Returns:

public void calculate(CalculationOptions options)

Calculates the formula of the cell.

Parameters:

options - Options for calculation

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.

public void putValue(boolean boolValue)

Puts a boolean value into the cell.

Parameters:

boolValue -

public void putValue(int intValue)

Puts an integer value into the cell.

Parameters:

intValue - Input value

public void putValue(double doubleValue)

Puts a double value into the cell.

Parameters:

doubleValue - Input value

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

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.

public void putValue(java.lang.String stringValue)

Puts a string value into the cell.

Parameters:

stringValue - Input value

public void putValue(com.aspose.cells.DateTime dateTime)

Puts a DateTime value into the cell.

Parameters:

dateTime - Input value

public void putValue(java.lang.Object objectValue)

Puts an object value into the cell.

Parameters:

objectValue - input value

public java.lang.String getStringValue(int formatStrategy)

Gets the string value by specific formatted strategy.

Parameters:

formatStrategy - A CellValueFormatStrategy value. The formatted strategy.

Returns:

public int getWidthOfValue()
                   throws java.lang.Exception

Gets the width of the value in unit of pixels.

Returns:

public int getHeightOfValue()
                    throws java.lang.Exception

Gets the height of the value in unit of pixels.

Returns:

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

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.

public com.aspose.cells.FormatConditionCollection[] getFormatConditions()

Gets format conditions which applies to this cell.

Returns:

Returns FormatConditionCollection object

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.

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.

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.

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.

public void setStyle(Style style, StyleFlag flag)

Apply the cell style.

Parameters:

style - The cell style.

flag - The style flag.

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.

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.

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.

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.

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

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.

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

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

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.

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

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());
}

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

Example:

Workbook workbook = new Workbook();
Cells cells = workbook.getWorksheets().get(0).getCells();
cells.get("A1").setFormula("=B1+SUM(B1:B10)+[Book1.xls]Sheet1!B2");
cells.get("A2").setFormula("=IF(TRUE,B2,B1)");
Cell[] dependents = cells.get("B1").getDependents(true);
for (int i = 0; i < dependents.length; i++)
{
     System.out.println(dependents[i].getName());
}

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)

Example:

Workbook workbook = new Workbook();
Cells cells = workbook.getWorksheets().get(0).getCells();
cells.get("A2").setFormula("=IF(TRUE,B2,B1)");
workbook.getSettings().getFormulaSettings().setEnableCalculationChain(true);
workbook.calculateFormula();
Iterator en = cells.get("A2").getPrecedentsInCalculation();
System.out.println("A2's calculation precedents:");
while(en.hasNext())
{
    ReferredArea r = (ReferredArea)en.next();
    System.out.println(r);
}

public java.util.Iterator getDependentsInCalculation(boolean recursive)

Gets all cells whose calculated result depends on this cell.

To use this method, please make sure the workbook has been set with true value for FormulaSettings.EnableCalculationChain and has been fully calculated with this setting. 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 objects)

Example:

Workbook workbook = new Workbook();
Cells cells = workbook.getWorksheets().get(0).getCells();
cells.get("A1").setFormula("=B1+SUM(B1:B10)+[Book1.xls]Sheet1!B2");
cells.get("A2").setFormula("=IF(TRUE,B2,B1)");
workbook.getSettings().getFormulaSettings().setEnableCalculationChain(true);
workbook.calculateFormula();
Iterator en = cells.get("B1").getDependentsInCalculation(false);
System.out.println("B1's calculation dependents:");
while(en.hasNext())
{
    Cell c = (Cell)en.next();
    System.out.println(c.getName());
}
en = cells.get("B2").getDependentsInCalculation(false);
System.out.println("B2's calculation dependents:");
while(en.hasNext())
{
    Cell c = (Cell)en.next();
    System.out.println(c.getName());
}

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)

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)

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.