Represents a parameter table. More...

Inheritance diagram for NXOpen.ParameterTable:

Public Member Functions
unsafe void	ActivateConfiguration (int configIndex, bool activate)
	Activate a configuration by index More...

unsafe void	ActivateConfiguration (string configurationName, bool activate)
	Activate a configuration by name More...

unsafe int	AddConfiguration (string configurationName)
	Add a new configuration with the specified name More...

unsafe void	AddExpression (string expressionName)
	Add an expression with the specified name More...

unsafe bool	ConfigurationIsActive (int configIndex)
	Returns if the configuration is active. More...

unsafe bool	ConfigurationIsActive (string configurationName)
	Returns if the configuration is active. More...

unsafe void	DeactivateTable ()
	Deactivate active configuration More...

unsafe int	GetActiveConfigurationIndex ()
	Returns the index of the active configuration. More...

unsafe string	GetConfigurationName (int index)
	Get a configuration index by name More...

unsafe string	GetConfigurationValue (string configurationName, string expressionName)
	Get an expression value of a configuration More...

unsafe string	GetExpressionLabel (int index)
	Get the label of the expression in the table More...

unsafe string	GetExpressionName (int index)
	Get the name and label of the expression in the table More...

unsafe int	GetNumberOfConfigurations ()
	Get the number of configurations in the table More...

unsafe int	GetNumberOfExpressions ()
	Get the number of expression in the table More...

unsafe bool	IsExpressionUsedByTable (string expressionName)
	Check if an expression is used by table More...

unsafe void	RemoveConfiguration (string configurationName)
	Remove a configuration with the specified name More...

unsafe void	RemoveExpression (string expressionName)
	Remove an expression with the specified name More...

unsafe void	RemoveReference ()
	Sets table parameters. More...

unsafe void	RemoveTable ()
	Remove the table More...

unsafe void	RenameConfiguration (string oldConfigurationName, string configurationName)
	Rename a configuration with the specified name More...

unsafe void	RenameTable (string tableName)
	Rename the table with the specified name More...

unsafe void	ReplaceExpression (string oldExpressionName, string expressionName)
	Replace an expression with the specified name More...

unsafe void	ReplaceExpressionLabel (string expressionName, string labelName)
	Replace an expression label with the specified name More...

unsafe void	SetConfigurationName (int configIndex, string configurationName)
	Set the name of a configuration More...

unsafe void	SetConfigurationValue (int configIndex, string expressionName, string value)
	Set an expression value into a configuration More...

unsafe void	UpdateFromFile ()
	Update the table from the external referenced file. More...

unsafe void	UpdateModel ()
	Update the model. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

