ig.excel.ExcelCalcValue
Remarks
An instance of this class may contain one of several base data types including doubles, singles, integers, booleans, strings, and error values.
The class implements the IConvertible interface providing methods to perform conversions between the basic data types. Additionally the class provides methods to perform basic arithmetic operations and comparisons between ExcelCalcValue objects.Dependencies
-
ig.excel.ExcelCalcValue
Constructor- new $.ig.excel.ExcelCalcValue( value:object );
Initializes a new ExcelCalcValue
- value
- Type:object
- Object to be represented by the ExcelCalcValue.
-
ig.excel.ExcelCalcValue
Constructor- new $.ig.excel.ExcelCalcValue( );
Default constructor
-
areValuesEqual
- .areValuesEqual( x:ig.excel.ExcelCalcValue, y:ig.excel.ExcelCalcValue );
- Return Type:
- boolean
- Return Type Description:
- True if the values are the same; otherwise false is returned.
Indicates if the value of the specified ExcelCalcValue is equivalent to the ExcelCalcValue.value
- x
- Type:ig.excel.ExcelCalcValue
- First ExcelCalcValue to compare
- y
- Type:ig.excel.ExcelCalcValue
- Second ExcelCalcValue to compare
See Also
-
compare
- .compare( x:ig.excel.ExcelCalcValue, y:ig.excel.ExcelCalcValue );
- Return Type:
- number
- Return Type Description:
- -1, 1 or 0 depending on whether the current instance is less than, greater than or equal to the passed in instance respectively.
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.
- x
- Type:ig.excel.ExcelCalcValue
- The first value to compare.
- y
- Type:ig.excel.ExcelCalcValue
- The value to compare with the first value.
See Also
-
compareTo
- .compareTo( value:ig.excel.ExcelCalcValue );
- Return Type:
- number
- Return Type Description:
- -1, 1 or 0 depending on whether the current instance is less than, greater than or equal to the passed in instance respectively.
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.
- value
- Type:ig.excel.ExcelCalcValue
- The object that this instance should be compared against.
See Also
-
dateTimeToExcelDate
- .dateTimeToExcelDate( workbook:ig.excel.Workbook, dateValue:ig.Date );
Converts a DateTime to Excel's numerical representation of a date.
- workbook
- Type:ig.excel.Workbook
- dateValue
- Type:ig.Date
- The DateTime value to convert to the Microsoft Excel date format.
Remarks
When using the 1900 date system in Excel, dates before 3/1/1900 must be corrected, because Excel incorrectly assumes 1900 is a leap year. This overload assumes the 1900 date system is being used as so it corrects the date values.
See Also
-
dateTimeToExcelDate
- .dateTimeToExcelDate( workbook:ig.excel.Workbook, dateValue:ig.Date, shouldCorrect1900Dates:boolean );
Converts a DateTime to Excel's numerical representation of a date.
- workbook
- Type:ig.excel.Workbook
- dateValue
- Type:ig.Date
- The DateTime value to convert to the Microsoft Excel date format.
- shouldCorrect1900Dates
- Type:boolean
- When using the 1900 date system in Excel, dates before 3/1/1900 must be corrected, because Excel incorrectly assumes 1900 is a leap year. Pass False to disable this correction.
See Also
-
excelDateToDateTime
- .excelDateToDateTime( workbook:ig.excel.Workbook, excelDate:number );
Converts Excel's numerical representation of a date to a DateTime.
- workbook
- Type:ig.excel.Workbook
- excelDate
- Type:number
- The Microsoft Excel date format which should be converted to a DateTime.
Remarks
When using the 1900 date system in Excel, dates before 3/1/1900 must be corrected, because Excel incorrectly assumes 1900 is a leap year. This overload assumes the 1900 date system is being used as so it corrects the date values.
See Also
-
excelDateToDateTime
- .excelDateToDateTime( workbook:ig.excel.Workbook, excelDate:number, shouldCorrect1900Dates:boolean );
Converts Excel's numerical representation of a date to a DateTime.
- workbook
- Type:ig.excel.Workbook
- excelDate
- Type:number
- The Microsoft Excel date format which should be converted to a DateTime.
- shouldCorrect1900Dates
- Type:boolean
- When using the 1900 date system in Excel, dates before 3/1/1900 must be corrected, because Excel incorrectly assumes 1900 is a leap year. Pass False to disable this correction.
See Also
-
getResolvedValue
- .getResolvedValue( );
- Return Type:
- object
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
- .getResolvedValue( willUseValueInCalculations:boolean );
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.
- willUseValueInCalculations
- Type:boolean
- True if the value returned will actually be used in calculations; False if the value is being requested to inspect some aspect of it, such as its type.
-
isArray
- .isArray( );
- Return Type:
- boolean
- Return Type Description:
- True if this instance class contains an array, else false.
Returns whether this class instance contains an array value.
See Also
-
isArrayGroup
- .isArrayGroup( );
- Return Type:
- boolean
- Return Type Description:
- True if this instance class contains an array group, else false.
Returns whether this class instance contains a group of array values.
-
isBoolean
- .isBoolean( );
- Return Type:
- boolean
- Return Type Description:
- True if this instance class contains a boolean, else false
Returns whether this class instance contains a boolean value
-
isDateTime
- .isDateTime( );
- Return Type:
- boolean
- Return Type Description:
- True if this instance class contains a DateTime, else false
Returns whether this class instance contains a DateTime value
-
isDBNull
- .isDBNull( );
- Return Type:
- boolean
- Return Type Description:
- True if this instance class contains a null value, else false
Returns whether this class instance contains a DBNull value
-
isError
- .isError( );
- Return Type:
- boolean
- Return Type Description:
- True if this class instance contains an error, else false
Returns whether this class instance contains an error value
-
isNull
- .isNull( );
- Return Type:
- boolean
- Return Type Description:
- True if this instance class contains a null value, else false
Returns whether this class instance contains a null value
-
isReference
- .isReference( );
- Return Type:
- boolean
- Return Type Description:
- True if this instance class contains a reference, else false
Returns whether this class instance contains a IExcelCalcReference value
-
isSameValue
- .isSameValue( value:ig.excel.ExcelCalcValue );
- Return Type:
- boolean
- Return Type Description:
- True if the ExcelCalcValue.value of both instances are equal; otherwise false.
Indicates if the specified ExcelCalcValue has the save ExcelCalcValue.value as this instance.
- value
- Type:ig.excel.ExcelCalcValue
- ExcelCalcValue to compare against.
See Also
-
isString
- .isString( );
- Return Type:
- boolean
- Return Type Description:
- True if this instance class contains a string, else false
Returns whether this class instance contains a string value
-
toArrayProxy
- .toArrayProxy( );
- Return Type:
- ig.excel.ArrayProxy
- Return Type Description:
- An array equivalent to the value of this instance.
Convert this class instance's value to an ArrayProxy data type.
See Also
-
toArrayProxyGroup
- .toArrayProxyGroup( );
- Return Type:
- ig.excel.ArrayProxy[]
- Return Type Description:
- An array group equivalent to the value of this instance.
Convert this class instance's value to an array group data type.
See Also
-
toBoolean
- .toBoolean( provider:ig.IFormatProvider );
- Return Type:
- boolean
- Return Type Description:
- A boolean floating-point equivalent to the value of this instance
Convert this class instance's value to a boolean data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toBoolean
- .toBoolean( );
- Return Type:
- boolean
- Return Type Description:
- A boolean floating-point equivalent to the value of this instance
Convert this class instance's value to a boolean data type
See Also
-
toByte
- .toByte( provider:ig.IFormatProvider );
- Return Type:
- number
- Return Type Description:
- A 8-bit unsigned integer equivalent to the value of this instance
Convert this class instance's value to a byte data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toByte
- .toByte( );
Convert this class instance's value to a byte data type
See Also
-
toChar
- .toChar( provider:ig.IFormatProvider );
- Return Type:
- ig.String
- Return Type Description:
- A Unicode character equivalent to the value of this instance
Convert this class instance's value to a char type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toChar
- .toChar( );
- Return Type:
- ig.String
- Return Type Description:
- A Unicode character equivalent to the value of this instance
Convert this class instance's value to a char data type
See Also
-
toDateTime
- .toDateTime( provider:ig.IFormatProvider );
- Return Type:
- ig.Date
- Return Type Description:
- A DateTime equivalent to the value of this instance
Convert this class instance's value to a DateTime data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toDateTime
- .toDateTime( );
Convert this class instance's value to a DateTime data type
See Also
-
toDecimal
- .toDecimal( provider:ig.IFormatProvider );
- Return Type:
- number
- Return Type Description:
- A Decimal equivalent to the value of this instance
Convert this class instance's value to a decimal data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toDecimal
- .toDecimal( );
- Return Type:
- number
- Return Type Description:
- A Decimal equivalent to the value of this instance
Convert this class instance's value to a decimal data type
-
toDouble
- .toDouble( provider:ig.IFormatProvider );
- Return Type:
- number
- Return Type Description:
- A double-precision floating-point equivalent to the value of this instance
Convert this class instance's value to a double data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toDouble
- .toDouble( );
Convert this class instance's value to a double data type
See Also
-
toErrorValue
- .toErrorValue( );
- Return Type:
- ig.excel.ExcelCalcErrorValue
- Return Type Description:
- A ExcelCalcErrorValue containing the equivalent error code to the value of this instance
Convert this instance's value to an ExcelCalcErrorValue
Remarks
This method returns an ExcelCalcErrorValue whose error code is set this instance's error code.
If there this instance does not contain an error, a ExcelCalcErrorValue containing a default value is returnedSee Also
-
toInt
- .toInt( );
- Return Type:
- number
- Return Type Description:
- A signed 32-bit integer value containing the equivalent value of this instance
Convert this class instance's value to an int
-
toInt
- .toInt( provider:ig.IFormatProvider );
- Return Type:
- number
- Return Type Description:
- A signed 32-bit integer value containing the equivalent value of this instance
Convert this class instance's value to an int
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion to an integer this method will throw an InvalidCastException
-
toInt16
- .toInt16( provider:ig.IFormatProvider );
- Return Type:
- number
- Return Type Description:
- A 16-bit signed integer floating-point equivalent to the value of this instance
Convert this class instance's value to a short data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toInt16
- .toInt16( );
Convert this class instance's value to a short data type
See Also
-
toInt32
- .toInt32( provider:ig.IFormatProvider );
- Return Type:
- number
- Return Type Description:
- A 32-bit signed integer floating-point equivalent to the value of this instance
Convert this class instance's value to a int data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toInt32
- .toInt32( );
- Return Type:
- number
- Return Type Description:
- A 32-bit signed integer floating-point equivalent to the value of this instance
Convert this class instance's value to a int data type
See Also
-
toInt64
- .toInt64( provider:ig.IFormatProvider );
- Return Type:
- number
- Return Type Description:
- A 64-bit signed integer equivalent to the value of this instance
Convert this class instance's value to a long data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toInt64
- .toInt64( );
Convert this class instance's value to a long data type
See Also
-
toReference
- .toReference( );
- Return Type:
- ig.excel.IExcelCalcReference
- Return Type Description:
- If this instance contains a object that implements the IExcelCalcReference interface, this method returns the object instance, else an error reference is returned.
Convert this instance's value to a IExcelCalcReference.
Remarks
The instance value's underlying data type must be reference to return a reference, else an error reference is returned.
If there is no meaningful conversion to a reference, this method will throw an InvalidCastExceptionSee Also
-
toSingle
- .toSingle( provider:ig.IFormatProvider );
- Return Type:
- number
- Return Type Description:
- A single-precision floating-point equivalent to the value of this instance
Convert this class instance's value to a float data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
toSingle
- .toSingle( );
Convert this class instance's value to a float data type
See Also
-
toString
- .toString( );
- Return Type:
- string
- Return Type Description:
- String representation of instance's value
Returns a string representation of this instance's value.
-
toString1
- .toString1( provider:ig.IFormatProvider );
- Return Type:
- string
- Return Type Description:
- A string instance equivalent to the value of this instance
Convert this class instance's value to a string instance data type
- provider
- Type:ig.IFormatProvider
- An IFormatProvider interface implementation that supplies culture-specific formatting information
Remarks
If there is no meaningful conversion, this method will throw an InvalidCastException
-
value
- .value( );
Return the underlying value