NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::SpreadsheetCellData Class Reference

Represents a class for Spreadsheet cell data. More...

Inheritance diagram for NXOpen::SpreadsheetCellData:
NXOpen::TransientObject

Public Types

enum  Types {
  TypesInt, TypesDouble, TypesString, TypesLogical,
  TypesFormula
}
 Data types enum. More...
 

Public Member Functions

double DoubleValue ()
 Returns the double value stored in the cell. More...
 
NXString FormulaValue ()
 Returns the formula stored in the cell. More...
 
int IntValue ()
 Returns the integer value stored in the cell. More...
 
bool LogicalValue ()
 Returns the logical value stored the cell. More...
 
void SetDoubleValue (double doubleValue)
 Sets the double value stored in the cell. More...
 
void SetFormulaValue (const NXString &formulaValue)
 Sets the formula stored in the cell. More...
 
void SetFormulaValue (const char *formulaValue)
 Sets the formula stored in the cell. More...
 
void SetIntValue (int intValue)
 Sets the integer value stored in the cell. More...
 
void SetLogicalValue (bool logicalValue)
 Sets the logical value stored the cell. More...
 
void SetStringValue (const NXString &stringValue)
 Sets the string value stored in the cell. More...
 
void SetStringValue (const char *stringValue)
 Sets the string value stored in the cell. More...
 
void SetType (NXOpen::SpreadsheetCellData::Types cellType)
 Sets the type of data in the cell. More...
 
NXString StringValue ()
 Returns the string value stored in the cell. More...
 
NXOpen::SpreadsheetCellData::Types Type ()
 Returns the type of data in the cell. More...
 
virtual ~SpreadsheetCellData ()
 Free resources associated with the instance. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

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 the NXOpen::SpreadsheetCellData::SetDoubleValue 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 Windows

Created in NX11.0.0.

Member Enumeration Documentation

Data types enum.

Enumerator
TypesInt 

int

TypesDouble 

double

TypesString 

string

TypesLogical 

logical

TypesFormula 

formula

Constructor & Destructor Documentation

virtual NXOpen::SpreadsheetCellData::~SpreadsheetCellData ( )
virtual

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.
Created in NX11.0.0.

License requirements : None

Member Function Documentation

double NXOpen::SpreadsheetCellData::DoubleValue ( )

Returns the double value stored in the cell.


Created in NX11.0.0.

License requirements : None

NXString NXOpen::SpreadsheetCellData::FormulaValue ( )

Returns the formula stored in the cell.


Created in NX11.0.0.

License requirements : None

int NXOpen::SpreadsheetCellData::IntValue ( )

Returns the integer value stored in the cell.


Created in NX11.0.0.

License requirements : None

bool NXOpen::SpreadsheetCellData::LogicalValue ( )

Returns the logical value stored the cell.


Created in NX11.0.0.

License requirements : None

void NXOpen::SpreadsheetCellData::SetDoubleValue ( double  doubleValue)

Sets the double value stored in the cell.


Created in NX11.0.0.

License requirements : None

Parameters
doubleValuedouble value
void NXOpen::SpreadsheetCellData::SetFormulaValue ( const NXString formulaValue)

Sets the formula stored in the cell.


Created in NX11.0.0.

License requirements : None

Parameters
formulaValueformula value
void NXOpen::SpreadsheetCellData::SetFormulaValue ( const char *  formulaValue)

Sets the formula stored in the cell.


Created in NX11.0.0.

License requirements : None

Parameters
formulaValueformula value
void NXOpen::SpreadsheetCellData::SetIntValue ( int  intValue)

Sets the integer value stored in the cell.


Created in NX11.0.0.

License requirements : None

Parameters
intValueint value
void NXOpen::SpreadsheetCellData::SetLogicalValue ( bool  logicalValue)

Sets the logical value stored the cell.


Created in NX11.0.0.

License requirements : None

Parameters
logicalValuelogical value
void NXOpen::SpreadsheetCellData::SetStringValue ( const NXString stringValue)

Sets the string value stored in the cell.


Created in NX11.0.0.

License requirements : None

Parameters
stringValuestring value
void NXOpen::SpreadsheetCellData::SetStringValue ( const char *  stringValue)

Sets the string value stored in the cell.


Created in NX11.0.0.

License requirements : None

Parameters
stringValuestring value
void NXOpen::SpreadsheetCellData::SetType ( NXOpen::SpreadsheetCellData::Types  cellType)

Sets the type of data in the cell.


Created in NX11.0.0.

License requirements : None

Parameters
cellTypecelltype
NXString NXOpen::SpreadsheetCellData::StringValue ( )

Returns the string value stored in the cell.


Created in NX11.0.0.

License requirements : None

NXOpen::SpreadsheetCellData::Types NXOpen::SpreadsheetCellData::Type ( )

Returns the type of data in the cell.


Created in NX11.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.