unsafe void	DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

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

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetReferenceAttribute (string title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

unsafe string	GetStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

unsafe string	GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe int	GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

unsafe void	Print ()
	Prints a representation of this object to the system log file. More...

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

unsafe void	SetAttribute (string title, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

unsafe void	SetAttribute (string title, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, string value)
	Creates or modifies a string attribute. More...

unsafe void	SetAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetAttribute (string title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

unsafe void	SetReferenceAttribute (string title, string value)
	Creates or modifies a string attribute which uses a reference string. More...

unsafe void	SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override 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...

Properties
unsafe string	TableName `[get, set]`
	Returns or sets the table name. More...

Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Properties inherited from NXOpen.INXObject
bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

string	Name `[get]`
	Returns the custom name of the object. More...

NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Additional Inherited Members
Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

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

Detailed Description

Represents a parameter table.

To create a new instance of this class, use NXOpen.ParameterTableCollection.Create

Created in NX1899.0.0

Member Function Documentation

unsafe void NXOpen.ParameterTable.ActivateConfiguration	(	int	configIndex,
		bool	activate
	)

inline

Activate a configuration by index

Created in NX1899.0.0

License requirements: None.

Parameters

configIndex	The configuration index
activate	The active status

unsafe void NXOpen.ParameterTable.ActivateConfiguration	(	string	configurationName,
		bool	activate
	)

inline

Activate a configuration by name

Created in NX1899.0.0

License requirements: None.

Parameters

configurationName	The configuration name
activate	The active status

unsafe int NXOpen.ParameterTable.AddConfiguration ( string configurationName )

inline

Add a new configuration with the specified name

Created in NX1899.0.0

License requirements: None.

Parameters

configurationName The name of the configuration. Must be unique into its table

Returns: The index of new added configuration in the table

unsafe void NXOpen.ParameterTable.AddExpression ( string expressionName )

inline

Add an expression with the specified name

Created in NX1899.0.0

License requirements: None.

Parameters

expressionName The name of the expression to add

unsafe bool NXOpen.ParameterTable.ConfigurationIsActive ( int configIndex )

inline

Returns if the configuration is active.

Created in NX1899.0.0

License requirements: None.

Parameters

configIndex The configuration index

Returns: The active status

unsafe bool NXOpen.ParameterTable.ConfigurationIsActive ( string configurationName )

inline

Returns if the configuration is active.

Created in NX1899.0.0

License requirements: None.

Parameters

configurationName The configuration name

Returns: The active status

unsafe void NXOpen.ParameterTable.DeactivateTable ( )

inline

Deactivate active configuration

Created in NX1899.0.0

License requirements: None.

unsafe int NXOpen.ParameterTable.GetActiveConfigurationIndex ( )

inline

Returns the index of the active configuration.

Created in NX1899.0.0

License requirements: None.

Returns: The active configuration index

unsafe string NXOpen.ParameterTable.GetConfigurationName ( int index )

inline

Get a configuration index by name

Created in NX1899.0.0

License requirements: None.

Parameters

index The configuration index

Returns: The configuration name

unsafe string NXOpen.ParameterTable.GetConfigurationValue	(	string	configurationName,
		string	expressionName
	)

inline

Get an expression value of a configuration

Created in NX1899.0.0

License requirements: None.

Parameters

configurationName	The configuration name
expressionName	The name of the expression to get value

Returns: The value

unsafe string NXOpen.ParameterTable.GetExpressionLabel ( int index )

inline

Get the label of the expression in the table

Created in NX1899.0.0

License requirements: None.

Parameters

index The index of the expression

Returns: The expression label

unsafe string NXOpen.ParameterTable.GetExpressionName ( int index )

inline

Get the name and label of the expression in the table

Created in NX1899.0.0

License requirements: None.

Parameters

index The index of the expression

Returns: The expression name

unsafe int NXOpen.ParameterTable.GetNumberOfConfigurations ( )

inline

Get the number of configurations in the table

Created in NX1899.0.0

License requirements: None.

Returns: The number of configurations

unsafe int NXOpen.ParameterTable.GetNumberOfExpressions ( )

inline

Get the number of expression in the table

Created in NX1899.0.0

License requirements: None.

Returns: The number of expressions

unsafe bool NXOpen.ParameterTable.IsExpressionUsedByTable ( string expressionName )

inline

Check if an expression is used by table

Created in NX1899.0.0

License requirements: None.

Parameters

expressionName The name of the expression to check

Returns: If the expression is used by the table or not

unsafe void NXOpen.ParameterTable.RemoveConfiguration ( string configurationName )

inline

Remove a configuration with the specified name

Created in NX1899.0.0

License requirements: None.

Parameters

configurationName The name of the configuration to remove

unsafe void NXOpen.ParameterTable.RemoveExpression ( string expressionName )

inline

Remove an expression with the specified name

Created in NX1899.0.0

License requirements: None.

Parameters

expressionName The name of the expression to remove

unsafe void NXOpen.ParameterTable.RemoveReference ( )

inline

Sets table parameters.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.ParameterTable.RemoveTable ( )

inline

Remove the table

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.ParameterTable.RenameConfiguration	(	string	oldConfigurationName,
		string	configurationName
	)

inline

Rename a configuration with the specified name

Created in NX1899.0.0

License requirements: None.

Parameters

oldConfigurationName	The name of the configuration to rename
configurationName	The new name of the configuration. Must be unique into its table

unsafe void NXOpen.ParameterTable.RenameTable ( string tableName )

inline

Rename the table with the specified name

Created in NX1899.0.0

License requirements: None.

Parameters

tableName The new name of the table. Must be unique

unsafe void NXOpen.ParameterTable.ReplaceExpression	(	string	oldExpressionName,
		string	expressionName
	)

inline

Replace an expression with the specified name

Created in NX1899.0.0

License requirements: None.

Parameters

oldExpressionName	The name of the expression to rename
expressionName	The new name of the expression

unsafe void NXOpen.ParameterTable.ReplaceExpressionLabel	(	string	expressionName,
		string	labelName
	)

inline

Replace an expression label with the specified name

Created in NX1899.0.0

License requirements: None.

Parameters

expressionName	The name of the expression to replace
labelName	The new name of the expression

unsafe void NXOpen.ParameterTable.SetConfigurationName	(	int	configIndex,
		string	configurationName
	)

inline

Set the name of a configuration

Created in NX1899.0.0

License requirements: None.

Parameters

configIndex	The index of the configuration to rename
configurationName	The new name of the configuration. Must be unique into its table

unsafe void NXOpen.ParameterTable.SetConfigurationValue	(	int	configIndex,
		string	expressionName,
		string	value
	)

inline

Set an expression value into a configuration

Created in NX1899.0.0

License requirements: None.

Parameters

configIndex	The configuration index
expressionName	The name of the expression to set value
value	The new value

unsafe void NXOpen.ParameterTable.UpdateFromFile ( )

inline

Update the table from the external referenced file.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.ParameterTable.UpdateModel ( )

inline

Update the model.

Created in NX1899.0.0

License requirements: None.

Property Documentation

unsafe string NXOpen.ParameterTable.TableName

getset

Returns or sets the table name.

Created in NX1899.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:

ParameterTable.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation