Manages options. More...

Inheritance diagram for NXOpen.Options.OptionsManager:

Public Member Functions
unsafe string[]	GetAllOptions ()
	Gets the names of all available options. More...

unsafe int	GetIntValue (string name)
	Gets the value of an Options.OptionType.Int option. More...

unsafe int	GetIntValue (string name, NXOpen.Options.LevelType level)
	Gets the value of an Options.OptionType.Int option at the specified level. More...

unsafe bool	GetLogicalValue (string name)
	Gets the value of a Options.OptionType.Logical option. More...

unsafe bool	GetLogicalValue (string name, NXOpen.Options.LevelType level)
	Gets the value of a Options.OptionType.Logical option at the specified level. More...

unsafe NXOpen.Options.OptionType	GetOptionType (string name)
	Returns an option's type. More...

unsafe double	GetRealValue (string name)
	Gets the value of a Options.OptionType.Real option. More...

unsafe double	GetRealValue (string name, NXOpen.Options.LevelType level)
	Gets the value of a Options.OptionType.Real option at the specified level. More...

unsafe string[]	GetReorderSelectableStringListValue (string name, out bool[] selection)
	Gets the value of a Options.OptionType.ReorderSelList option. More...

unsafe string[]	GetReorderSelectableStringListValue (string name, NXOpen.Options.LevelType level, out bool[] selection)
	Gets the value of a Options.OptionType.ReorderSelList option at the specified level. More...

unsafe NXOpen.Options.OptionsScope	GetScope (string name)
	Returns scope of an option. More...

unsafe string[]	GetStringListValue (string name)
	Gets the value of a Options.OptionType.StringList option. More...

unsafe string[]	GetStringListValue (string name, NXOpen.Options.LevelType level)
	Gets the value of a Options.OptionType.StringList option at the specified level. More...

unsafe string	GetStringValue (string name)
	Gets the value of a Options.OptionType.String option. More...

unsafe string	GetStringValue (string name, NXOpen.Options.LevelType level)
	Gets the value of a Options.OptionType.String option at the specified level. More...

unsafe string	GetUserComment (string name, NXOpen.Options.LevelType level)
	Returns then user comment at the specified level. More...

unsafe string	GetUtf8stringValue (string name)
	Gets the value of a Options.OptionType.Utf8string option. More...

unsafe string	GetUtf8stringValue (string name, NXOpen.Options.LevelType level)
	Gets the value of a Options.OptionType.Utf8string option at the specified level. More...

unsafe bool	IsLevelLockedByDefault (NXOpen.Options.LevelType level)
	Returns true if the option's values at the specified level are locked by default. More...

unsafe bool	IsValueLocked (string name, NXOpen.Options.LevelType level)
	Returns true if the option value is locked at the specified level. More...

unsafe bool	IsValueSet (string name, NXOpen.Options.LevelType level)
	Returns true if the option value exists at the specified level. More...

unsafe NXOpen.Options.ChangeList	NewOptionsChangeList (NXOpen.Options.LevelType level, NXOpen.Options.LevelLockedByDefault lockedByDefault)
	Creates an instance of NXOpen.Options.ChangeList class, in order to edit a set of options. More...

unsafe NXOpen.Options.DraftingStandardChangeList	NewOptionsDraftingStandardChangeList (NXOpen.Options.LevelType level, string filename)
	Creates an instance of NXOpen.Options.DraftingStandardChangeList class, in order to edit a set of options. 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
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...

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

Detailed Description

Manages options.

OptionsManager methods use an option name as a unique identifier for accessing individual options and throw an error if an option with a given name is not found. All existing option names are listed in the Online Documentation.

If a level parameter is not supplied to a query method then the option value effective in current session is returned. If a level parameter is supplied then then value that is stored at the specified level is returned. This may not be the same as the value effective in the current session and may take effect only after the session is restarted.

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

Created in NX4.0.0

Member Function Documentation

unsafe string [] NXOpen.Options.OptionsManager.GetAllOptions ( )

inline

Gets the names of all available options.

Created in NX4.0.0

License requirements: None.

Returns: List of names of all available options.

unsafe int NXOpen.Options.OptionsManager.GetIntValue ( string name )

inline

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

Throws an error if option type is not Options.OptionType.Int .

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.

Returns: Option value

unsafe int NXOpen.Options.OptionsManager.GetIntValue	(	string	name,
		NXOpen.Options.LevelType	level
	)

inline

Gets the value of an Options.OptionType.Int option at the specified level.

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

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
level	Options level.

Returns: Option value

unsafe bool NXOpen.Options.OptionsManager.GetLogicalValue ( string name )

inline

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

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

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.

Returns: Option value.

unsafe bool NXOpen.Options.OptionsManager.GetLogicalValue	(	string	name,
		NXOpen.Options.LevelType	level
	)

inline

Gets the value of a Options.OptionType.Logical option at the specified level.

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

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
level	Options level.

Returns: Option value

unsafe NXOpen.Options.OptionType NXOpen.Options.OptionsManager.GetOptionType ( string name )

inline

Returns an option's type.

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name

Returns: Option type

unsafe double NXOpen.Options.OptionsManager.GetRealValue ( string name )

inline

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

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

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.

Returns: Option value.

unsafe double NXOpen.Options.OptionsManager.GetRealValue	(	string	name,
		NXOpen.Options.LevelType	level
	)

inline

Gets the value of a Options.OptionType.Real option at the specified level.

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

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
level	Options level.

