Represents the spreadsheet data which could be standalone spreadsheet file with special format or be the spreadsheet data from part family template part, the latter format will not have any other data except the name and value in class NXOpen.Tooling.SpreadsheetDataParameter , that means it might not return any result in some methods such as "GetDefinedAttributesExpressions". More...

Inheritance diagram for NXOpen.Tooling.SpreadsheetData:

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

enum	KeywordType { ObjectAttribute = 1, PartAttribute, Expression = 4 }
	Represents the different attribute or expression section in spreadsheet More...

Public Member Functions
unsafe void	Close ()
	Close the spreadsheet and exit excel App More...

unsafe void	ReadData (string spreadsheetFileName)
	Load the data from given spreadsheet file More...

unsafe void	ReadData (NXOpen.NXObject familyPart)
	Load the data from part family part More...

unsafe void	GetParameterValue (out NXOpen.Tooling.SpreadsheetDataParameter[] parameters)
	Get the parameters with current select/input value More...

unsafe void	SelectPrimaryParameter (string parameterName, string parameterValue)
	Change the primary parameter of the spreadsheet More...

unsafe void	EditParameter (string parameterName, string parameterValue)
	Modify the spreadsheet parameter. More...

unsafe void	SetParameterStatus (string parameterName, int parameterStatus, bool isAdd)
	Sets the Lock/Hide or other status of spreadsheet parameter. More...

unsafe void	SearchRecords (string searchConditions)
	Search the spreadsheet by the given conditions. More...

unsafe void	AddAssociatedObject (NXOpen.NXObject associatedObject)
	Add object to be updated according to the spreadsheet data More...

unsafe void	Update ()
	Update the associated objects according to the spreadsheet data More...

unsafe void	UpdateModel (bool doUpdateImmediately, bool updatePartAttribute)
	Update the associated objects according to the spreadsheet data with the options More...

unsafe void	GetDefinedAttributesExpressions (NXOpen.Tooling.SpreadsheetData.KeywordType keywordType, out string[] objOrPartAttrNames, out string[] attrNames, out string[] attrValues)
	Get the object, part attributes or expressions defined in spreadsheet More...

unsafe void	GetParameterValueList (string parameterName, out string[] paraValues)
	Get the list of values by giving a parameter name in spreadsheet More...

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

Detailed Description

Represents the spreadsheet data which could be standalone spreadsheet file with special format or be the spreadsheet data from part family template part, the latter format will not have any other data except the name and value in class NXOpen.Tooling.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 NXOpen.Tooling.ToolingSession.CreateSpreadsheetData .

Created in NX8.0.0

Member Enumeration Documentation

enum NXOpen.Tooling.SpreadsheetData.KeywordType

Represents the different attribute or expression section in spreadsheet

Enumerator
ObjectAttribute	Object attribute defined in spreadsheet
PartAttribute	Part attribute defined in spreadsheet
Expression	Expression defined in spreadsheet

enum NXOpen.Tooling.SpreadsheetData.ParameterStatus

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

Member Function Documentation

unsafe void NXOpen.Tooling.SpreadsheetData.AddAssociatedObject ( NXOpen.NXObject associatedObject )

Add object to be updated according to the spreadsheet data

Created in NX8.0.0

License requirements: None.

Parameters

associatedObject the object to be updated according to the spreadsheet data

unsafe void NXOpen.Tooling.SpreadsheetData.Close ( )

Close the spreadsheet and exit excel App

Created in NX8.0.1

License requirements: None.

unsafe void NXOpen.Tooling.SpreadsheetData.EditParameter	(	string	parameterName,
		string	parameterValue
	)

Modify the spreadsheet parameter.

Created in NX8.0.0

License requirements: None.

Parameters

parameterName	the parameter name
parameterValue	the parameter value

override void NXOpen.Tooling.SpreadsheetData.FreeResource ( )

protected

Dispose the spreadsheet object

Created in NX8.0.0

License requirements: None.

unsafe void NXOpen.Tooling.SpreadsheetData.GetDefinedAttributesExpressions	(	NXOpen.Tooling.SpreadsheetData.KeywordType	keywordType,
		out string[]	objOrPartAttrNames,
		out string[]	attrNames,
		out string[]	attrValues
	)

Get the object, part attributes or expressions defined in spreadsheet

Created in NX8.0.0

License requirements: None.

Parameters

keywordType
objOrPartAttrNames	Object name or part attribute to find part
attrNames
attrValues	Array of structures with the object attributes data.

unsafe void NXOpen.Tooling.SpreadsheetData.GetParameterValue ( out NXOpen.Tooling.SpreadsheetDataParameter[] parameters )

Get the parameters with current select/input value

Created in NX8.0.0

License requirements: None.

Parameters

parameters Array of structures with the parameter data.

unsafe void NXOpen.Tooling.SpreadsheetData.GetParameterValueList	(	string	parameterName,
		out string[]	paraValues
	)

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

Created in NX10.0.0

License requirements: None.

Parameters

parameterName
paraValues	The list of values

unsafe void NXOpen.Tooling.SpreadsheetData.ReadData ( string spreadsheetFileName )

Load the data from given spreadsheet file

Created in NX8.0.0

License requirements: None.

Parameters

spreadsheetFileName Spreadsheet file name, give CLI name in NX/Manager environment

unsafe void NXOpen.Tooling.SpreadsheetData.ReadData ( NXOpen.NXObject familyPart )

Load the data from part family part

Created in NX8.0.0

License requirements: None.

Parameters

familyPart the part family part

unsafe void NXOpen.Tooling.SpreadsheetData.SearchRecords ( string searchConditions )

Search the spreadsheet by the given conditions.

Created in NX8.0.0

License requirements: None.

Parameters

searchConditions the search conditions

unsafe void NXOpen.Tooling.SpreadsheetData.SelectPrimaryParameter	(	string	parameterName,
		string	parameterValue
	)

Change the primary parameter of the spreadsheet

Created in NX8.0.0

License requirements: None.

Parameters

parameterName	the parameter name
parameterValue	the parameter value

unsafe void NXOpen.Tooling.SpreadsheetData.SetParameterStatus	(	string	parameterName,
		int	parameterStatus,
		bool	isAdd
	)

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

Created in NX8.0.1

License requirements: None.

Parameters

parameterName	the parameter name
parameterStatus	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.

unsafe void NXOpen.Tooling.SpreadsheetData.Update ( )

Update the associated objects according to the spreadsheet data

Created in NX8.0.0

License requirements: None.

unsafe void NXOpen.Tooling.SpreadsheetData.UpdateModel	(	bool	doUpdateImmediately,
		bool	updatePartAttribute
	)

Update the associated objects according to the spreadsheet data with the options

Created in NX9.0.3

License requirements: None.

Parameters

doUpdateImmediately	Specifies whether to perform an update immediately.
updatePartAttribute	Specifies whether part attributes should be updated.

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

dotnet_pool/Tooling_SpreadsheetData.cs

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation