Cell (Aspose.Cells for Java)

java.lang.Object
- 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);

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`calculate(boolean ignoreError, ICustomFunction customFunction)` Deprecated. Use Calculate(CalculationOptions) method instead.
`void`	`calculate(CalculationOptions options)` Calculates the formula of the cell.
`FontSetting`	`characters(int startIndex, int length)` Returns a Characters object that represents a range of characters within the cell text.
`boolean`	`containsExternalLink()` Indicates whether this cell contains an external link.
`void`	`copy(Cell cell)` Copies data from a source cell.
`boolean`	`equals(Cell cell)` Checks whether this object refers to the same cell with another cell object.
`boolean`	`equals(java.lang.Object obj)` Checks whether this object refers to the same cell with another.
`CellArea`	`getArrayRange()` Gets the array range if the cell's formula is an array formula.
`boolean`	`getBoolValue()` Gets the boolean value contained in the cell.
`FontSetting[]`	`getCharacters()` Returns all Characters objects that represents a range of characters within the cell text.
`FontSetting[]`	`getCharacters(boolean flag)` Returns all Characters objects that represents a range of characters within the cell text.
`int`	`getColumn()` Gets column number (zero based) of the cell.
`Comment`	`getComment()` Gets the comment of this cell.
`ConditionalFormattingResult`	`getConditionalFormattingResult()` Get the result of the conditional formatting.
`DateTime`	`getDateTimeValue()` Gets the DateTime value contained in the cell.
`Cell[]`	`getDependents(boolean isAll)` Get all cells whose formula references to this cell directly.
`java.util.Iterator`	`getDependentsInCalculation(boolean recursive)` Gets all cells whose calculated result depends on this cell.
`java.lang.String`	`getDisplayStringValue()` Gets the formatted string value of this cell by cell's display style.
`Style`	`getDisplayStyle()` Gets the display style of the cell.
`Style`	`getDisplayStyle(boolean includeMergedBorders)` Gets the display style of the cell.
`double`	`getDoubleValue()` Gets the double value contained in the cell.
`float`	`getFloatValue()` Gets the float value contained in the cell.
`FormatConditionCollection[]`	`getFormatConditions()` Gets format conditions which applies to this cell.
`java.lang.String`	`getFormula()` Gets a formula of the `Cell`.
`java.lang.String`	`getFormula(boolean isR1C1, boolean isLocal)` Get the formula of this cell.
`java.lang.String`	`getFormulaLocal()` Get the locale formatted formula of the cell.
`int`	`getHeightOfValue()` Gets the height of the value in unit of pixels.
`java.lang.String`	`getHtmlString()` Gets the html string which contains data and some formats in this cell.
`java.lang.String`	`getHtmlString(boolean html5)` Gets the html string which contains data and some formats in this cell.
`int`	`getIntValue()` Gets the integer value contained in the cell.
`java.util.Iterator`	`getLeafs()` Deprecated. Use GetDependentsInCalculation(bool) instead.
`java.util.Iterator`	`getLeafs(boolean recursive)` Deprecated. Use GetDependentsInCalculation(bool) instead.
`Range`	`getMergedRange()` Returns a `Range` object which represents a merged range.
`java.lang.String`	`getName()` Gets the name of the cell.
`int`	`getNumberCategoryType()` Represents the category type of this cell's number formatting.
`ReferredAreaCollection`	`getPrecedents()` Gets all references appearing in this cell's formula.
`java.util.Iterator`	`getPrecedentsInCalculation()` Gets all precedents(reference to cells in current workbook) used by this cell's formula while calculating it.
`java.lang.String`	`getR1C1Formula()` Gets a R1C1 formula of the `Cell`.
`int`	`getRow()` Gets row number (zero based) of the cell.
`int`	`getSharedStyleIndex()` Gets cell's shared style index in the style pool.
`java.lang.String`	`getStringValue()` Gets the string value contained in the cell.
`java.lang.String`	`getStringValue(int formatStrategy)` Gets the string value by specific formatted strategy.
`java.lang.String`	`getStringValueWithoutFormat()` Deprecated. Use GetStringValue(CellValueFormatStrategy) with CellValueFormatStrategy.None instead.
`Style`	`getStyle()` Gets the cell style.
`Style`	`getStyle(boolean checkBorders)` If checkBorders is true, check whether other cells' borders will effect the style of this cell.
`ListObject`	`getTable()` Gets the table which contains this cell.
`int`	`getType()` Represents cell value type.
`Validation`	`getValidation()` Gets the validation applied to this cell.
`boolean`	`getValidationValue()` Gets the value of validation which applied to this cell.
`java.lang.Object`	`getValue()` Gets the value contained in this cell.
`int`	`getWidthOfValue()` Gets the width of the value in unit of pixels.
`Worksheet`	`getWorksheet()` Gets the parent worksheet.
`boolean`	`hasCustomStyle()` Indicates whether this cell has custom style settings(different from the default one inherited from corresponding row, column, or workbook).
`int`	`hashCode()` Serves as a hash function for a particular type.
`void`	`insertText(int index, java.lang.String text)` Insert some characters to the cell.
`boolean`	`isArrayFormula()` Indicates whether the cell formula is an array formula.
`boolean`	`isArrayHeader()` Indicates the cell's formula is and array formula and it is the first cell of the array.
`boolean`	`isDynamicArrayFormula()` Indicates whether the cell's formula is dynamic array formula(true) or legacy array formula(false).
`boolean`	`isErrorValue()` Checks if the value of this cell is an error.
`boolean`	`isFormula()` Represents if the specified cell contains formula.
`boolean`	`isInArray()` Deprecated. Use IsArrayFormula instead.
`boolean`	`isInTable()` Deprecated. Use IsTableFormula instead.
`boolean`	`isMerged()` Checks if a cell is part of a merged range or not.
`boolean`	`isNumericValue()` Indicates whether the inner value of this cell is numeric(int, double and datetime)
`boolean`	`isRichText()` Indicates whether the cell string value is a rich text.
`boolean`	`isSharedFormula()` Indicates whether the cell formula is part of shared formula.
`boolean`	`isStyleSet()` Indicates if the cell's style is set.
`boolean`	`isTableFormula()` Indicates whether this cell is part of table formula.
`void`	`putValue(boolean boolValue)` Puts a boolean value into the cell.
`void`	`putValue(DateTime dateTime)` Puts a DateTime value into the cell.
`void`	`putValue(double doubleValue)` Puts a double value into the cell.
`void`	`putValue(int intValue)` Puts an integer value into the cell.
`void`	`putValue(java.lang.Object objectValue)` Puts an object value into the cell.
`void`	`putValue(java.lang.String stringValue)` Puts a string value into the cell.
`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.
`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.
`void`	`removeArrayFormula(boolean leaveNormalFormula)` Remove array formula.
`void`	`replace(java.lang.String placeHolder, java.lang.String newValue, ReplaceOptions options)` Replace text of the cell with options.
`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.
`void`	`setArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber, boolean isR1C1, boolean isLocal)` Deprecated. Use FormulaParseOptions for more options instead.
`void`	`setArrayFormula(java.lang.String arrayFormula, int rowNumber, int columnNumber, FormulaParseOptions options)` Sets an array formula to a range of cells.
`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.
`void`	`setCharacters(FontSetting[] characters)` Sets rich text format of the cell.
`CellArea`	`setDynamicArrayFormula(java.lang.String arrayFormula, FormulaParseOptions options, boolean calculateValue)` Sets dynamic array formula and make the formula spill into neighboring cells if possible.
`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.
`CellArea`	`setDynamicArrayFormula(java.lang.String arrayFormula, FormulaParseOptions options, java.lang.Object[][] values, boolean calculateRange, boolean calculateValue, CalculationOptions copts)` Sets dynamic array formula and make the formula spill into neighboring cells if possible.
`void`	`setFormula(java.lang.String value)` Sets a formula of the `Cell`.
`void`	`setFormula(java.lang.String formula, boolean isR1C1, boolean isLocal, java.lang.Object value)` Deprecated. Use FormulaParseOptions for more options instead.
`void`	`setFormula(java.lang.String formula, FormulaParseOptions options, java.lang.Object value)` Set the formula and the value(calculated result) of the formula.
`void`	`setFormula(java.lang.String formula, java.lang.Object value)` Set the formula and the value(calculated result) of the formula.
`void`	`setFormulaLocal(java.lang.String value)` Get the locale formatted formula of the cell.
`void`	`setHtmlString(java.lang.String value)` Sets the html string which contains data and some formats in this cell.
`void`	`setR1C1Formula(java.lang.String value)` Sets a R1C1 formula of the `Cell`.
`void`	`setSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber)` Sets shared formulas to a range of cells.
`void`	`setSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber, boolean isR1C1, boolean isLocal)` Deprecated. Use FormulaParseOptions for more options instead.
`void`	`setSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber, FormulaParseOptions options)` Sets shared formulas to a range of cells.
`void`	`setSharedFormula(java.lang.String sharedFormula, int rowNumber, int columnNumber, FormulaParseOptions options, java.lang.Object[][] values)` Sets shared formulas to a range of cells.
`void`	`setStyle(Style style)` Sets the cell style.
`void`	`setStyle(Style style, boolean explicitFlag)` Apply the cell style.
`void`	`setStyle(Style style, StyleFlag flag)` Apply the cell style.
`void`	`setTableFormula(int rowNumber, int columnNumber, int rowIndexOfInputCell, int columnIndexOfInputCell, boolean isRowInput, java.lang.Object[][] values)` Create one-variable data table for given range starting from this cell.
`void`	`setTableFormula(int rowNumber, int columnNumber, int rowIndexOfRowInputCell, int columnIndexOfRowInputCell, int rowIndexOfColumnInputCell, int columnIndexOfColumnInputCell, java.lang.Object[][] values)` Create two-variable data table for given range starting from this cell.
`void`	`setTableFormula(int rowNumber, int columnNumber, java.lang.String inputCell, boolean isRowInput, java.lang.Object[][] values)` Create one-variable data table for given range starting from this cell.
`void`	`setTableFormula(int rowNumber, int columnNumber, java.lang.String rowInputCell, java.lang.String columnInputCell, java.lang.Object[][] values)` Create two-variable data table for given range starting from this cell.
`void`	`setValue(java.lang.Object value)` Gets the value contained in this cell.
`java.lang.String`	`toJson()` Convert `Cell` to JSON struct data.
`java.lang.String`	`toString()` Returns a string represents the current Cell object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - 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)
```
    Deprecated. Use Calculate(CalculationOptions) method instead.
    
    Calculates the formula of the cell.
    Remarks
    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.
  - getWorksheet
```
public Worksheet getWorksheet()
```
    Gets the parent worksheet.
  - 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(DateTime dateTime)
```
    Puts a DateTime value into the cell.
    Remarks
    Setting a DateTime value for a cell dose not means the cell will be formatted as date time automatically. DateTime value was maintained as numeric value in the data model of both ms excel and Aspose.Cells. Whether the numeric value will be taken as the numeric value itself or date time depends on the number format applied on this cell. If this cell has not been formatted as date time, it will be displayed as a numeric value even though what you input is DateTime.
    Example
    This example shows how to set DateTime value to a cell and make it be displayed as date time.
```
 
         Workbook excel = new Workbook();
         Cells cells = excel.getWorksheets().get(0).getCells();
 
         //Put date time into a cell
         Cell cell = cells.get(0, 0);
         cell.putValue(new DateTime(2023, 5, 15));
         Style style = cell.getStyle(false);
         style.setNumber(14);
         cell.setStyle(style);
 
```
    Parameters:
    dateTime - Input value
  - getDateTimeValue
```
public DateTime getDateTimeValue()
```
    Gets the DateTime value contained in the cell.
  - putValue
```
public void putValue(java.lang.Object objectValue)
```
    Puts an object value into the cell.
    
    Parameters:
    objectValue - input value
  - getRow
```
public int getRow()
```
    Gets row number (zero based) of the cell.
  - 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.
    See CellValueType.
  - getName
```
public java.lang.String getName()
```
    Gets the name of the cell.
    Remarks
    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.
    Remarks
    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)
    Remarks
    Also applies to formula cell to check the calculated result
  - getStringValue
```
public java.lang.String getStringValue(int formatStrategy)
```
    Gets the string value by specific formatted strategy.
    
    Parameters:
    formatStrategy - CellValueFormatStrategy. The formatted strategy.
    
    Returns:
  - 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()
```
    Deprecated. Use GetStringValue(CellValueFormatStrategy) with CellValueFormatStrategy.None instead.
    
    Gets cell's value as string without any format.
    Remarks
    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.
    See NumberCategoryType.
  - 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.
  - getWidthOfValue
