MultiSelectList Class¶
-
class
NXOpen.UIStyler.
MultiSelectList
¶ Bases:
NXOpen.UIStyler.StylerItem
Represents a MultiSelectList for UI Styler
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
Sensitivity | Returns or sets the senstivity |
Visibility | Returns or sets the visibility |
Methods¶
Method | Description |
---|---|
AddActivateHandler | Called when a dialog user selects an entry with a double mouse click or presses Return on a selected item. |
AddDoubleClickHandler | Registers double click callback. |
Append | Appends one or more entries to be inserted into the list |
DeleteSubitem | Deletes sub item |
Deselect | Requests a list entry to be deselected. |
Dispose | Free resources associated with the instance. |
Focus | Indicates that this dialog item is receiving keyboard focus. |
GetAllIndicesSelected | Gets the indices of all selected list entries. |
GetAllNameSelected | Gets the names of all selected list entries. |
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. |
InitializeAttachment | Returns initialized dialog item attachment information @return attachment object |
InsertSubitems | |
IsEqualTo | Equates two styler items @return |
SetAllSelected | Specifies all list entry to be selected. |
SetAttachment | Specifies the updated dialog item attachment information |
SetListItems | Specifies an array of character strings for item names that are used as selectable choices for this dialog item. |
SetSelected | Specifies particular list items to be selected. |
ShowSubItem | Requests a list entry to be scrolled up to the first line in the list |
Property Detail¶
Sensitivity¶
-
MultiSelectList.
Sensitivity
¶ Returns or sets the senstivity
-------------------------------------
Getter Method
Signature
Sensitivity()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Sensitivity(type)
Parameters: type (bool) – New in version NX5.0.0.
License requirements: None.
Visibility¶
-
MultiSelectList.
Visibility
¶ Returns or sets the visibility
-------------------------------------
Getter Method
Signature
Visibility()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Visibility(type)
Parameters: type (bool) – New in version NX5.0.0.
License requirements: None.
Method Detail¶
AddActivateHandler¶
-
MultiSelectList.
AddActivateHandler
¶ Called when a dialog user selects an entry with a double mouse click or presses Return on a selected item.
Signature
AddActivateHandler(activateevent, isDialogLaunchingEvent)
Parameters: - activateevent (CallableObject) –
- isDialogLaunchingEvent (bool) –
New in version NX5.0.0.
License requirements: None.
AddDoubleClickHandler¶
-
MultiSelectList.
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) –
- isDialogLaunchingEvent (bool) –
New in version NX5.0.0.
License requirements: None.
Append¶
-
MultiSelectList.
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. NOTE: The full Unicode character set is not supported for this parameter. New in version NX5.0.0.
License requirements: None.
DeleteSubitem¶
-
MultiSelectList.
DeleteSubitem
¶ Deletes sub item
Signature
DeleteSubitem(subItemIndex)
Parameters: subItemIndex (int) – Zero-based index of a list entry to be deleted New in version NX5.0.0.
License requirements: None.
Deselect¶
-
MultiSelectList.
Deselect
¶ Requests a list entry to be deselected.
Signature
Deselect(subItemIndex)
Parameters: subItemIndex (int) – Index of the list entry to be deselected. New in version NX5.0.0.
License requirements: None.
Focus¶
-
MultiSelectList.
Focus
¶ Indicates that this dialog item is receiving keyboard focus.
Signature
Focus()
New in version NX5.0.0.
License requirements: None.
GetAllIndicesSelected¶
-
MultiSelectList.
GetAllIndicesSelected
¶ Gets the indices of all selected list entries.
Signature
GetAllIndicesSelected()
Returns: An array of integers for item indices of selected items Return type: list of int New in version NX5.0.0.
License requirements: None.
GetAllNameSelected¶
-
MultiSelectList.
GetAllNameSelected
¶ Gets the names of all selected list entries.
Signature
GetAllNameSelected()
Returns: An array of character strings of selected items Return type: list of str New in version NX5.0.0.
License requirements: None.
GetListItems¶
-
MultiSelectList.
GetListItems
¶ Gets an array of character strings for item names that are used as selectable choices for this dialog item.
Signature
GetListItems()
Returns: An array of character strings for item names Return type: list of str New in version NX5.0.0.
License requirements: None.
InsertSubitems¶
-
MultiSelectList.
InsertSubitems
¶ Signature
InsertSubitems(subitemIndex, multiEntries)
Parameters: - subitemIndex (int) – Sub item index
- multiEntries (list of str) – An array of items to be inserted NOTE: The full Unicode character set is not supported for this parameter.
New in version NX5.0.0.
License requirements: None.
SetAllSelected¶
-
MultiSelectList.
SetAllSelected
¶ Specifies all list entry to be selected.
Signature
SetAllSelected()
New in version NX5.0.0.
License requirements: None.
SetListItems¶
-
MultiSelectList.
SetListItems
¶ Specifies an array of character strings for item names that are used as selectable choices for this dialog item.
Signature
SetListItems(itemVal)
Parameters: itemVal (list of str) – array of character strings for item names NOTE: The full Unicode character set is not supported for this parameter. New in version NX5.0.0.
License requirements: None.
SetSelected¶
-
MultiSelectList.
SetSelected
¶ Specifies particular list items to be selected.
Signature
SetSelected(subIndex)
Parameters: subIndex (int) – An index of particular list items to be selected New in version NX5.0.0.
License requirements: None.
ShowSubItem¶
-
MultiSelectList.
ShowSubItem
¶ Requests a list entry to be scrolled up to the first line in the list
Signature
ShowSubItem(subItemIndex)
Parameters: subItemIndex (int) – Zero-based index of a list entry to be scrolled up to the first line of the list. New in version NX5.0.0.
License requirements: None.