DraftingStandardChangeList Class¶

class NXOpen.Options.DraftingStandardChangeList¶

Bases: NXOpen.TransientObject

Records changes to option values at the specified level.

A DraftingStandardChangeList is created with a given level, and all of the edit operations apply to that level for drafting standard defaults. 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.NewOptionsDraftingStandardChangeList() to create a new instance of this class

New in version NX5.0.0.

Properties¶

Property	Description
CurrentLevel	Returns the current level of options

Methods¶

Method	Description
Dispose	Dispose the changes
Load	Load the drafting standard defaults at the current level.
LockValue	Lock option value.
Save	Saves the drafting standard defaults at the current level.
SetUserComment	Sets the user comment.
SetUtf8Value	Sets the value of a :py:class:` OptionsOptionType.Utf8string < OptionsOptionType>` option.
SetValue	Sets the value of an :py:class:` OptionsOptionType.Int < OptionsOptionType>` option.
SetValueOrder	Sets the value of a :py:class:` OptionsOptionType.ReorderSelList < OptionsOptionType>` option for which the list entries can be reordered.
SetValueSelection	Sets the value of a :py:class:` OptionsOptionType.ReorderSelList < OptionsOptionType>` option for which the list entries can be reordered as well as selected.
UnlockValue	Unlock option value.

Property Detail¶

CurrentLevel¶

DraftingStandardChangeList.CurrentLevel¶

Returns the current level of options

-------------------------------------

Getter Method

Signature CurrentLevel

Returns:
Return type:	`NXOpen.Options.LevelType`

New in version NX5.0.0.

License requirements: None.

Method Detail¶

Dispose¶

DraftingStandardChangeList.Dispose¶

Dispose the changes

Signature Dispose()

New in version NX5.0.0.

License requirements: None.

Load¶

DraftingStandardChangeList.Load¶

Load the drafting standard defaults at the current level.

Signature Load()

New in version NX5.0.0.

License requirements: None.

LockValue¶

DraftingStandardChangeList.LockValue¶

Lock option value.

Signature LockValue(name)

Parameters:	name (str) – Option name

New in version NX5.0.0.

License requirements: None.

Save¶

DraftingStandardChangeList.Save¶

Saves the drafting standard defaults at the current level.

Signature Save()

New in version NX5.0.0.

License requirements: None.

SetUserComment¶

DraftingStandardChangeList.SetUserComment¶

Sets the user comment.

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

Signature SetUserComment(name, comment)

Parameters:	name (str) – Option name. comment (str) – User comment text.

New in version NX5.0.0.

License requirements: None.

SetUtf8Value¶

DraftingStandardChangeList.SetUtf8Value¶

Sets the value of a :py:class:` OptionsOptionType.Utf8string < OptionsOptionType>` option.

Throws an error if the option type is not :py:class:` OptionsOptionType.Utf8string < OptionsOptionType>`.

Signature SetUtf8Value(name, value)

Parameters:	name (str) – Option name. value (str) – Option value

New in version NX6.0.0.

License requirements: None.

SetValue¶

DraftingStandardChangeList.SetValue¶

Overloaded method SetValue

SetValue(name, value)
SetValue(name, value)
SetValue(name, value)
SetValue(name, value)
SetValue(name, value)

-------------------------------------

Sets the value of an :py:class:` OptionsOptionType.Int < OptionsOptionType>` option. If the option is of type :py:class:` OptionsOptionType.Real < OptionsOptionType>` then the value parameter is converted to double. Throws an error if the option type is not :py:class:` OptionsOptionType.Int < OptionsOptionType>` or :py:class:` OptionsOptionType.Real < OptionsOptionType>`.