Returns: Option value

unsafe string [] NXOpen.Options.OptionsManager.GetReorderSelectableStringListValue	(	string	name,
		out bool[]	selection
	)

inline

Gets the value of a Options.OptionType.ReorderSelList option.

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

Created in NX7.5.0

License requirements: None.

Parameters

name	Option name.
selection	the selection bit

Returns: Option value

unsafe string [] NXOpen.Options.OptionsManager.GetReorderSelectableStringListValue	(	string	name,
		NXOpen.Options.LevelType	level,
		out bool[]	selection
	)

inline

Gets the value of a Options.OptionType.ReorderSelList option at the specified level.

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

Created in NX7.5.0

License requirements: None.

Parameters

name	Option name.
level	Options level.
selection	the selection bit

Returns: Option value

unsafe NXOpen.Options.OptionsScope NXOpen.Options.OptionsManager.GetScope ( string name )

inline

Returns scope of an option.

Created in NX12.0.0

License requirements: None.

Parameters

name	Option name

Returns: Option scope

unsafe string [] NXOpen.Options.OptionsManager.GetStringListValue ( string name )

inline

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

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

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.

Returns: Option value.

unsafe string [] NXOpen.Options.OptionsManager.GetStringListValue	(	string	name,
		NXOpen.Options.LevelType	level
	)

inline

Gets the value of a Options.OptionType.StringList option at the specified level.

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

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
level	Options level.

Returns: Option value

unsafe string NXOpen.Options.OptionsManager.GetStringValue ( string name )

inline

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

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

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.

Returns: Option value.

unsafe string NXOpen.Options.OptionsManager.GetStringValue	(	string	name,
		NXOpen.Options.LevelType	level
	)

inline

Gets the value of a Options.OptionType.String option at the specified level.

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

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name.
level	Options level.

Returns: Option value

unsafe string NXOpen.Options.OptionsManager.GetUserComment	(	string	name,
		NXOpen.Options.LevelType	level
	)

inline

Returns then user comment at the specified level.

User comments are not supported at the Options.LevelType.Shipped level.

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name
level	Options level.

Returns: User comment text.

unsafe string NXOpen.Options.OptionsManager.GetUtf8stringValue ( string name )

inline

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

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

Created in NX6.0.0

License requirements: None.

Parameters

name	Option name.

Returns: Option utf8 value.

unsafe string NXOpen.Options.OptionsManager.GetUtf8stringValue	(	string	name,
		NXOpen.Options.LevelType	level
	)

inline

Gets the value of a Options.OptionType.Utf8string option at the specified level.

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

Created in NX6.0.0

License requirements: None.

Parameters

name	Option name.
level	Options level.

Returns: Option value

unsafe bool NXOpen.Options.OptionsManager.IsLevelLockedByDefault ( NXOpen.Options.LevelType level )

inline

Returns true if the option's values at the specified level are locked by default.

Locked by default means that if an option value does not exist at this level, then it is locked.

Created in NX4.0.0

License requirements: None.

Parameters

level Options level.

Returns: True if options values are locked by default

unsafe bool NXOpen.Options.OptionsManager.IsValueLocked	(	string	name,
		NXOpen.Options.LevelType	level
	)

inline

Returns true if the option value is locked at the specified level.

Locks are not supported at Options.LevelType.User and Options.LevelType.Shipped levels.

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name
level	Options level.

Returns: Lock status

unsafe bool NXOpen.Options.OptionsManager.IsValueSet	(	string	name,
		NXOpen.Options.LevelType	level
	)

inline

Returns true if the option value exists at the specified level.

Always true for the Options.LevelType.Shipped level.

Created in NX4.0.0

License requirements: None.

Parameters

name	Option name
level	Options level.

Returns: True if value is set

unsafe NXOpen.Options.ChangeList NXOpen.Options.OptionsManager.NewOptionsChangeList	(	NXOpen.Options.LevelType	level,
		NXOpen.Options.LevelLockedByDefault	lockedByDefault
	)

inline

Creates an instance of NXOpen.Options.ChangeList class, in order to edit a set of options.

It is not possible to create an instance of NXOpen.Options.ChangeList for Options.LevelType.Shipped level, or for a level that is not defined or is not writeable.

Created in NX4.0.0

License requirements: None.

Parameters

level	Options level.
lockedByDefault	Specifies whether Options level is locked by default. Ignored at Options.LevelType.User level as locks at Options.LevelType.User level are not supported. If specified default lock status is different from the current one, then all exisitng locks are cleared.

Returns: An instanse of NXOpen.Options.ChangeList class

unsafe NXOpen.Options.DraftingStandardChangeList NXOpen.Options.OptionsManager.NewOptionsDraftingStandardChangeList	(	NXOpen.Options.LevelType	level,
		string	filename
	)

inline

Creates an instance of NXOpen.Options.DraftingStandardChangeList class, in order to edit a set of options.

It is not possible to create an instance of NXOpen.Options.DraftingStandardChangeList for Options.LevelType.Shipped level, or for a level that is not defined or is not writeable.

Created in NX5.0.0

License requirements: None.

Parameters

level	Options level.
filename	Specifies the filename to save/save as.

Returns: An instanse of NXOpen.Options.DraftingStandardChangeList class

Property Documentation

Tag NXOpen.Options.OptionsManager.Tag

get

Returns the tag of this object.

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

Options_OptionsManager.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation