Represents the collection of all ParamLibParameter objects in this Part. More...

Inheritance diagram for NXOpen.ParamLibParameterCollection:

Public Member Functions
unsafe NXOpen.ParamLibParameter	CopyParameterFromLibrary (string libraryName, string libraryReference)
	Creates an editable parameter (copy) in the part from a library parameter definition. More...

unsafe NXOpen.ParamLibParameter	CopyParameterFromLibrary (string libraryName, string libraryReference, bool retainParentPedigree)
	Creates an editable parameter (copy) in the part from a library parameter definition. More...

unsafe NXOpen.ParamLibParameterListBuilder	CreateListBlockBuilder ()
	Creates a NXOpen.ParamLibParameterListBuilder that controls the parameters list UI block look and feel as well as capturing the interactions so the values/settings can be journaled. More...

unsafe NXOpen.ParamLibParameterListBuilder	CreateListBlockBuilder1 (string[] pcLibTypeNeuNames)
	Creates a NXOpen.ParamLibParameterListBuilder that controls the parameters list UI block look and feel as well as capturing the interactions so the values/settings can be journaled. More...

unsafe NXOpen.ParamLibParameterBuilder	CreateParameterBuilder (string libTypeNeutralName, int parameterType)
	Creates a ParamLibParameterBuilder used to create a parameter of a given type of a given type of parameter library. More...

unsafe NXOpen.ParamLibParameterBuilder	CreateParameterEditBuilder (NXOpen.ParamLibParameter parameterTag)
	Creates a ParamLibParameterBuilder used to edit parameters. More...

unsafe NXOpen.ParamLibParameterBuilder	CreateParameterInspectBuilder (NXOpen.ParamLibParameter parameterTag)
	Creates a ParamLibParameterBuilder used to inspect parameters. More...

unsafe NXOpen.ParamLibLibraryManagerBuilder	CreateParameterLibmgrBuilder (string[] pcLibTypeNeuNames)
	Creates a ParamLibLibraryManagerBuilder used by the parameter library manager UI to control the look and feel as well as capturing the interactions so the values/settings can be journaled. More...

unsafe void	DeleteParametersFromLibrary (string[] pParamNames, string pcLibName)
	Deletes the parameters from a parameter library file. More...

unsafe void	ExportParametersToLibrary (string[] pcParamNames, string[] pcLibNames, string pcExportedLibName, bool[] bUpdateLibraryReference)
	Writes out parameters to a parameter library file. More...

unsafe void	ExportParametersToLibrary (string[] pcParamNames, string[] pcLibNames, string pcExportedLibName, bool bUpdateLibraryReference)
	Writes out parameters to a parameter library file. More...

unsafe NXOpen.ParamLibParameter	FindObject (string journalIdentifier)
	Finds the NXOpen.ParamLibParameter with the given identifier as recorded in a journal. More...

unsafe NXOpen.ParamLibParameter	GetLoadedLibraryParameter (string pcLibName, string pcParamName)
	Checks if a library parameter is loaded into a part file or not. More...

unsafe NXOpen.ParamLibParameter[]	GetUsedParameters ()
	Returns the parameters used in the part. More...

unsafe void	InfoLibraryParameter (string pcLibAr, string pcParamNameAr)
	Displays the property values for the specified library parameter in the information window. More...

unsafe void	InfoLibraryParameterToFile (string pcLibAr, string pcParamNameAr, bool bOverride, string pcFileName)
	Writes the property values for the specified library parameter to a file. More...

unsafe NXOpen.ParamLibParameter	LoadFromNxparampllibrary (string parameterName)
	Creates a non-editable parameter in the part from a NX parameter library parameter definition. More...

unsafe NXOpen.ParamLibParameter	LoadFromParamplLibrary (string libraryName, string parameterName)
	Creates a non-editable parameter in the part from a parameter library file definition. More...

unsafe void	OutputParametersToLibrary (string[] pcParamNames, string[] pcLibNames, string pcExportedLibName)
	Writes out parameters to a parameter library file. More...

NXOpen.ParamLibParameter[]	ToArray ()
	Returns an array of NXOpen.ParamLibParameter objects. More...

unsafe void	UpdateParametersInLibrary (NXOpen.ParamLibParameter[] tEditedParam, string[] pParamNames, string pcLibName)
	Updates the parameters in a parameter library file. More...

Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator	GetEnumerator ()
	Returns an enumerator that iterates through a collection. 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 int	EnumerateMoveNext (ref Tag currentTag, byte[] state)
	Advances the enumerator to the next element of the collection. More...

Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void	initialize ()
	<exclude> More...

Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Properties
Tag	Tag `[get]`
	Returns the tag of this object. More...

Detailed Description

Represents the collection of all ParamLibParameter objects in this Part.

To obtain an instance of this class, refer to NXOpen.ParamLibParameterLibraryManager

Created in NX1847.0.0

Member Function Documentation

unsafe NXOpen.ParamLibParameter NXOpen.ParamLibParameterCollection.CopyParameterFromLibrary	(	string	libraryName,
		string	libraryReference
	)

inline

Creates an editable parameter (copy) in the part from a library parameter definition.

Created in NX1847.0.0

License requirements: None.

Parameters

libraryName	the fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
libraryReference	the parameter name/identifier

Returns: the copied parameter

unsafe NXOpen.ParamLibParameter NXOpen.ParamLibParameterCollection.CopyParameterFromLibrary	(	string	libraryName,
		string	libraryReference,
		bool	retainParentPedigree
	)

inline

Creates an editable parameter (copy) in the part from a library parameter definition.

Created in NX1847.0.0

License requirements: None.

Parameters

libraryName	the fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
libraryReference	the parameter name/identifier
retainParentPedigree	true indicates that the copied parameter should retain information about what library parameter it came from

Returns: the copied parameter

unsafe NXOpen.ParamLibParameterListBuilder NXOpen.ParamLibParameterCollection.CreateListBlockBuilder ( )

inline

Creates a NXOpen.ParamLibParameterListBuilder that controls the parameters list UI block look and feel as well as capturing the interactions so the values/settings can be journaled.

Created in NX1847.0.0

License requirements: None.

Returns: created NXOpen.ParamLibParameterListBuilder

unsafe NXOpen.ParamLibParameterListBuilder NXOpen.ParamLibParameterCollection.CreateListBlockBuilder1 ( string[] pcLibTypeNeuNames )

inline

Creates a NXOpen.ParamLibParameterListBuilder that controls the parameters list UI block look and feel as well as capturing the interactions so the values/settings can be journaled.

Created in NX1847.0.0

License requirements: None.

Parameters

pcLibTypeNeuNames Array of neutral names of valid parameter library types

Returns: created NXOpen.ParamLibParameterListBuilder

unsafe NXOpen.ParamLibParameterBuilder NXOpen.ParamLibParameterCollection.CreateParameterBuilder	(	string	libTypeNeutralName,
		int	parameterType
	)

inline

Creates a ParamLibParameterBuilder used to create a parameter of a given type of a given type of parameter library.

Created in NX1847.0.0

License requirements: None.

Parameters

libTypeNeutralName	Neutral name of parameter library type
parameterType	Type of NXOpen.ParamLibParameter to be created

Returns: created NXOpen.ParamLibParameterBuilder

unsafe NXOpen.ParamLibParameterBuilder NXOpen.ParamLibParameterCollection.CreateParameterEditBuilder ( NXOpen.ParamLibParameter parameterTag )

inline

Creates a ParamLibParameterBuilder used to edit parameters.

Created in NX1847.0.0

License requirements: None.

Parameters

parameterTag NXOpen.ParamLibParameter to be edited

Returns: created NXOpen.ParamLibParameterBuilder

unsafe NXOpen.ParamLibParameterBuilder NXOpen.ParamLibParameterCollection.CreateParameterInspectBuilder ( NXOpen.ParamLibParameter parameterTag )

inline

Creates a ParamLibParameterBuilder used to inspect parameters.

Created in NX1847.0.0

License requirements: None.

Parameters

parameterTag NXOpen.ParamLibParameter to be inspected

Returns: created NXOpen.ParamLibParameterBuilder

unsafe NXOpen.ParamLibLibraryManagerBuilder NXOpen.ParamLibParameterCollection.CreateParameterLibmgrBuilder ( string[] pcLibTypeNeuNames )

inline

Creates a ParamLibLibraryManagerBuilder used by the parameter library manager UI to control the look and feel as well as capturing the interactions so the values/settings can be journaled.

Created in NX1847.0.0

License requirements: None.

Parameters

pcLibTypeNeuNames Array of neutral names of valid parameter library types

Returns: created NXOpen.ParamLibLibraryManagerBuilder

unsafe void NXOpen.ParamLibParameterCollection.DeleteParametersFromLibrary	(	string[]	pParamNames,
		string	pcLibName
	)

inline

Deletes the parameters from a parameter library file.

Write access is needed for this operation.

Created in NX1847.0.0

License requirements: None.

Parameters

pParamNames	Arrays of identifiers of the parameters to be deleted from the library
pcLibName	Library to modify

override int NXOpen.ParamLibParameterCollection.EnumerateMoveNext	(	ref Tag	currentTag,
		byte[]	state
	)

inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe void NXOpen.ParamLibParameterCollection.ExportParametersToLibrary	(	string[]	pcParamNames,
		string[]	pcLibNames,
		string	pcExportedLibName,
		bool[]	bUpdateLibraryReference
	)

inline

Writes out parameters to a parameter library file.

These parameters can be local parameter definitions or parameter definitions from other parameter libraries. The combination of the parameter name and library name identify a parameter definition. If the parameter definition is for a local parameter, the name is specified and the library name is specified as "". Write access is needed for the Exported library. If the bUpdateLibraryReferences is set to true, the NX model is updated to reflect the exported library as the library the parameter is now referenced in. Each parameter can have its own bUpdateLibraryReferences in this version of the JA call.

Created in NX1847.0.0

License requirements: None.

Parameters

pcParamNames	Array of identifiers of the parameters to be exported
pcLibNames	Array of library names corresponding to the parameter names
pcExportedLibName	The library to write the parameter definitions to
bUpdateLibraryReference	true indicates that the library reference of loaded/local parameters should now refer to the exported library, false indicates the library reference should remain unchanged

unsafe void NXOpen.ParamLibParameterCollection.ExportParametersToLibrary	(	string[]	pcParamNames,
		string[]	pcLibNames,
		string	pcExportedLibName,
		bool	bUpdateLibraryReference
	)

inline

Writes out parameters to a parameter library file.

These parameters can be local parameter definitions or parameter definitions from other parameter libraries. The combination of the parameter name and library name identify a parameter definition. If the parameter definition is for a local parameter, the name is specified and the library name is specified as "". Write access is needed for the Exported library. If the bUpdateLibraryReferences is set to true, the NX model is updated to reflect the exported library as the library the parameter is now referenced in.

Created in NX1847.0.0

License requirements: None.

Parameters

pcParamNames	Array of identifiers of the parameters to be exported
pcLibNames	Array of library names corresponding to the parameter names
pcExportedLibName	The library to write the parameter definitions to
bUpdateLibraryReference	true indicates that the library reference of loaded/local parameters should now refer to the exported library, false indicates the library reference should remain unchanged

unsafe NXOpen.ParamLibParameter NXOpen.ParamLibParameterCollection.FindObject ( string journalIdentifier )

inline

Finds the NXOpen.ParamLibParameter with the given identifier as recorded in a journal.

An exception will be thrown if no object can be found with the given journal identifier.

Created in NX1847.0.0

License requirements: None.

Parameters

journalIdentifier Identifier to be found

Returns: parameter found

unsafe NXOpen.ParamLibParameter NXOpen.ParamLibParameterCollection.GetLoadedLibraryParameter	(	string	pcLibName,
		string	pcParamName
	)