```
public int getWidthOfValue()
```
    Gets the width of the value in unit of pixels.
    
    Returns:
  - getHeightOfValue
```
public int getHeightOfValue()
```
    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 FormatConditionCollection[] getFormatConditions()
```
    Gets format conditions which applies to this cell.
    
    Returns:
    Returns FormatConditionCollection object
  - getStyle
```
public Style getStyle()
```
    Gets the cell style.
    Remarks
    To change the style of the cell, please call Cell.SetStyle() method after modifying the returned style object. This method is same with getStyle(boolean) with true value for the parameter.
    
    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.
    Remarks
    
    Parameters:
    checkBorders - Check other cells' borders
    
    Returns:
    Style object.
  - setStyle
```
public void setStyle(Style style)
```
    Sets the cell style.
    Remarks
    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.
  - hasCustomStyle
```
public boolean hasCustomStyle()
```
    Indicates whether this cell has custom style settings(different from the default one inherited from corresponding row, column, or workbook).
  - getSharedStyleIndex
```
public int getSharedStyleIndex()
```
    Gets cell's shared style index in the style pool.
  - getFormula
```
public java.lang.String getFormula()
```
    Gets a formula of the Cell.
    Remarks
    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");
 
```
  - setFormula
```
public void setFormula(java.lang.String value)
```
    Sets a formula of the Cell.
    Remarks
    A formula string always begins with an equal sign (=). And please always use comma(,) as parameters delimiter, such as "=SUM(A1, E1, H2)".
  - getFormulaLocal
```
public java.lang.String getFormulaLocal()
```
    Get the locale formatted formula of the cell.
  - setFormulaLocal
```
public void setFormulaLocal(java.lang.String value)
```
    Get the locale formatted formula of the cell.
  - getR1C1Formula
```
public java.lang.String getR1C1Formula()
```
    Gets a R1C1 formula of the Cell.
  - setR1C1Formula
```
public void setR1C1Formula(java.lang.String value)
```
    Sets a R1C1 formula of the Cell.
  - setFormula
```
public void setFormula(java.lang.String formula,
              java.lang.Object value)
```
    Set the formula and the value(calculated result) of the formula.
    
    Parameters:
    formula - The formula.
    value - The value(calculated result) 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)
```
    Deprecated. Use FormulaParseOptions for more options instead.
    
    Set the formula and the value of the formula.
    Remarks
    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(calculated result) of the formula.
    
    Parameters:
    formula - The formula.
    options - Options for parsing the formula.
    value - The value(calculated result) of the formula.
  - setArrayFormula
```
public void setArrayFormula(java.lang.String arrayFormula,
                   int rowNumber,
                   int columnNumber,
                   boolean isR1C1,
                   boolean isLocal)
```
    Deprecated. Use FormulaParseOptions for more options instead.
    
    Sets an array formula to a range of cells.
    Remarks
    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)
```
    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.
  - 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)
```
    Deprecated. Use FormulaParseOptions for more options instead.
    
    Sets a formula to a range of cells.
    Remarks
    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)
```
    Sets shared formulas to a range of cells.
    Remarks
    
    Parameters:
    sharedFormula - Shared formula.
    rowNumber - Number of rows to populate the formula.
    columnNumber - Number of columns to populate the formula.
  - setSharedFormula
```
public void setSharedFormula(java.lang.String sharedFormula,
                    int rowNumber,
                    int columnNumber,
                    FormulaParseOptions options)
```
    Sets shared formulas 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 shared formulas 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
  - containsExternalLink
```
public boolean containsExternalLink()
```
    Indicates whether this cell contains an external link. Only applies when the cell is a formula cell.
  - getPrecedents
```
public ReferredAreaCollection getPrecedents()
```
    Gets all references appearing in this cell's formula.
    Remarks
    - 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 .
    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());
         }
 
```
    Returns:
    Collection of all references appearing in this cell's formula.
  - getDependents
```
public Cell[] getDependents(boolean isAll)
```
    Get all cells whose formula references to this cell directly.
    Remarks
    - 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 .
    - 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 instead. Or, user may gather precedents map of all cells by firstly, and then build the dependents map according to the precedents map.
    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());
         }
 
```
    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.
    Remarks
    This method can only work with the situation that FormulaSettings.getEnableCalculationChain() 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.
    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);
         }
 
