Excel.FormattedNumberCellValue interface

Package:

excel

Warning

This API is now deprecated.

As of ExcelApi 1.19, use DoubleCellValue instead.

Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see Review guidelines for customizing a number format. In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation.

Remarks

[ API set: ExcelApi 1.16 ]

Properties

basicType	Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue	Represents the value that would be returned by Range.values for a cell with this value.
numberFormat	Returns the number format string that is used to display this value. When accessed through a valuesAsJson property, this number format string is in the en-US locale. When accessed through a valuesAsJsonLocal property, this number format is in the user's display locale. Number format strings must conform to Excel guidelines. To learn more, see Review guidelines for customizing a number format.
type	Represents the type of this cell value.

Property Details

basicType

Warning

This API is now deprecated.

Deprecated since ExcelApi 1.19.

Represents the value that would be returned by Range.valueTypes for a cell with this value.

basicType?: RangeValueType.double | "Double";

Property Value

double | "Double"

Remarks

[ API set: ExcelApi 1.16 ]

basicValue

Warning

This API is now deprecated.

Deprecated since ExcelApi 1.19.

Represents the value that would be returned by Range.values for a cell with this value.

basicValue: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.16 ]

numberFormat

Warning

This API is now deprecated.

Deprecated since ExcelApi 1.19.

Returns the number format string that is used to display this value. When accessed through a valuesAsJson property, this number format string is in the en-US locale. When accessed through a valuesAsJsonLocal property, this number format is in the user's display locale. Number format strings must conform to Excel guidelines. To learn more, see Review guidelines for customizing a number format.

numberFormat: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.16 ]

type

Warning

This API is now deprecated.

Deprecated since ExcelApi 1.19.

Represents the type of this cell value.

type: CellValueType.formattedNumber | "FormattedNumber";

Property Value

formattedNumber | "FormattedNumber"

Remarks

[ API set: ExcelApi 1.16 ]