inline

Checks if a library parameter is loaded into a part file or not.

If it is, the loaded parameter is returned.

Created in NX1847.0.0

License requirements: None.

Parameters

pcLibName	the fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
pcParamName	the parameter name

Returns: the loaded parameter

unsafe NXOpen.ParamLibParameter [] NXOpen.ParamLibParameterCollection.GetUsedParameters ( )

inline

Returns the parameters used in the part.

Created in NX1847.0.0

License requirements: None.

Returns: Parameters used

unsafe void NXOpen.ParamLibParameterCollection.InfoLibraryParameter	(	string	pcLibAr,
		string	pcParamNameAr
	)

inline

Displays the property values for the specified library parameter in the information window.

Created in NX1847.0.0

License requirements: None.

Parameters

pcLibAr	the library name
pcParamNameAr	the parameter name

unsafe void NXOpen.ParamLibParameterCollection.InfoLibraryParameterToFile	(	string	pcLibAr,
		string	pcParamNameAr,
		bool	bOverride,
		string	pcFileName
	)

inline

Writes the property values for the specified library parameter to a file.

Created in NX1847.0.0

License requirements: None.

Parameters

pcLibAr	the library name
pcParamNameAr	the parameter name
bOverride	if the file already exists, true override the file, false append to the file
pcFileName	the full path including filename of file where the information should be written

unsafe NXOpen.ParamLibParameter NXOpen.ParamLibParameterCollection.LoadFromNxparampllibrary ( string parameterName )

inline

Creates a non-editable parameter in the part from a NX parameter library parameter definition.

Created in NX1847.0.0

License requirements: None.

Parameters

parameterName the unique parameter name from within this Library

Returns: the loaded parameter

unsafe NXOpen.ParamLibParameter NXOpen.ParamLibParameterCollection.LoadFromParamplLibrary	(	string	libraryName,
		string	parameterName
	)

inline

Creates a non-editable parameter in the part from a parameter library file definition.

The parameter is identified by the library name and the unique parameter name. If the library name is not fully qualified, it will attempt to find a parameter library with this name in the current directory, followed by the specified customer defaults values for the user and site parameter libraries. If the customer defaults are using the file format, it will look in the directory where the specified file is located.

Created in NX1847.0.0

License requirements: None.

Parameters

libraryName	the fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
parameterName	the parameter name

Returns: the loaded parameter

unsafe void NXOpen.ParamLibParameterCollection.OutputParametersToLibrary	(	string[]	pcParamNames,
		string[]	pcLibNames,
		string	pcExportedLibName
	)

inline

Writes out parameters to a parameter library file.

These parameters can be local parameter definitions or parameter definitions from other parameter libraries. The combination of the parameter name and library name identify a parameter definition. If the parameter definition is for a local parameter, the name is specified and the library name is specified as "". Write access is needed for the Exported library.

Created in NX1847.0.0

License requirements: None.

Parameters

pcParamNames	Array of identifiers of the parameters to be exported
pcLibNames	Array of library names corresponding to the parameter names
pcExportedLibName	The library to write the parameter definitions to

NXOpen.ParamLibParameter [] NXOpen.ParamLibParameterCollection.ToArray ( )

inline

Returns an array of NXOpen.ParamLibParameter objects.

unsafe void NXOpen.ParamLibParameterCollection.UpdateParametersInLibrary	(	NXOpen.ParamLibParameter[]	tEditedParam,
		string[]	pParamNames,
		string	pcLibName
	)

inline

Updates the parameters in a parameter library file.

Write access is needed for this operation.

Created in NX1847.0.0

License requirements: None.

Parameters

tEditedParam	Array of loaded parameter tags
pParamNames	Array of the parameter names which match the name in the library that should take the properties of the corresponding parameter (tEditedParam)
pcLibName	Library to modify

Property Documentation

Tag NXOpen.ParamLibParameterCollection.Tag

get

Returns the tag of this object.

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

ParamLibParameterCollection.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation