ChangeList Class — NXOpen Python API Reference 12.0.0 documentation

# ChangeList Class

class `NXOpen.Options.``ChangeList`

  Bases: `NXOpen.TransientObject`

  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

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
CurrentLevel | Returns the current level of options
LockedByDefault | Returns the default lock status for the options level.

# Methods

Method | Description
--- | ---
DeleteValue | Delete an option value.
Dispose |
LockValue | Lock option value.
Save | Saves options values 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

`ChangeList.``CurrentLevel`

  Returns the current level of options

  `-------------------------------------`

  Getter Method

  Signature `CurrentLevel`

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

  New in version NX4.0.0.

  License requirements: None.

## LockedByDefault

`ChangeList.``LockedByDefault`

  Returns the default lock status for the options level.

  Valid only for :py:class:` OptionsLevelType.Site < OptionsLevelType>` and :py:class:` OptionsLevelType.Group < OptionsLevelType>`.

  `-------------------------------------`

  Getter Method

  Signature `LockedByDefault`

  Returns: |
  Return type: | `NXOpen.Options.LevelLockedByDefault`

  New in version NX4.0.0.

  License requirements: None.

# Method Detail

## DeleteValue

`ChangeList.``DeleteValue`

  Delete an option value.

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

  Signature `DeleteValue(name)`

  Parameters: | name (str) – Option name.

  New in version NX4.0.0.

  License requirements: None.

## Dispose

`ChangeList.``Dispose`

  Signature `Dispose()`

  New in version NX4.0.0.

  License requirements: None.

## LockValue

`ChangeList.``LockValue`

  Lock option value.

  Signature `LockValue(name)`

  Parameters: | name (str) – Option name

  New in version NX4.0.0.

  License requirements: None.

## Save

`ChangeList.``Save`

  Saves options values at the current level.

  Signature `Save()`

  New in version NX4.0.0.

  License requirements: None.

## SetUserComment

`ChangeList.``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 NX4.0.0.

  License requirements: None.

## SetUtf8Value

`ChangeList.``SetUtf8Value`

  Overloaded method SetUtf8Value

  - `SetUtf8Value(name, value)`
  - `SetUtf8Value(name, value)`

  `-------------------------------------`

  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.

  `-------------------------------------`

  Sets the value of a :py:class:` OptionsOptionType.Utf8stringList < OptionsOptionType>` option. Throws an error if the option type is not :py:class:` OptionsOptionType.Utf8stringList < OptionsOptionType>`.

  Signature `SetUtf8Value(name, value)`

  Parameters:

  - name (str) – Option name.
  - value (list of str) – Option value

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

## SetValue

`ChangeList.``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>`.

  Signature `SetValue(name, value)`

  Parameters:

  - name (str) – Option name.
  - value (int) – Option value.

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Sets the value of a :py:class:` OptionsOptionType.Real < OptionsOptionType>` option. Throws an error if the option type is not :py:class:` OptionsOptionType.Real < OptionsOptionType>`.

  Signature `SetValue(name, value)`

  Parameters:

  - name (str) – Option name.
  - value (float) – Option value.

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Sets the value of a :py:class:` OptionsOptionType.String < OptionsOptionType>` option. Throws an error if the option type is not :py:class:` OptionsOptionType.String < OptionsOptionType>`.

  Signature `SetValue(name, value)`

  Parameters:

  - name (str) – Option name.
  - value (str) – Option value

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Sets the value of a :py:class:` OptionsOptionType.StringList < OptionsOptionType>` option. Throws an error if the option type is not :py:class:` OptionsOptionType.StringList < OptionsOptionType>`.

  Signature `SetValue(name, value)`

  Parameters:

  - name (str) – Option name.
  - value (list of str) –

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Sets the value of a :py:class:` OptionsOptionType.Logical < OptionsOptionType>` option. Throws an error if the option type is not :py:class:` OptionsOptionType.Logical < OptionsOptionType>`.

  Signature `SetValue(name, value)`

  Parameters:

  - name (str) – Option name.
  - value (bool) – Option value

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

## SetValueOrder

`ChangeList.``SetValueOrder`

  Sets the value of a :py:class:` OptionsOptionType.ReorderSelList < OptionsOptionType>` option for which the list entries can be reordered.

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

  Signature `SetValueOrder(name, value)`

  Parameters:

  - name (str) – Option name.
  - value (list of str) –

  New in version NX7.5.0.

  License requirements: None.

## SetValueSelection

`ChangeList.``SetValueSelection`

  Sets the value of a :py:class:` OptionsOptionType.ReorderSelList < OptionsOptionType>` option for which the list entries can be reordered as well as selected.

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

  Signature `SetValueSelection(name, selection, value)`

  Parameters:

  - name (str) – Option name.
  - selection (list of bool) – the selection bit
  - value (list of str) –

  New in version NX7.5.0.

  License requirements: None.

## UnlockValue

`ChangeList.``UnlockValue`

  Unlock option value.

  Signature `UnlockValue(name)`

  Parameters: | name (str) – Option name

  New in version NX4.0.0.

  License requirements: None.