public interface SpreadsheetData extends TransientObject
SpreadsheetDataParameter
, that means
it might not return any result in some methods such as "GetDefinedAttributesExpressions".
About the standalone file format, it can refer to the sections below in NX Help:
CAD->Shipbuilding->Installing templates and customizing the Ship Structure applications->Customizing the ship steel feature library->Steel feature parameter spreadsheet format
CAD->Shipbuilding->Installing templates and customizing the Ship Structure applications->Customizing the standard parts library->Standard parts spreadsheet symbols
or the example files as below:
$UGII_BASE_DIR/NXPARTS/Reuse Library/Reusable Object Library/Metric/Boss/Cross_Boss_01.xlsx
$UGII_BASE_DIR/NXPARTS/Reuse Library/Reuse Examples/Standard Parts/DIN/Profile/Pipe-Tube/Cold-worked Welded Rect Steel Tube, DIN.xls
To create an instance of this class, call the method ToolingSession.createSpreadsheetData()
.
Modifier and Type | Interface and Description |
---|---|
static class |
SpreadsheetData.DefinedAttributesExpressionsData
This class holds the data returned from
getDefinedAttributesExpressions(nxopen.tooling.SpreadsheetData.KeywordType) |
static class |
SpreadsheetData.KeywordType
Represents the different attribute or expression section in spreadsheet
|
static class |
SpreadsheetData.ParameterStatus
Represents the different spreadsheet parameter status
|
Modifier and Type | Method and Description |
---|---|
void |
addAssociatedObject(NXObject associatedObject)
Add object to be updated according to the spreadsheet data
License requirements: None. |
void |
close()
Close the spreadsheet and exit excel App
License requirements: None. |
void |
editParameter(String parameterName,
String parameterValue)
Modify the spreadsheet parameter.
|
SpreadsheetData.DefinedAttributesExpressionsData |
getDefinedAttributesExpressions(SpreadsheetData.KeywordType keywordType)
Get the object, part attributes or expressions defined in spreadsheet
License requirements: None. |
SpreadsheetDataParameter[] |
getParameterValue()
Get the parameters with current select/input value
License requirements: None. |
String[] |
getParameterValueList(String parameterName)
Get the list of values by giving a parameter name in spreadsheet
License requirements: None. |
void |
readData(NXObject familyPart)
Load the data from part family part
License requirements: None. |
void |
readData(String spreadsheetFileName)
Load the data from given spreadsheet file
License requirements: None. |
void |
searchRecords(String searchConditions)
Search the spreadsheet by the given conditions.
|
void |
selectPrimaryParameter(String parameterName,
String parameterValue)
Change the primary parameter of the spreadsheet
License requirements: None. |
void |
setParameterStatus(String parameterName,
int parameterStatus,
boolean isAdd)
Sets the Lock/Hide or other status of spreadsheet parameter.
|
void |
update()
Update the associated objects according to the spreadsheet data
License requirements: None. |
void |
updateModel(boolean doUpdateImmediately,
boolean updatePartAttribute)
Update the associated objects according to the spreadsheet data with the options
License requirements: None. |
_value, dispose, printTestData, printTestData
void close() throws NXException, RemoteException
NXException
RemoteException
void readData(String spreadsheetFileName) throws NXException, RemoteException
spreadsheetFileName
- Spreadsheet file name, give CLI name in NX/Manager environmentNXException
RemoteException
void readData(NXObject familyPart) throws NXException, RemoteException
familyPart
- the part family partNXException
RemoteException
SpreadsheetDataParameter[] getParameterValue() throws NXException, RemoteException
NXException
RemoteException
void selectPrimaryParameter(String parameterName, String parameterValue) throws NXException, RemoteException
parameterName
- the parameter nameparameterValue
- the parameter valueNXException
RemoteException
void editParameter(String parameterName, String parameterValue) throws NXException, RemoteException
parameterName
- the parameter nameparameterValue
- the parameter valueNXException
RemoteException
void setParameterStatus(String parameterName, int parameterStatus, boolean isAdd) throws NXException, RemoteException
parameterName
- the parameter nameparameterStatus
- the parameter status as defined in SpreadsheetData.ParameterStatus
.isAdd
- Specifies whether the parameter status should be added or removed. If true, then the status is added, else it is removed.NXException
RemoteException
void searchRecords(String searchConditions) throws NXException, RemoteException
searchConditions
- the search conditionsNXException
RemoteException
void addAssociatedObject(NXObject associatedObject) throws NXException, RemoteException
associatedObject
- the object to be updated according to the spreadsheet dataNXException
RemoteException
void update() throws NXException, RemoteException
NXException
RemoteException
void updateModel(boolean doUpdateImmediately, boolean updatePartAttribute) throws NXException, RemoteException
doUpdateImmediately
- Specifies whether to perform an update immediately.updatePartAttribute
- Specifies whether part attributes should be updated.NXException
RemoteException
SpreadsheetData.DefinedAttributesExpressionsData getDefinedAttributesExpressions(SpreadsheetData.KeywordType keywordType) throws NXException, RemoteException
keywordType
- NXException
RemoteException
String[] getParameterValueList(String parameterName) throws NXException, RemoteException
parameterName
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.