Cell
Cell class
Encapsulates the object that represents a single Workbook cell.
Methods
| Name | Description |
|---|---|
| calculate(options) | Calculates the formula of the cell. |
| characters(startIndex, length) | Returns a Characters object that represents a range of characters within the cell text. This method only works on cell w |
| 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) | Checks whether this object refers to the same cell with another. |
| equals(cell) | Checks whether this object refers to the same cell with another cell object. |
| 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 |
| getBoolValue() | Gets the boolean value contained in the cell. |
| getCharacters() | Returns all Characters objects that represents a range of characters within the cell text. |
| getCharacters(flag) | Returns all Characters objects that represents a range of characters within the cell text. |
| 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' |
| getDependentsInCalculation(recursive) | Gets all cells whose calculated result depends on this cell. To use this method, please make sure the workbook has been |
| 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 |
| getDisplayStyle(includeMergedBorders) | Gets the display style of the cell. If the cell is conditional formatted, the display style is not same as the cell.GetS |
| getDisplayStyle() | |
| 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() | Gets format conditions which applies to this cell. |
| getFormula() | Gets or sets a formula of the Cell. A formula string always begins with an equal sign (=). And please always use comma(, |
| getFormula(isR1C1, isLocal) | Get the formula of this cell. |
| getFormulaLocal() | Get the locale formatted formula of the cell. |
| getHeightOfValue() | Gets the height of the value in unit of pixels. |
| getHtmlString() | Gets and sets the html string which contains data and some formats in this cell. |
| getHtmlString(html5) | Gets the html string which contains data and some formats in this cell. |
| getIntValue() | Gets the integer value contained in the cell. |
| getLeafs() | Get all cells which reference to this cell directly and need to be updated when this cell is modified. NOTE: This class |
| getLeafs(recursive) | Get all cells which will be updated when this cell is modified. NOTE: This class is now obsolete. Instead, please use Ce |
| getMergedRange() | Returns a Range object which represents a merged range. |
| 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 |
| getNumberCategoryType() | Represents the category type of this cell’s number formatting. The value of the property is NumberCategoryType integer c |
| getPrecedents() | Gets all references appearing in this cell’s formula. Returns null if this is not a formula cell.All references appearin |
| getPrecedentsInCalculation() | Gets all precedents(reference to cells in current workbook) used by this cell’s formula while calculating it. This metho |
| getR1C1Formula() | Gets or sets a R1C1 formula of the Cell. |
| getRichValue() | |
| 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. Fo |
| getStringValue(formatStrategy) | Gets the string value by specific formatted strategy. |
| getStringValueWithoutFormat() | Gets cell’s value as string without any format. NOTE: This method is now obsolete. Instead, User should get the value ob |
| getStyle() | Gets the cell style. To change the style of the cell, please call Cell.SetStyle() method after modifying the returned st |
| getStyle(checkBorders) | If checkBorders is true, check whether other cells’ borders will effect the style of this cell. |
| getTable() | Gets the table which contains this cell. |
| getType() | Represents cell value type. The value of the property is CellValueType integer constant. |
| getValidation() | Gets the validation applied to this cell. |
| getValidationValue() | Gets the value of validation which applied to this cell. |
| getValue() | Gets/sets the value contained in this cell. Possible type: null,Boolean,DateTime,Double,IntegerString. For int value, it |
| getWidthOfValue() | Gets the width of the value in unit of pixels. |
| getWorksheet() | Gets the parent worksheet. |
| hasCustomFunction() | |
| hasCustomStyle() | Indicates whether this cell has custom style settings(different from the default one inherited from corresponding row, c |
| hashCode() | Serves as a hash function for a particular type. |
| 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. |
| isCheckBoxStyle() | |
| 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 |
| 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.IsArr |
| isInTable() | Indicates whether this cell is part of table formula. NOTE: This class is now obsolete. Instead, please use Cell.IsTable |
| 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 |
| 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 |
| 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 da |
| 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(st |
| 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. |
| setCheckBoxStyle() | |
| setDynamicArrayFormula(arrayFormula, options, calculateValue) | Sets dynamic array formula and make the formula spill into neighboring cells if possible. |
| setDynamicArrayFormula(arrayFormula, options, values, calculateRange, calculateValue) | Sets dynamic array formula and make the formula spill into neighboring cells if possible. |
| setDynamicArrayFormula(arrayFormula, options, values, calculateRange, calculateValue, copts) | Sets dynamic array formula and make the formula spill into neighboring cells if possible. |
| 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(, |
| setFormula(formula, value) | Set the formula and the value(calculated result) of the formula. |
| setFormula() | |
| 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(stri |
| 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,i |
| 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 |
| toJson() | Convert Cell to JSON struct data. |
| toString() | Returns a string represents the current Cell object. |
calculate(options)
Calculates the formula of the cell.
| Parameter | Type | Description |
|---|---|---|
| options | CalculationOptions | Options for calculation |
characters(startIndex, length)
Returns a Characters object that represents a range of characters within the cell text. This method only works on cell with string value.
| Parameter | Type | Description |
|---|---|---|
| startIndex | Number | The index of the start of the character. |
| length | Number | The number of characters. |
Returns: FontSetting — FontSetting Characters object.
Example:
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());
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.
| Parameter | Type | Description |
|---|---|---|
| cell | Cell | Source |
equals(obj)
Checks whether this object refers to the same cell with another.
| Parameter | Type | Description |
|---|---|---|
| obj | Object | another object |
Returns: boolean — boolean true if two objects refers to the same cell.
equals(cell)
Checks whether this object refers to the same cell with another cell object.
| Parameter | Type | Description |
|---|---|---|
| cell | Cell | another cell object |
Returns: boolean — 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()
Returns all Characters objects that represents a range of characters within the cell text.
Returns: Array ofFontSetting — Array ofFontSetting All Characters objects
getCharacters(flag)
Returns all Characters objects that represents a range of characters within the cell text.
| Parameter | Type | Description |
|---|---|---|
| flag | boolean | Indicates whether applying table style to the cell if the cell is in the table. |
Returns: Array ofFontSetting — Array ofFontSetting 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.
| Parameter | Type | Description |
|---|---|---|
| isAll | boolean | Indicates whether check formulas in other worksheets |
getDependentsInCalculation(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.
| Parameter | Type | Description |
|---|---|---|
| recursive | boolean | Whether returns those dependents which do not reference to this cell directly but reference to other leafs of this cell |
Returns: Iterator — 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().
| Parameter | Type | Description |
|---|---|---|
| includeMergedBorders | boolean | Indicates whether checking borders of the merged cells. |
getDisplayStyle()
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()
Gets format conditions which applies to this cell.
Returns: Array ofFormatConditionCollection — Array ofFormatConditionCollection 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)”.
Example:
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)
Get the formula of this cell.
| Parameter | Type | Description |
|---|---|---|
| isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
| isLocal | boolean | Whether the formula needs to be formatted by locale. |
Returns: String — String the formula of this cell.
getFormulaLocal()
Get the locale formatted formula of the cell.
getHeightOfValue()
Gets the height of the value in unit of pixels.
Returns: Number — Number
getHtmlString()
Gets and sets the html string which contains data and some formats in this cell.
getHtmlString(html5)
Gets the html string which contains data and some formats in this cell.
| Parameter | Type | Description |
|---|---|---|
| html5 | boolean | Indicates whether the value is compatible for html5 |
Returns: String — String
getIntValue()
Gets the integer value contained in the cell.
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: Iterator — Iterator Enumerator to enumerate all dependents(Cell)
getLeafs(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.
| Parameter | Type | Description |
|---|---|---|
| recursive | boolean | Whether returns those leafs that do not reference to this cell directly but reference to other leafs of this cell |
Returns: Iterator — Iterator Enumerator to enumerate all dependents(Cell)
getMergedRange()
Returns a Range object which represents a merged range.
Returns: Range — 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.
Example:
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()
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 — Iterator Enumerator to enumerate all references(ReferredArea)
getR1C1Formula()
Gets or sets a R1C1 formula of the Cell.
getRichValue()
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)
Gets the string value by specific formatted strategy.
| Parameter | Type | Description |
|---|---|---|
| formatStrategy | Number | CellValueFormatStrategy |
Returns: String — 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()
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 Style object.
getStyle(checkBorders)
If checkBorders is true, check whether other cells’ borders will effect the style of this cell.
| Parameter | Type | Description |
|---|---|---|
| checkBorders | boolean | Check other cells’ borders |
Returns: Style — Style Style object.
getTable()
Gets the table which contains this cell.
Returns: ListObject — ListObject
getType()
Represents cell value type. The value of the property is CellValueType integer constant.
getValidation()
Gets the validation applied to this cell.
Returns: Validation — Validation
getValidationValue()
Gets the value of validation which applied to this cell.
Returns: boolean — 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()
Gets the width of the value in unit of pixels.
Returns: Number — Number
getWorksheet()
Gets the parent worksheet.
hasCustomFunction()
hasCustomStyle()
Indicates whether this cell has custom style settings(different from the default one inherited from corresponding row, column, or workbook).
hashCode()
Serves as a hash function for a particular type.
Returns: Number — 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.
| Parameter | Type | Description |
|---|---|---|
| index | Number | The index. |
| text | String | Inserted text. |
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.
isCheckBoxStyle()
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.
| Parameter | Type | Description |
|---|---|---|
| boolValue | boolean |
putValue(intValue)
Puts an integer value into the cell.
| Parameter | Type | Description |
|---|---|---|
| intValue | Number | Input value |
putValue(doubleValue)
Puts a double value into the cell.
| Parameter | Type | Description |
|---|---|---|
| doubleValue | Number | Input value |
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.
| Parameter | Type | Description |
|---|---|---|
| stringValue | String | Input value |
| isConverted | boolean | True: converted to other data type if appropriate. |
| setStyle | boolean | True: set the number format to cell’s style when converting to other data type |
putValue(stringValue, isConverted)
Puts a string value into the cell and converts the value to other data type if appropriate.
| Parameter | Type | Description |
|---|---|---|
| stringValue | String | Input value |
| isConverted | boolean | True: converted to other data type if appropriate. |
putValue(stringValue)
Puts a string value into the cell.
| Parameter | Type | Description |
|---|---|---|
| stringValue | String | Input value |
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.
| Parameter | Type | Description |
|---|---|---|
| dateTime | DateTime | Input value |
putValue(objectValue)
Puts an object value into the cell.
| Parameter | Type | Description |
|---|---|---|
| objectValue | Object | input value |
removeArrayFormula(leaveNormalFormula)
Remove array formula.
| Parameter | Type | Description |
|---|---|---|
| leaveNormalFormula | boolean | True represents converting the array formula to normal formula. |
replace(placeHolder, newValue, options)
Replace text of the cell with options.
| Parameter | Type | Description |
|---|---|---|
| placeHolder | String | Cell placeholder |
| newValue | String | String value to replace |
| options | ReplaceOptions | The replace 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.
| Parameter | Type | Description |
|---|---|---|
| arrayFormula | String | Array formula. |
| rowNumber | Number | Number of rows to populate result of the array formula. |
| columnNumber | Number | Number of columns to populate result of the array formula. |
| isR1C1 | boolean | whether the formula is R1C1 formula |
| isLocal | boolean | whether the formula is locale formatted |
setArrayFormula(arrayFormula, rowNumber, columnNumber)
Sets an array formula(legacy array formula entered via CTRL+SHIFT+ENTER in ms excel) to a range of cells.
| Parameter | Type | Description |
|---|---|---|
| arrayFormula | String | Array formula. |
| rowNumber | Number | Number of rows to populate result of the array formula. |
| columnNumber | Number | Number of columns to populate result of the array formula. |
setArrayFormula(arrayFormula, rowNumber, columnNumber, options)
Sets an array formula to a range of cells.
| Parameter | Type | Description |
|---|---|---|
| arrayFormula | String | Array formula. |
| rowNumber | Number | Number of rows to populate result of the array formula. |
| columnNumber | Number | Number of columns to populate result of the array formula. |
| options | FormulaParseOptions | Options for parsing the formula. |
setArrayFormula(arrayFormula, rowNumber, columnNumber, options, values)
Sets an array formula to a range of cells.
| Parameter | Type | Description |
|---|---|---|
| arrayFormula | String | Array formula. |
| rowNumber | Number | Number of rows to populate result of the array formula. |
| columnNumber | Number | Number of columns to populate result of the array formula. |
| options | FormulaParseOptions | Options for parsing the formula. |
| values | Array of Array of Object | values for those cells with given array formula |
setCharacters(characters)
Sets rich text format of the cell.
| Parameter | Type | Description |
|---|---|---|
| characters | Array ofFontSetting | All Characters objects. |
setCheckBoxStyle()
setDynamicArrayFormula(arrayFormula, options, calculateValue)
Sets dynamic array formula and make the formula spill into neighboring cells if possible.
| Parameter | Type | Description |
|---|---|---|
| arrayFormula | String | the formula expression |
| options | FormulaParseOptions | options to parse formula. “Parse” option will be ignored and the formula will always be parsed immediately |
| calculateValue | boolean | whether calculate this dynamic array formula for those cells in the spilled range. |
Returns: CellArea — CellArea the range that the formula should spill into.
setDynamicArrayFormula(arrayFormula, options, values, calculateRange, calculateValue)
Sets dynamic array formula and make the formula spill into neighboring cells if possible.
| Parameter | Type | Description |
|---|---|---|
| arrayFormula | String | the formula expression |
| options | FormulaParseOptions | options to parse formula. “Parse” option will be ignored and the formula will always be parsed immediately |
| values | Array of Array of Object | values(calculated results) for those cells with given dynamic array formula |
| calculateRange | boolean | 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 | boolean | 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: CellArea — CellArea the range that the formula should spill into.
setDynamicArrayFormula(arrayFormula, options, values, calculateRange, calculateValue, copts)
Sets dynamic array formula and make the formula spill into neighboring cells if possible.
| Parameter | Type | Description |
|---|---|---|
| arrayFormula | String | the formula expression |
| options | FormulaParseOptions | options to parse formula. “Parse” option will be ignored and the formula will always be parsed immediately |
| values | Array of Array of Object | values(calculated results) for those cells with given dynamic array formula |
| calculateRange | boolean | 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 | boolean | 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 | CalculationOptions | The options for calculating formula. Commonly, for performance consideration, the |
Returns: CellArea — 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)”.
Example:
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.
| Parameter | Type | Description |
|---|---|---|
| formula | String | The formula. |
| value | Object | The value(calculated result) of the formula. |
setFormula()
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.
| Parameter | Type | Description |
|---|---|---|
| formula | String | The formula. |
| isR1C1 | boolean | Whether the formula is R1C1 formula. |
| isLocal | boolean | Whether the formula is locale formatted. |
| value | Object | The value of the formula. |
setFormula(formula, options, value)
Set the formula and the value(calculated result) of the formula.
| Parameter | Type | Description |
|---|---|---|
| formula | String | The formula. |
| options | FormulaParseOptions | Options for parsing the formula. |
| value | Object | 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.
| Parameter | Type | Description |
|---|---|---|
| sharedFormula | String | Shared formula. |
| rowNumber | Number | Number of rows to populate the formula. |
| columnNumber | Number | Number of columns to populate the formula. |
| isR1C1 | boolean | whether the formula is R1C1 formula |
| isLocal | boolean | whether the formula is locale formatted |
setSharedFormula(sharedFormula, rowNumber, columnNumber)
Sets shared formulas to a range of cells.
| Parameter | Type | Description |
|---|---|---|
| sharedFormula | String | Shared formula. |
| rowNumber | Number | Number of rows to populate the formula. |
| columnNumber | Number | Number of columns to populate the formula. |
setSharedFormula(sharedFormula, rowNumber, columnNumber, options)
Sets shared formulas to a range of cells.
| Parameter | Type | Description |
|---|---|---|
| sharedFormula | String | Shared formula. |
| rowNumber | Number | Number of rows to populate the formula. |
| columnNumber | Number | Number of columns to populate the formula. |
| options | FormulaParseOptions | Options for parsing the formula. |
setSharedFormula(sharedFormula, rowNumber, columnNumber, options, values)
Sets shared formulas to a range of cells.
| Parameter | Type | Description |
|---|---|---|
| sharedFormula | String | Shared formula. |
| rowNumber | Number | Number of rows to populate the formula. |
| columnNumber | Number | Number of columns to populate the formula. |
| options | FormulaParseOptions | Options for parsing the formula. |
| values | Array of Array of Object | values for those cells with given shared formula |
setStyle(style)
Sets the cell style. If the border settings are changed, the border of adjust cells will be updated too.
| Parameter | Type | Description |
|---|---|---|
| style | Style | The cell style. |
setStyle(style, explicitFlag)
Apply the changed property of style to the cell.
| Parameter | Type | Description |
|---|---|---|
| style | Style | The cell style. |
| explicitFlag | boolean | True, only overwriting formatting which is explicitly set. |
setStyle(style, flag)
Apply the cell style based on flags.
| Parameter | Type | Description |
|---|---|---|
| style | Style | The cell style. |
| flag | StyleFlag | The style flag. |
setTableFormula(rowNumber, columnNumber, rowInputCell, columnInputCell, values)
Create two-variable data table for given range starting from this cell.
| Parameter | Type | Description |
|---|---|---|
| rowNumber | Number | Number of rows to populate the formula. |
| columnNumber | Number | Number of columns to populate the formula. |
| rowInputCell | String | the row input cell |
| columnInputCell | String | the column input cell |
| values | Array of Array of Object | values for cells in table formula range |
setTableFormula(rowNumber, columnNumber, inputCell, isRowInput, values)
Create one-variable data table for given range starting from this cell.
| Parameter | Type | Description |
|---|---|---|
| rowNumber | Number | Number of rows to populate the formula. |
| columnNumber | Number | Number of columns to populate the formula. |
| inputCell | String | the input cell |
| isRowInput | boolean | Indicates whether the input cell is a row input cell(true) or a column input cell(false). |
| values | Array of Array of Object | values for cells in table formula range |
setTableFormula(rowNumber, columnNumber, rowIndexOfRowInputCell, columnIndexOfRowInputCell, rowIndexOfColumnInputCell, columnIndexOfColumnInputCell, values)
Create two-variable data table for given range starting from this cell.
| Parameter | Type | Description |
|---|---|---|
| rowNumber | Number | Number of rows to populate the formula. |
| columnNumber | Number | Number of columns to populate the formula. |
| rowIndexOfRowInputCell | Number | row index of the row input cell |
| columnIndexOfRowInputCell | Number | column index of the row input cell |
| rowIndexOfColumnInputCell | Number | row index of the column input cell |
| columnIndexOfColumnInputCell | Number | column index of the column input cell |
| values | Array of Array of Object | values for cells in table formula range |
setTableFormula(rowNumber, columnNumber, rowIndexOfInputCell, columnIndexOfInputCell, isRowInput, values)
Create one-variable data table for given range starting from this cell.
| Parameter | Type | Description |
|---|---|---|
| rowNumber | Number | Number of rows to populate the formula. |
| columnNumber | Number | Number of columns to populate the formula. |
| rowIndexOfInputCell | Number | row index of the input cell |
| columnIndexOfInputCell | Number | column index of the input cell |
| isRowInput | boolean | Indicates whether the input cell is a row input cell(true) or a column input cell(false). |
| values | Array of Array of Object | values for cells in table formula range |
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()
Convert Cell to JSON struct data.
Returns: String — String
toString()
Returns a string represents the current Cell object.
Returns: String — String