NXOpen.Tooling.SpreadsheetDataParameter Class Reference

Represents parameter in the spreadsheet. More...

Inheritance diagram for NXOpen.Tooling.SpreadsheetDataParameter:

Public Types
enum	Status {   Lock = 1, SystemKey, UserKey = 4, HideStatus = 8,   ScaleItem = 16, ReadOnly = 32, Modified = 64, ForceColor = 128,   HiddenValue = 256, OptionValue = 512, NonStandardValue = 1024, ShipRule = 2048 }
	Represents the different spreadsheet parameter status More...

Public Member Functions
unsafe void	GetValueList (out string[] paraValues)
	Get the list of values by giving a parameter name in spreadsheet More...
unsafe bool	HasStatus (NXOpen.Tooling.SpreadsheetDataParameter.Status parameterStatus)
	Check if the parameter has the given status More...
Public Member Functions inherited from NXOpen.TransientObject
void	Dispose ()
	Frees the object from memory. More...
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
new string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Protected Member Functions
override void	FreeResource ()
	Dispose the spreadsheet object More...

Properties
unsafe string	DescriptiveName [get, set]
	Returns or sets the descriptive name of the parameter More...
unsafe string	ParameterName [get, set]
	Returns or sets the name of the parameter More...
unsafe int	ParameterStatus [get, set]
	Returns or sets the status of the parameter More...
unsafe string	ParameterValue [get, set]
	Returns or sets the value of the parameter More...
Properties inherited from NXOpen.TransientObject
IntPtr	Handle [get]
	Handle of the internal object represented by this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Detailed Description

Represents parameter in the spreadsheet.

Created in NX8.0.0

Member Enumeration Documentation

enum NXOpen.Tooling.SpreadsheetDataParameter.Status

Represents the different spreadsheet parameter status

Enumerator
Lock	User can't change the value in UI
SystemKey	This is system key parameter
UserKey	Key parameter analyzed from spreadsheet search
HideStatus	Not shown in UI
ScaleItem	This is a scale item
ReadOnly	This parameter is read only
Modified	The parameter value is changed
ForceColor	If the parameter uses user value, normally it shows in UI in a different color. If this status is set, the parameter value will be shown in the same color.
HiddenValue	The parameter has value, but it should be hidden to user
OptionValue	The parameter has multiple value, but not treated as key parameter
NonStandardValue	The current value of this parameter is user's input, not from spreadsheet
ShipRule	This is used for ship design to trigger design. Syntax is ^$parameterName. 0 not to trigger rule, 1 to trigger rule.

Member Function Documentation

override void NXOpen.Tooling.SpreadsheetDataParameter.FreeResource ( )

inlineprotectedvirtual

Dispose the spreadsheet object

Created in NX8.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe void NXOpen.Tooling.SpreadsheetDataParameter.GetValueList ( out string[]  paraValues )

inline

Get the list of values by giving a parameter name in spreadsheet

Created in NX10.0.0

License requirements: None.

Parameters

paraValues

The list of values

unsafe bool NXOpen.Tooling.SpreadsheetDataParameter.HasStatus ( NXOpen.Tooling.SpreadsheetDataParameter.Status  parameterStatus )

inline

Check if the parameter has the given status

Created in NX10.0.0

License requirements: None.

Parameters

parameterStatus

status of the parameter

Returns

true or not

Property Documentation

unsafe string NXOpen.Tooling.SpreadsheetDataParameter.DescriptiveName

getset

Returns or sets the descriptive name of the parameter

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Tooling.SpreadsheetDataParameter.ParameterName

getset

Returns or sets the name of the parameter

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Tooling.SpreadsheetDataParameter.ParameterStatus

getset

Returns or sets the status of the parameter

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Tooling.SpreadsheetDataParameter.ParameterValue

getset

Returns or sets the value of the parameter

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

---

The documentation for this class was generated from the following file:

• Tooling_SpreadsheetDataParameter.cs