```
    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.
    Remarks
    To use this method, please make sure the workbook has been set with true value for FormulaSettings.getEnableCalculationChain() and has been fully calculated with this setting. If there is no formula reference to this cell, null will be returned.
    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());
         }
 
```
    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)
  - getLeafs
```
public java.util.Iterator getLeafs()
```
    Deprecated. Use GetDependentsInCalculation(bool) instead.
    
    Get all cells which reference to this cell directly and need to be updated when this cell is modified.
    Remarks
    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)
```
    Deprecated. Use GetDependentsInCalculation(bool) instead.
    
    Get all cells which will be updated when this cell is modified.
    Remarks
    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)
  - isArrayHeader
```
public boolean isArrayHeader()
```
    Indicates the cell's formula is and array formula and it is the first cell of the array.
  - isDynamicArrayFormula
```
public boolean isDynamicArrayFormula()
```
    Indicates whether the cell's formula is dynamic array formula(true) or legacy array formula(false).
  - getArrayRange
```
public CellArea getArrayRange()
```
    Gets the array range if the cell's formula is an array formula.
    Remarks
    Only applies when the cell's formula is an array formula
    
    Returns:
    The array range.
  - isArrayFormula
```
public boolean isArrayFormula()
```
    Indicates whether the cell formula is an array formula.
  - isInArray
```
public boolean isInArray()
```
    Deprecated. Use IsArrayFormula instead.
    
    Indicates whether the cell formula is an array formula.
    Remarks
    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()
```
    Deprecated. Use IsTableFormula instead.
    
    Indicates whether this cell is part of table formula.
    Remarks
    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.
  - 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(calculated results) 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.
  - setDynamicArrayFormula
```
public CellArea setDynamicArrayFormula(java.lang.String arrayFormula,
                              FormulaParseOptions options,
                              java.lang.Object[][] values,
                              boolean calculateRange,
                              boolean calculateValue,
                              CalculationOptions copts)
```
    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(calculated results) 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.
    copts - The options for calculating formula. Commonly, for performance consideration, the CalculationOptions.getRecursive() property should be false.
    
    Returns:
    the range that the formula should spill into.
  - setTableFormula
```
public void setTableFormula(int rowNumber,
                   int columnNumber,
                   java.lang.String rowInputCell,
                   java.lang.String columnInputCell,
                   java.lang.Object[][] values)
```
    Create two-variable data table for given range starting from this cell.
    
    Parameters:
    rowNumber - Number of rows to populate the formula.
    columnNumber - Number of columns to populate the formula.
    rowInputCell - the row input cell
    columnInputCell - the column input cell
    values - values for cells in table formula range
  - setTableFormula
```
public void setTableFormula(int rowNumber,
                   int columnNumber,
                   java.lang.String inputCell,
                   boolean isRowInput,
                   java.lang.Object[][] values)
```
    Create one-variable data table for given range starting from this cell.
    
    Parameters:
    rowNumber - Number of rows to populate the formula.
    columnNumber - Number of columns to populate the formula.
    inputCell - the input cell
    isRowInput - Indicates whether the input cell is a row input cell(true) or a column input cell(false).
    values - values for cells in table formula range
  - setTableFormula
```
public void setTableFormula(int rowNumber,
                   int columnNumber,
                   int rowIndexOfRowInputCell,
                   int columnIndexOfRowInputCell,
                   int rowIndexOfColumnInputCell,
                   int columnIndexOfColumnInputCell,
                   java.lang.Object[][] values)
```
    Create two-variable data table for given range starting from this cell.
    
    Parameters:
    rowNumber - Number of rows to populate the formula.
    columnNumber - Number of columns to populate the formula.
    rowIndexOfRowInputCell - row index of the row input cell
    columnIndexOfRowInputCell - column index of the row input cell
    rowIndexOfColumnInputCell - row index of the column input cell
    columnIndexOfColumnInputCell - column index of the column input cell
    values - values for cells in table formula range
  - setTableFormula
```
public void setTableFormula(int rowNumber,
                   int columnNumber,
                   int rowIndexOfInputCell,
                   int columnIndexOfInputCell,
                   boolean isRowInput,
                   java.lang.Object[][] values)
```
    Create one-variable data table for given range starting from this cell.
    
    Parameters:
    rowNumber - Number of rows to populate the formula.
    columnNumber - Number of columns to populate the formula.
    rowIndexOfInputCell - row index of the input cell
    columnIndexOfInputCell - column index of the input cell
    isRowInput - Indicates whether the input cell is a row input cell(true) or a column input cell(false).
    values - values for cells in table formula range
  - 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.
  - getValue
```
public java.lang.Object getValue()
```
    Gets the value contained in this cell.
    Remarks
    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.
  - setValue
```
public void setValue(java.lang.Object value)
```
    Gets the value contained in this cell.
    Remarks
    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.
  - characters
```
public FontSetting characters(int startIndex,
                     int length)
```
    Returns a Characters object that represents a range of characters within the cell text.
    Remarks
    This method only works on cell with string value.
    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());
 
```
    Parameters:
    startIndex - The index of the start of the character.
    length - The number of characters.
    
    Returns:
    Characters object.
  - replace
```
public void replace(java.lang.String placeHolder,
           java.lang.String newValue,
           ReplaceOptions options)
```
    Replace text of the cell with options.
    
    Parameters:
    placeHolder - Cell placeholder
    newValue - String value to replace
    options - The replace options
  - insertText
```
public void insertText(int index,
              java.lang.String text)
```
    Insert some characters to the cell. If the cell is rich formatted, this method could keep the original formatting.
    
    Parameters:
    index - The index.
    text - Inserted text.
  - isRichText
```
public boolean isRichText()
```
    Indicates whether the cell string value is a rich text.
  - getCharacters
```
public FontSetting[] getCharacters()
```
    Returns all Characters objects that represents a range of characters within the cell text.
    
    Returns:
    All Characters objects
  - getCharacters
```
public 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(FontSetting[] characters)
```
    Sets rich text format of the cell.
    
    Parameters:
    characters - All Characters objects.
  - isMerged
```
public boolean isMerged()
```
    Checks if a cell is part of a merged range or not.
  - getMergedRange
```
public Range getMergedRange()
```
    Returns a Range object which represents a merged range.
    
    Returns:
    Range object. Null if this cell is not merged.
  - getComment
```
public Comment getComment()
```
    Gets the comment of this cell.
    Remarks
    If there is no comment applies to the cell, returns null.
  - getHtmlString
```
public java.lang.String getHtmlString()
```
    Gets the html string which contains data and some formats in this cell.
  - setHtmlString
```
public void setHtmlString(java.lang.String value)
```
    Sets the html string which contains data and some formats in this cell.
  - getHtmlString
```
public java.lang.String getHtmlString(boolean html5)
```
    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.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
  - toJson
```
public java.lang.String toJson()
```
    Convert Cell to JSON struct data.
    
    Returns:
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks whether this object refers to the same cell with another.
    
    Overrides:
    
    equals in class java.lang.Object
    
    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.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    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.
    Remarks
    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:

Class Cell

Method Summary

Methods inherited from class java.lang.Object

Method Detail

calculate

calculate

getWorksheet

putValue

putValue

putValue

putValue

putValue

putValue

putValue

getDateTimeValue

putValue

getRow

getColumn

isFormula

getType

getName

isErrorValue

isNumericValue

getStringValue

getStringValue

getStringValueWithoutFormat

getNumberCategoryType

getDisplayStringValue

getIntValue

getDoubleValue

getFloatValue

getBoolValue

getWidthOfValue

getHeightOfValue

getDisplayStyle

getDisplayStyle

getFormatConditions

getStyle

getStyle

setStyle

setStyle

setStyle

hasCustomStyle

getSharedStyleIndex

getFormula

setFormula

getFormulaLocal

setFormulaLocal

getR1C1Formula

setR1C1Formula

setFormula

getFormula

setFormula

setFormula

setArrayFormula

setArrayFormula

setArrayFormula

setArrayFormula

setSharedFormula

setSharedFormula

setSharedFormula

setSharedFormula

containsExternalLink

getPrecedents

getDependents

getPrecedentsInCalculation

getDependentsInCalculation

getLeafs

getLeafs

isArrayHeader

isDynamicArrayFormula

getArrayRange

isArrayFormula

isInArray

isSharedFormula

isTableFormula

isInTable

setDynamicArrayFormula

setDynamicArrayFormula

setDynamicArrayFormula