Records changes to option values at the specified level. More...

Inheritance diagram for NXOpen.Options.ChangeList:

Public Member Functions
unsafe void	DeleteValue (string name)
	Delete an option value. More...

unsafe void	LockValue (string name)
	Lock option value. More...

unsafe void	Save ()
	Saves options values at the current level. More...

unsafe void	SetUserComment (string name, string comment)
	Sets the user comment. More...

unsafe void	SetUtf8Value (string name, string value)
	Sets the value of a Options.OptionType.Utf8string option. More...

unsafe void	SetUtf8Value (string name, string[] value)
	Sets the value of a Options.OptionType.Utf8stringList option. More...

unsafe void	SetValue (string name, int value)
	Sets the value of an Options.OptionType.Int option. More...

unsafe void	SetValue (string name, double value)
	Sets the value of a Options.OptionType.Real option. More...

unsafe void	SetValue (string name, string value)
	Sets the value of a Options.OptionType.String option. More...

unsafe void	SetValue (string name, string[] value)
	Sets the value of a Options.OptionType.StringList option. More...

unsafe void	SetValue (string name, bool value)
	Sets the value of a Options.OptionType.Logical option. More...

unsafe void	SetValueOrder (string name, string[] value)
	Sets the value of a Options.OptionType.ReorderSelList option for which the list entries can be reordered. More...

unsafe void	SetValueSelection (string name, bool[] selection, string[] value)
	Sets the value of a Options.OptionType.ReorderSelList option for which the list entries can be reordered as well as selected. More...

unsafe void	UnlockValue (string name)
	Unlock option value. 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 ()
	More...

Properties
unsafe NXOpen.Options.LevelType	CurrentLevel `[get]`
	Returns the current level of options More...

unsafe NXOpen.Options.LevelLockedByDefault	LockedByDefault `[get]`
	Returns the default lock status for the options level. 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

Records changes to option values at the specified level.

A ChangeList is created with a given level, and all of the edit operations apply to that level. Each method for setting a value throws an error if the option value is locked at a higher level, or the specified value is not valid.

All methods in this class use an option name as a unique identifier for accessing individual options and throw an error if an option with the given name is not found. All existing option names and their allowed values are described in the Online Documentation.

Use Options.OptionsManager.NewOptionsChangeList to create a new instance of this class

Created in NX4.0.0

Member Function Documentation

unsafe void NXOpen.Options.ChangeList.DeleteValue ( string name )

inline

Delete an option value.

Throws an error if the value does not exist at this level.

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.

override void NXOpen.Options.ChangeList.FreeResource ( )

inlineprotectedvirtual

Created in NX4.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe void NXOpen.Options.ChangeList.LockValue ( string name )

inline

Lock option value.

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name

unsafe void NXOpen.Options.ChangeList.Save ( )

inline

Saves options values at the current level.

Created in NX4.0.0

License requirements: None.

unsafe void NXOpen.Options.ChangeList.SetUserComment	(	string	name,
		string	comment
	)

inline

Sets the user comment.

Throws an error if the value does not exist at this level.

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
comment	User comment text.

unsafe void NXOpen.Options.ChangeList.SetUtf8Value	(	string	name,
		string	value
	)

inline

Sets the value of a Options.OptionType.Utf8string option.

Throws an error if the option type is not Options.OptionType.Utf8string .

Created in NX6.0.0

License requirements: None.

Parameters

name	Option name.
value	Option value

unsafe void NXOpen.Options.ChangeList.SetUtf8Value	(	string	name,
		string[]	value
	)

inline

Sets the value of a Options.OptionType.Utf8stringList option.

Throws an error if the option type is not Options.OptionType.Utf8stringList .

Created in NX6.0.0

License requirements: None.

Parameters

name	Option name.
value	Option value

unsafe void NXOpen.Options.ChangeList.SetValue	(	string	name,
		int	value
	)

inline

Sets the value of an Options.OptionType.Int option.

If the option is of type Options.OptionType.Real then the value parameter is converted to double. Throws an error if the option type is not Options.OptionType.Int or Options.OptionType.Real .

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
value	Option value.

unsafe void NXOpen.Options.ChangeList.SetValue	(	string	name,
		double	value
	)

inline

Sets the value of a Options.OptionType.Real option.

Throws an error if the option type is not Options.OptionType.Real .

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
value	Option value.

unsafe void NXOpen.Options.ChangeList.SetValue	(	string	name,
		string	value
	)

inline

Sets the value of a Options.OptionType.String option.

Throws an error if the option type is not Options.OptionType.String .

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
value	Option value

unsafe void NXOpen.Options.ChangeList.SetValue	(	string	name,
		string[]	value
	)

inline

Sets the value of a Options.OptionType.StringList option.

Throws an error if the option type is not Options.OptionType.StringList .

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
value

unsafe void NXOpen.Options.ChangeList.SetValue	(	string	name,
		bool	value
	)

inline

Sets the value of a Options.OptionType.Logical option.

Throws an error if the option type is not Options.OptionType.Logical .

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
value	Option value

unsafe void NXOpen.Options.ChangeList.SetValueOrder	(	string	name,
		string[]	value
	)

inline

Sets the value of a Options.OptionType.ReorderSelList option for which the list entries can be reordered.

Throws an error if the option type is not Options.OptionType.ReorderSelList .

Created in NX7.5.0

License requirements: None.

Parameters

name	Option name.
value

unsafe void NXOpen.Options.ChangeList.SetValueSelection	(	string	name,
		bool[]	selection,
		string[]	value
	)

inline

Sets the value of a Options.OptionType.ReorderSelList option for which the list entries can be reordered as well as selected.

Throws an error if the option type is not Options.OptionType.ReorderSelList .

Created in NX7.5.0

License requirements: None.

Parameters

name	Option name.
selection	the selection bit
value

unsafe void NXOpen.Options.ChangeList.UnlockValue ( string name )

inline

Unlock option value.

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name

Property Documentation

unsafe NXOpen.Options.LevelType NXOpen.Options.ChangeList.CurrentLevel

get

Returns the current level of options

Created in NX4.0.0

License requirements: None.

unsafe NXOpen.Options.LevelLockedByDefault NXOpen.Options.ChangeList.LockedByDefault

get

Returns the default lock status for the options level.

Valid only for Options.LevelType.Site and Options.LevelType.Group .

Created in NX4.0.0

License requirements: None.

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

Options_ChangeList.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation