Cell

calculate(options)

Calculates the formula of the cell.

characters(startIndex, length) → FontSetting

Returns a Characters object that represents a range of characters within the cell text. This method only works on cell with string value.

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

Returns

FontSetting Characters object.

containsExternalLink()

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

copy(cell)

Copies data from a source cell.

equals(obj) → boolean

Checks whether this object refers to the same cell with another.

Returns

boolean true if two objects refers to the same cell.

equals(cell) → boolean

Checks whether this object refers to the same cell with another cell object.

Returns

boolean true if two cell objects refers to the same cell.

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@return {CellArea} The array range.

getBoolValue()

Gets the boolean value contained in the cell.

getCharacters() → Array of FontSetting

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

Returns

Array of FontSetting All Characters objects

getCharacters(flag) → Array of FontSetting

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

Returns

Array of FontSetting All Characters objects

getColumn()

Gets column number (zero based) of the cell.

getComment()

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

getConditionalFormattingResult()

Get the result of the conditional formatting. Returns null if no conditional formatting is applied to this cell,

getDateTimeValue()

Gets the DateTime value contained in the cell.

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

getDependentsInCalculation(recursive) → Iterator

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.

Returns

Iterator Enumerator to enumerate all dependents(Cell objects)

getDisplayStringValue()

Gets the formatted string value of this cell by cell's display 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(includeMergedBorders)

Gets the display style of the cell. If the cell is conditional formatted, the display style is not same as the cell.GetStyle().

getDoubleValue()

Gets the double value contained in the cell.

getEmbeddedImage()

Gets and sets the embeddedn image in the cell.

getFloatValue()

Gets the float value contained in the cell.

getFormatConditions() → Array of FormatConditionCollection

Gets format conditions which applies to this cell.

Returns

Array of FormatConditionCollection Returns FormatConditionCollection object

getFormula()

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

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

getFormula(isR1C1, isLocal) → String

Get the formula of this cell.

Returns

String the formula of this cell.

getFormulaLocal()

Get the locale formatted formula of the cell.

getHeightOfValue() → Number

Gets the height of the value in unit of pixels.

Returns

Number 

getHtmlString()

Gets and sets the html string which contains data and some formats in this cell.

getHtmlString(html5) → String

Gets the html string which contains data and some formats in this cell.

Returns

String 

getIntValue()

Gets the integer value contained in the cell.

getLeafs() → Iterator

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

Iterator Enumerator to enumerate all dependents(Cell)

getLeafs(recursive) → Iterator

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.

Returns

Iterator Enumerator to enumerate all dependents(Cell)

getMergedRange() → Range

Returns a Range object which represents a merged range.

Returns

Range Range object. Null if this cell is not merged.

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.

getNumberCategoryType()

Represents the category type of this cell's number formatting. The value of the property is NumberCategoryType integer constant.When cell's formatting pattern is combined with conditional formatting patterns, then the returned type is corresponding to the part which is used for current value of this cell. For example, if the formatting pattern for this cell is "#,##0;(#,##0);"-";@", then when cell's value is numeric and not 0, the returned type is NumberCategoryType.NUMBER; When cell's value is 0 or not numeric value, the returned type is NumberCategoryType.TEXT.

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().@return {ReferredAreaCollection} Collection of all references appearing in this cell's formula.

var workbook = new aspose.cells.Workbook();
var cells = workbook.getWorksheets().get(0).getCells();
cells.get("A1").setFormula("= B1 + SUM(B1:B10) + [Book1.xls]Sheet1!A1");
var areas = cells.get("A1").getPrecedents();
for (var i = 0; i < areas.getCount(); i++)
{
var area = areas.get(i);
var stringBuilder = "";
if (area.isExternalLink())
{
stringBuilder += "[";
stringBuilder += area.getExternalFileName();
stringBuilder += "]";
}
stringBuilder += area.getSheetName();
stringBuilder += "!";
stringBuilder += aspose.cells.CellsHelper.cellIndexToName(area.getStartRow(), area.getStartColumn());
if (area.isArea())
{
stringBuilder += ":";
stringBuilder += aspose.cells.CellsHelper.cellIndexToName(area.getEndRow(), area.getEndColumn());
}
console.log(stringBuilder);
}
workbook.save("Book2.xls");

getPrecedentsInCalculation() → Iterator

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

Iterator Enumerator to enumerate all references(ReferredArea)

getR1C1Formula()

Gets or sets a R1C1 formula of the Cell.

getRow()

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

getSharedStyleIndex()

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

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

getStringValue(formatStrategy) → String

Gets the string value by specific formatted strategy.

Returns

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.

getStyle() → Style

Gets the cell style. 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 Style object.

getStyle(checkBorders) → Style

If checkBorders is true, check whether other cells' borders will effect the style of this cell.

Returns

Style Style object.

getTable() → ListObject

Gets the table which contains this cell.

Returns

ListObject 

getType()

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

getValidation() → Validation

Gets the validation applied to this cell.

Returns

Validation 

getValidationValue() → boolean

Gets the value of validation which applied to this cell.

Returns

boolean 

getValue()

Gets/sets the value contained in this cell. Possible type: null,Boolean,DateTime,Double,IntegerString. 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.

getWidthOfValue() → Number

Gets the width of the value in unit of pixels.

Returns

Number 

getWorksheet()

Gets the parent worksheet.

hasCustomStyle()

Indicates whether this cell has custom style settings(different from the default one inherited from corresponding row, column, or workbook).

hashCode() → Number

Serves as a hash function for a particular type.

Returns

Number A hash code for current Cell object.

insertText(index, text)

Insert some characters to the cell. If the cell is rich formatted, this method could keep the original formatting.

isArrayFormula()

Indicates whether the cell formula is an array formula.

isArrayHeader()

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

isDynamicArrayFormula()

Indicates whether the cell's formula is dynamic array formula(true) or legacy array formula(false).

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.

isFormula()

Represents if the specified cell contains formula.

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.

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.

isMerged()

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

isNumericValue()

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

isRichText()

Indicates whether the string value of this cell is a rich formatted text.

isSharedFormula()

Indicates whether the cell formula is part of shared formula.

isStyleSet()

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

isTableFormula()

Indicates whether this cell is part of table formula.

putValue(boolValue)

Puts a boolean value into the cell.

putValue(intValue)

Puts an integer value into the cell.

putValue(doubleValue)

Puts a double value into the cell.

putValue(stringValue, isConverted, 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.

putValue(stringValue, isConverted)

Puts a string value into the cell and converts the value to other data type if appropriate.

putValue(stringValue)

Puts a string value into the cell.

putValue(dateTime)

Puts a DateTime value into the cell. 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.

putValue(objectValue)

Puts an object value into the cell.

removeArrayFormula(leaveNormalFormula)

Remove array formula.

replace(placeHolder, newValue, options)

Replace text of the cell with options.

setArrayFormula(arrayFormula, rowNumber, columnNumber, isR1C1, 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.

setArrayFormula(arrayFormula, rowNumber, columnNumber)

Sets an array formula(legacy array formula entered via CTRL+SHIFT+ENTER in ms excel) to a range of cells.

setArrayFormula(arrayFormula, rowNumber, columnNumber, options)

Sets an array formula to a range of cells.

setArrayFormula(arrayFormula, rowNumber, columnNumber, options, values)

Sets an array formula to a range of cells.

setCharacters(characters)

Sets rich text format of the cell.

setDynamicArrayFormula(arrayFormula, options, calculateValue) → CellArea

Sets dynamic array formula and make the formula spill into neighboring cells if possible.

Returns

CellArea the range that the formula should spill into.

setDynamicArrayFormula(arrayFormula, options, values, calculateRange, calculateValue) → CellArea

Sets dynamic array formula and make the formula spill into neighboring cells if possible.

Returns

CellArea the range that the formula should spill into.

setDynamicArrayFormula(arrayFormula, options, values, calculateRange, calculateValue, copts) → CellArea

Sets dynamic array formula and make the formula spill into neighboring cells if possible.

Returns

CellArea the range that the formula should spill into.

setEmbeddedImage()

Gets and sets the embeddedn image in the cell.

setFormula()

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

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

setFormula(formula, value)

Set the formula and the value(calculated result) of the formula.

setFormula(formula, isR1C1, isLocal, 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.

setFormula(formula, options, value)

Set the formula and the value(calculated result) of the formula.

setFormulaLocal()

Get the locale formatted formula of the cell.

setHtmlString()

Gets and sets the html string which contains data and some formats in this cell.

setR1C1Formula()

Gets or sets a R1C1 formula of the Cell.

setSharedFormula(sharedFormula, rowNumber, columnNumber, isR1C1, 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.

setSharedFormula(sharedFormula, rowNumber, columnNumber)

Sets shared formulas to a range of cells.

setSharedFormula(sharedFormula, rowNumber, columnNumber, options)

Sets shared formulas to a range of cells.

setSharedFormula(sharedFormula, rowNumber, columnNumber, options, values)

Sets shared formulas to a range of cells.

setStyle(style)

Sets the cell style. If the border settings are changed, the border of adjust cells will be updated too.

setStyle(style, explicitFlag)

Apply the changed property of style to the cell.

setStyle(style, flag)

Apply the cell style based on flags.

setTableFormula(rowNumber, columnNumber, rowInputCell, columnInputCell, values)

Create two-variable data table for given range starting from this cell.

setTableFormula(rowNumber, columnNumber, inputCell, isRowInput, values)

Create one-variable data table for given range starting from this cell.

setTableFormula(rowNumber, columnNumber, rowIndexOfRowInputCell, columnIndexOfRowInputCell, rowIndexOfColumnInputCell, columnIndexOfColumnInputCell, values)

Create two-variable data table for given range starting from this cell.

setTableFormula(rowNumber, columnNumber, rowIndexOfInputCell, columnIndexOfInputCell, isRowInput, values)

Create one-variable data table for given range starting from this cell.

setValue()

Gets/sets the value contained in this cell. Possible type: null,Boolean,DateTime,Double,IntegerString. 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.

toJson() → String

Convert Cell to JSON struct data.

Returns

String 

toString() → String

Returns a string represents the current Cell object.

Returns

String