`OptionsProperty`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.AdditionalProperties.OptionsProperty#

Provides a way to create properties that show up as a drop down in the UI.

Overview#

Properties

`DisplayName`	The name of the property shown in the UI. If not set, the Name property is used.
`GroupName`	The group name of the property shown in the UI, and used to separate properties based on group name.
`Name`	The name of the property.
`Options`	Options shown in the drop-down, represented by a dictionary of int -> string.
`ReadOnly`	Returns whether a property is readonly.
`Tooltip`	The tooltip of the property in the UI.
`Value`	The stored value of the property.
`ValueString`	Get the string representation of the value.

property OptionsProperty.DisplayName: str | None#: The name of the property shown in the UI. If not set, the Name property is used.

property OptionsProperty.GroupName: str | None#: The group name of the property shown in the UI, and used to separate properties based on group name.

property OptionsProperty.Options: dict[Any, Any] | None#: Options shown in the drop-down, represented by a dictionary of int -> string. Where the int represents the option, and string represents string shown in the UI. When an option is selected the Value property of the property is set to to the option int.

property OptionsProperty.ReadOnly: bool | None#: Returns whether a property is readonly.

property OptionsProperty.Tooltip: str | None#: The tooltip of the property in the UI.

property OptionsProperty.Value: Any | None#: The stored value of the property.

property OptionsProperty.ValueString: str | None#: Get the string representation of the value.