SpreadsheetCellData Class¶
-
class
NXOpen.
SpreadsheetCellData
¶ Bases:
NXOpen.TransientObject
Represents a class for Spreadsheet cell data.
The data type held in the cell can be obtained from the
NXOpen.SpreadsheetCellData.Type()
. And then the value can obtained from the correct accessor. The value and type of the cell will be changed when calling the set methods. That is if a cell was a formula, but theNXOpen.SpreadsheetCellData.DoubleValue()
is called, the type will be changed as well.It should be noted the cell value on the sheet will not updated, by calling a set method on this class. The object must then be passed into the appropriate method on
NXOpen.SpreadsheetManager
. .. Usable only on WindowsNew in version NX11.0.0.
Properties¶
Property | Description |
---|---|
DoubleValue | Returns or sets the double value stored in the cell. |
FormulaValue | Returns or sets the formula stored in the cell. |
IntValue | Returns or sets the integer value stored in the cell. |
LogicalValue | Returns or sets the logical value stored the cell. |
StringValue | Returns or sets the string value stored in the cell. |
Type | Returns or sets the type of data in the cell. |
Enumerations¶
SpreadsheetCellDataTypes Enumeration | Data types enum |
Property Detail¶
DoubleValue¶
-
SpreadsheetCellData.
DoubleValue
¶ Returns or sets the double value stored in the cell.
-------------------------------------
Getter Method
Signature
DoubleValue()
Returns: numeric value of the cell Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoubleValue(doubleValue)
Parameters: doubleValue (float) – New in version NX11.0.0.
License requirements: None.
FormulaValue¶
-
SpreadsheetCellData.
FormulaValue
¶ Returns or sets the formula stored in the cell.
-------------------------------------
Getter Method
Signature
FormulaValue()
Returns: formula of the cell Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FormulaValue(formulaValue)
Parameters: formulaValue (str) – New in version NX11.0.0.
License requirements: None.
IntValue¶
-
SpreadsheetCellData.
IntValue
¶ Returns or sets the integer value stored in the cell.
-------------------------------------
Getter Method
Signature
IntValue()
Returns: numeric value of the cell Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IntValue(intValue)
Parameters: intValue (int) – New in version NX11.0.0.
License requirements: None.
LogicalValue¶
-
SpreadsheetCellData.
LogicalValue
¶ Returns or sets the logical value stored the cell.
-------------------------------------
Getter Method
Signature
LogicalValue()
Returns: boolean value of the cell Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LogicalValue(logicalValue)
Parameters: logicalValue (bool) – New in version NX11.0.0.
License requirements: None.
StringValue¶
-
SpreadsheetCellData.
StringValue
¶ Returns or sets the string value stored in the cell.
-------------------------------------
Getter Method
Signature
StringValue()
Returns: sting value of the cell Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringValue(stringValue)
Parameters: stringValue (str) – New in version NX11.0.0.
License requirements: None.
Type¶
-
SpreadsheetCellData.
Type
¶ Returns or sets the type of data in the cell.
-------------------------------------
Getter Method
Signature
Type()
Returns: Type of value in cell Return type: NXOpen.SpreadsheetCellDataTypes
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(cellType)
Parameters: cellType ( NXOpen.SpreadsheetCellDataTypes
) –New in version NX11.0.0.
License requirements: None.
Method Detail¶
Dispose¶
-
SpreadsheetCellData.
Dispose
¶ Free resources associated with the instance.
After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Signature
Dispose()
New in version NX11.0.0.
License requirements: None.