SpreadsheetDataParameter Class¶
-
class
NXOpen.Tooling.SpreadsheetDataParameter¶ Bases:
NXOpen.TransientObjectRepresents parameter in the spreadsheet.
New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| DescriptiveName | Returns or sets the descriptive name of the parameter |
| ParameterName | Returns or sets the name of the parameter |
| ParameterStatus | Returns or sets the status of the parameter |
| ParameterValue | Returns or sets the value of the parameter |
Methods¶
| Method | Description |
|---|---|
| Dispose | Dispose the spreadsheet object |
| GetValueList | Get the list of values by giving a parameter name in spreadsheet |
| HasStatus | Check if the parameter has the given status |
Enumerations¶
| SpreadsheetDataParameterStatus Enumeration | Represents the different spreadsheet parameter status |
Property Detail¶
DescriptiveName¶
-
SpreadsheetDataParameter.DescriptiveName¶ Returns or sets the descriptive name of the parameter
-------------------------------------Getter Method
Signature
DescriptiveNameReturns: descriptive name of the parameter Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DescriptiveNameParameters: descriptiveName (str) – descriptive name of the parameter New in version NX8.0.0.
License requirements: None.
ParameterName¶
-
SpreadsheetDataParameter.ParameterName¶ Returns or sets the name of the parameter
-------------------------------------Getter Method
Signature
ParameterNameReturns: name of the parameter Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ParameterNameParameters: parameterName (str) – name of the parameter New in version NX8.0.0.
License requirements: None.
ParameterStatus¶
-
SpreadsheetDataParameter.ParameterStatus¶ Returns or sets the status of the parameter
-------------------------------------Getter Method
Signature
ParameterStatusReturns: status of the parameter Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ParameterStatusParameters: parameterStatus (int) – status of the parameter New in version NX10.0.0.
License requirements: None.
ParameterValue¶
-
SpreadsheetDataParameter.ParameterValue¶ Returns or sets the value of the parameter
-------------------------------------Getter Method
Signature
ParameterValueReturns: value of the parameter Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ParameterValueParameters: parameterValue (str) – value of the parameter New in version NX8.0.0.
License requirements: None.
Method Detail¶
Dispose¶
-
SpreadsheetDataParameter.Dispose¶ Dispose the spreadsheet object
Signature
Dispose()New in version NX8.0.0.
License requirements: None.
GetValueList¶
-
SpreadsheetDataParameter.GetValueList¶ Get the list of values by giving a parameter name in spreadsheet
Signature
GetValueList()Returns: The list of values Return type: list of str New in version NX10.0.0.
License requirements: None.
HasStatus¶
-
SpreadsheetDataParameter.HasStatus¶ Check if the parameter has the given status
Signature
HasStatus(parameterStatus)Parameters: parameterStatus ( NXOpen.Tooling.SpreadsheetDataParameterStatus) – status of the parameterReturns: true or not Return type: bool New in version NX10.0.0.
License requirements: None.