NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Tooling::SpreadsheetData Class Reference

Represents the spreadsheet. More...

Inheritance diagram for NXOpen::Tooling::SpreadsheetData:
NXOpen::TransientObject

List of all members.

Public Types

enum  KeywordType { KeywordTypeObjectAttribute = 1, KeywordTypePartAttribute, KeywordTypeExpression = 4 }
 Represents the different attribute or expression section in spreadsheet. More...
enum  ParameterStatus {
  ParameterStatusLock = 1, ParameterStatusSystemKey, ParameterStatusUserKey = 4, ParameterStatusHideStatus = 8,
  ParameterStatusScaleItem = 16, ParameterStatusReadOnly = 32, ParameterStatusModified = 64, ParameterStatusForceColor = 128,
  ParameterStatusHiddenValue = 256, ParameterStatusOptionValue = 512
}
 Represents the different spreadsheet parameter status. More...

Public Member Functions

void AddAssociatedObject (NXOpen::NXObject *associatedObject)
 Add object to be updated according to the spreadsheet data
Created in NX8.0.0.
void Close ()
 Close the spreadsheet and exit excel App
Created in NX8.0.1.
void EditParameter (const NXString &parameterName, const NXString &parameterValue)
 Modify the spreadsheet parameter.
void GetDefinedAttributesExpressions (NXOpen::Tooling::SpreadsheetData::KeywordType keywordType, std::vector< NXString > &objOrPartAttrNames, std::vector< NXString > &attrNames, std::vector< NXString > &attrValues)
 Get the object, part attributes or expressions defined in spreadsheet
Created in NX8.0.0.
void GetParameterValue (std::vector< NXOpen::Tooling::SpreadsheetDataParameter * > &parameters)
 Get the parameters with current select/input value
Created in NX8.0.0.
void ReadData (const NXString &spreadsheetFileName)
 Load the data from given spreadsheet file
Created in NX8.0.0.
void ReadData (NXOpen::NXObject *familyPart)
 Load the data from part family part
Created in NX8.0.0.
void SearchRecords (const NXString &searchConditions)
 Search the spreadsheet by the given conditions.
void SelectPrimaryParameter (const NXString &parameterName, const NXString &parameterValue)
 Change the primary parameter of the spreadsheet
Created in NX8.0.0.
void SetParameterStatus (const NXString &parameterName, int parameterStatus, bool isAdd)
 Sets the Lock/Hide or other status of spreadsheet parameter.
void Update ()
 Update the associated objects according to the spreadsheet data
Created in NX8.0.0.
virtual ~SpreadsheetData ()
 Dispose the spreadsheet object
Created in NX8.0.0.

Detailed Description

Represents the spreadsheet.


Created in NX8.0.0.


Member Enumeration Documentation

Represents the different attribute or expression section in spreadsheet.

Enumerator:
KeywordTypePartAttribute 

Part attribute defined in spreadsheet.

Represents the different spreadsheet parameter status.

Enumerator:
ParameterStatusSystemKey 

This is system key parameter.


Constructor & Destructor Documentation

Dispose the spreadsheet object
Created in NX8.0.0.



License requirements : None


Member Function Documentation

Add object to be updated according to the spreadsheet data
Created in NX8.0.0.



License requirements : None

Parameters:
associatedObjectthe object to be updated according to the spreadsheet data

Close the spreadsheet and exit excel App
Created in NX8.0.1.



License requirements : None

void NXOpen::Tooling::SpreadsheetData::EditParameter ( const NXString parameterName,
const NXString parameterValue 
)

Modify the spreadsheet parameter.


Created in NX8.0.0.

License requirements : None

Parameters:
parameterNamethe parameter name
parameterValuethe parameter value
void NXOpen::Tooling::SpreadsheetData::GetDefinedAttributesExpressions ( NXOpen::Tooling::SpreadsheetData::KeywordType  keywordType,
std::vector< NXString > &  objOrPartAttrNames,
std::vector< NXString > &  attrNames,
std::vector< NXString > &  attrValues 
)

Get the object, part attributes or expressions defined in spreadsheet
Created in NX8.0.0.



License requirements : None

Parameters:
keywordTypekeywordtype
objOrPartAttrNamesObject name or part attribute to find part
attrNamesattrnames
attrValuesArray of structures with the object attributes data.

Get the parameters with current select/input value
Created in NX8.0.0.



License requirements : None

Parameters:
parametersArray of structures with the parameter data.
void NXOpen::Tooling::SpreadsheetData::ReadData ( const NXString spreadsheetFileName)

Load the data from given spreadsheet file
Created in NX8.0.0.



License requirements : None

Parameters:
spreadsheetFileNameSpreadsheet file name, give CLI name in NX/Manager environment

Load the data from part family part
Created in NX8.0.0.



License requirements : None

Parameters:
familyPartthe part family part
void NXOpen::Tooling::SpreadsheetData::SearchRecords ( const NXString searchConditions)

Search the spreadsheet by the given conditions.


Created in NX8.0.0.

License requirements : None

Parameters:
searchConditionsthe search conditions
void NXOpen::Tooling::SpreadsheetData::SelectPrimaryParameter ( const NXString parameterName,
const NXString parameterValue 
)

Change the primary parameter of the spreadsheet
Created in NX8.0.0.



License requirements : None

Parameters:
parameterNamethe parameter name
parameterValuethe parameter value
void NXOpen::Tooling::SpreadsheetData::SetParameterStatus ( const NXString parameterName,
int  parameterStatus,
bool  isAdd 
)

Sets the Lock/Hide or other status of spreadsheet parameter.


Created in NX8.0.1.

License requirements : None

Parameters:
parameterNamethe parameter name
parameterStatusthe parameter status as defined in SpreadsheetData::ParameterStatus .
isAddSpecifies whether the parameter status should be added or removed. If true, then the status is added, else it is removed.

Update the associated objects according to the spreadsheet data
Created in NX8.0.0.



License requirements : None


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