Provides methods that manage a composite data type representing a value.

Constructors

Section titled "Constructors"

ExcelCalcValue

new ExcelCalcValue(value: any): ExcelCalcValue

Returns ExcelCalcValue

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

isArray

Section titled "isArray"

Returns whether this class instance contains an array value.

get isArray(): boolean

Returns boolean

isArrayGroup

Section titled "isArrayGroup"

Returns whether this class instance contains a group of array values.

get isArrayGroup(): boolean

Returns boolean

isBoolean

Section titled "isBoolean"

Returns whether this class instance contains a boolean value

get isBoolean(): boolean

Returns boolean

isDateTime

Section titled "isDateTime"

Returns whether this class instance contains a DateTime value

get isDateTime(): boolean

Returns boolean

isDBNull

Section titled "isDBNull"

Returns whether this class instance contains a DBNull value

get isDBNull(): boolean

Returns boolean

isError

Section titled "isError"

Returns whether this class instance contains an error value

get isError(): boolean

Returns boolean

isNull

Section titled "isNull"

Returns whether this class instance contains a null value

get isNull(): boolean

Returns boolean

isReference

Section titled "isReference"

Returns whether this class instance contains a [[IExcelCalcReference]] value

get isReference(): boolean

Returns boolean

isString

Section titled "isString"

Returns whether this class instance contains a string value

get isString(): boolean

Returns boolean

value

Section titled "value"

Return the underlying value

get value(): any

Returns any

Methods

Section titled "Methods"

compareTo

Section titled "compareTo"

Compares current instance with the passed in [[ExcelCalcValue]] instance. Returns -1, 1 or 0 depending on whether the current instance is less than, greater than or equal to the passed in instance respectively.

compareTo(value: ExcelCalcValue): number

Parameters

  • value: ExcelCalcValue

    The object that this instance should be compared against.

Returns number

getResolvedValue

Section titled "getResolvedValue"

Gets the resolved value of the reference. This method will walk down the reference chain recursively to get the resolved value of the reference that is not just another reference.

getResolvedValue(): any

Returns any

isSameValue

Section titled "isSameValue"

Indicates if the specified [[ExcelCalcValue]] has the save [[value]] as this instance.

isSameValue(value: ExcelCalcValue): boolean

Parameters

Returns boolean

toArrayProxy

Section titled "toArrayProxy"

Convert this class instance's value to an [[ArrayProxy]] data type.

toArrayProxy(): ArrayProxy

Returns ArrayProxy

toArrayProxyGroup

Section titled "toArrayProxyGroup"

Convert this class instance's value to an array group data type.

toArrayProxyGroup(): ArrayProxy[]

Returns ArrayProxy[]

toBoolean

Section titled "toBoolean"

Convert this class instance's value to a boolean data type

toBoolean(provider: IFormatProvider): boolean

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns boolean

toByte

Section titled "toByte"

Convert this class instance's value to a byte data type

toByte(provider: IFormatProvider): number

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns number

toChar

Section titled "toChar"

Convert this class instance's value to a char type

toChar(provider: IFormatProvider): string

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns string

toDateTime

Section titled "toDateTime"

Convert this class instance's value to a DateTime data type

toDateTime(provider: IFormatProvider): Date

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns Date

toDecimal

Section titled "toDecimal"

Convert this class instance's value to a decimal data type

toDecimal(provider: IFormatProvider): number

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns number

toDouble

Section titled "toDouble"

Convert this class instance's value to a double data type

toDouble(provider: IFormatProvider): number

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns number

toErrorValue

Section titled "toErrorValue"

Convert this instance's value to an [[ExcelCalcErrorValue]]

toErrorValue(): ExcelCalcErrorValue

Returns ExcelCalcErrorValue

toInt

Section titled "toInt"

Convert this class instance's value to an int

toInt(): number

Returns number

toInt16

Section titled "toInt16"

Convert this class instance's value to a short data type

toInt16(provider: IFormatProvider): number

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns number

toInt32

Section titled "toInt32"

Convert this class instance's value to a int data type

toInt32(provider: IFormatProvider): number

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns number

toInt64

Section titled "toInt64"

Convert this class instance's value to a long data type

toInt64(provider: IFormatProvider): number

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns number

toReference

Section titled "toReference"

Convert this instance's value to a [[IExcelCalcReference]].

toReference(): IExcelCalcReference

Returns IExcelCalcReference

toSingle

Section titled "toSingle"

Convert this class instance's value to a float data type

toSingle(provider: IFormatProvider): number

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns number

toString

Section titled "toString"

Returns a string representation of this instance's value.

toString(): string

Returns string

toString1

Section titled "toString1"

Convert this class instance's value to a string instance data type

toString1(provider: IFormatProvider): string

Parameters

  • provider: IFormatProvider

    An IFormatProvider interface implementation that supplies culture-specific formatting information

Returns string

areValuesEqual

Section titled "areValuesEqual"

Indicates if the value of the specified [[ExcelCalcValue]] is equivalent to the [[value]]

areValuesEqual(x: ExcelCalcValue, y: ExcelCalcValue): boolean

Parameters

Returns boolean

compareTo

Section titled "compareTo"

Compares x and y [[ExcelCalcValue]] instances and returns -1 if x is less than y, 1 if x is greater than y and 0 if x and y are equal.

compareTo(x: ExcelCalcValue, y: ExcelCalcValue): number

Parameters

Returns number

dateTimeToExcelDate

Section titled "dateTimeToExcelDate"

Converts a DateTime to Excel's numerical representation of a date.

dateTimeToExcelDate(workbook: Workbook, dateValue: Date): number

Parameters

  • workbook: Workbook
  • dateValue: Date

    The DateTime value to convert to the Microsoft Excel date format.

Returns number

excelDateToDateTime

Section titled "excelDateToDateTime"

Converts Excel's numerical representation of a date to a DateTime.

excelDateToDateTime(workbook: Workbook, excelDate: number): Date

Parameters

  • workbook: Workbook
  • excelDate: number

    The Microsoft Excel date format which should be converted to a DateTime.

Returns Date