SelectionBox Class¶
-
class
NXOpen.UIStyler.SelectionBox¶ Bases:
NXOpen.UIStyler.StylerItemRepresents a SelectionBox for UI Styler
New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| Sensitivity | Returns or sets the sensitivity of the selection box |
| Visibility | Returns or sets the visibility of the selection box |
Methods¶
| Method | Description |
|---|---|
| AddActivateHandler | Registers activate callback. |
| AddDoubleClickHandler | Registers double click callback. |
| Append | Appends one or more entries to be inserted into the list |
| DeleteSubItem | Deletes sub item |
| DeselectSubItem | Requests a list entry to be deselected. |
| Dispose | Free resources associated with the instance. |
| GetItemType | Gets the dialog item type. |
| GetListItems | Gets an array of character strings for item names that are used as selectable choices for this dialog item. |
| GetSelectedIndexValue | Gets selected index value |
| GetSelectedString | Gets selected string |
| InitializeAttachment | Returns initialized dialog item attachment information |
| InsertSubItem | Requests that one or more entries be inserted into the list. |
| IsEqualTo | Equates two styler items |
| SetAttachment | Specifies the updated dialog item attachment information |
| SetFocus | Indicates that this dialog item is receiving keyboard focus. |
| SetLabel | Specifies the descriptive text string to display below the scrolled list and above the text field. |
| SetListItems | Specifies an array of character strings for item names that are used as selectable choices for this dialog item. |
| SetValue | Sets the value |
| ShowSubItem | Requests that a list entry be scrolled up to the first line in the list. |
Property Detail¶
Sensitivity¶
-
SelectionBox.Sensitivity¶ Returns or sets the sensitivity of the selection box
-------------------------------------Getter Method
Signature
SensitivityReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SensitivityParameters: type (bool) – New in version NX5.0.0.
License requirements: None.
Visibility¶
-
SelectionBox.Visibility¶ Returns or sets the visibility of the selection box
-------------------------------------Getter Method
Signature
VisibilityReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
VisibilityParameters: type (bool) – New in version NX5.0.0.
License requirements: None.
Method Detail¶
AddActivateHandler¶
-
SelectionBox.AddActivateHandler¶ Registers activate callback.
This method should be called before calling
UIStyler.Dialog.Show()orUIStyler.Dialog.RegisterWithUiMenu()Signature
AddActivateHandler(activateevent, isDialogLaunchingEvent)Parameters: - activateevent (CallableObject) – Activate event
- isDialogLaunchingEvent (bool) – TRUE if launch new dialog, FALSE if not
New in version NX5.0.0.
License requirements: None.
AddDoubleClickHandler¶
-
SelectionBox.AddDoubleClickHandler¶ Registers double click callback.
This method should be called before calling
UIStyler.Dialog.Show()orUIStyler.Dialog.RegisterWithUiMenu()Signature
AddDoubleClickHandler(doubleclickevent, isDialogLaunchingEvent)Parameters: - doubleclickevent (CallableObject) – Double click event
- isDialogLaunchingEvent (bool) – TRUE if launch new dialog, FALSE if not
New in version NX5.0.0.
License requirements: None.
Append¶
-
SelectionBox.Append¶ Appends one or more entries to be inserted into the list
Signature
Append(multiEntries)Parameters: multiEntries (list of str) – An array of entry names to be inserted into the list. This field is used only when more than one entry are to be inserted into the list. New in version NX5.0.0.
License requirements: None.
DeleteSubItem¶
-
SelectionBox.DeleteSubItem¶ Deletes sub item
Signature
DeleteSubItem(subItemIndex)Parameters: subItemIndex (int) – New in version NX5.0.0.
License requirements: None.
DeselectSubItem¶
-
SelectionBox.DeselectSubItem¶ Requests a list entry to be deselected.
Signature
DeselectSubItem(subItemIndex)Parameters: subItemIndex (int) – New in version NX5.0.0.
License requirements: None.
GetListItems¶
-
SelectionBox.GetListItems¶ Gets an array of character strings for item names that are used as selectable choices for this dialog item.
Signature
GetListItems()Returns: List of items Return type: list of str New in version NX5.0.0.
License requirements: None.
GetSelectedIndexValue¶
-
SelectionBox.GetSelectedIndexValue¶ Gets selected index value
Signature
GetSelectedIndexValue()Returns: Return type: int New in version NX5.0.0.
License requirements: None.
GetSelectedString¶
-
SelectionBox.GetSelectedString¶ Gets selected string
Signature
GetSelectedString()Returns: Return type: str New in version NX5.0.0.
License requirements: None.
InsertSubItem¶
-
SelectionBox.InsertSubItem¶ Requests that one or more entries be inserted into the list.
You can insert entries at the bottom of the list or at any position within the list.
Signature
InsertSubItem(subitemIndex, multiEntries)Parameters: - subitemIndex (int) – Position index where the insertion should be made. If subitem_index equals UF_STYLER_NO_SUB_INDEX, then the new list entries are added to the bottom of the list.
- multiEntries (list of str) –
New in version NX5.0.0.
License requirements: None.
SetFocus¶
-
SelectionBox.SetFocus¶ Indicates that this dialog item is receiving keyboard focus.
Signature
SetFocus()New in version NX5.0.0.
License requirements: None.
SetLabel¶
-
SelectionBox.SetLabel¶ Specifies the descriptive text string to display below the scrolled list and above the text field.
It describes the dialog item’s usage.
Signature
SetLabel(strLabel)Parameters: strLabel (str) – Label string New in version NX5.0.0.
License requirements: None.
SetListItems¶
-
SelectionBox.SetListItems¶ Specifies an array of character strings for item names that are used as selectable choices for this dialog item.
Signature
SetListItems(values)Parameters: values (list of str) – List of items New in version NX5.0.0.
License requirements: None.