Methods¶
Method | Description |
---|---|
AddMenuItem | Adds single menu item |
AddSeparator | Adds a separator |
AddSeperator | Adds a separator |
Dispose | Frees the object from memory. |
GetItemChecked | Gets the checked status for given menu item @return Status |
GetItemDefault | Gets the flag indicating whether the given menu item is default @return Status |
GetItemDialogLaunching | Gets the flag indicating whether the given menu item is dialog lanching @return Status |
GetItemDisable | Gets the flag indicating whether the given menu item is disabled @return Status |
GetItemHidden | Gets the flag indicating whether the given menu item is hidden @return Status |
GetItemIcon | Gets the icon for given menu item @return Display text |
GetItemText | Gets the display text for given menu item @return Display text |
SetItemChecked | Sets the checked status for given menu item |
SetItemDefault | Sets the flag indicating whether the given menu item is default |
SetItemDialogLaunching | Sets the flag indicating whether the given menu item is dialog lanching |
SetItemDisable | Sets the flag indicating whether the given menu item is disabled |
SetItemHidden | Sets the flag indicating whether the given menu item is hidden |
SetItemIcon | Sets the icon for given menu item |
SetItemText | Sets the display text for given menu item |
SetSubMenu | Sets a submenu. |
Method Detail¶
AddSeparator¶
-
TreeListMenu.
AddSeparator
¶ Adds a separator
Signature
AddSeparator()
New in version NX11.0.0.
License requirements: None.
AddSeperator¶
-
TreeListMenu.
AddSeperator
¶ Adds a separator
Signature
AddSeperator()
New in version NX7.5.0.
Deprecated since version NX11.0.0: Use
BlockStyler.TreeListMenu.AddSeparator()
instead.License requirements: None.
Dispose¶
-
TreeListMenu.
Dispose
¶ Frees the object from memory.
After this method is called, it is illegal to use the object.
Signature
Dispose()
New in version NX7.5.0.
License requirements: None.
GetItemChecked¶
-
TreeListMenu.
GetItemChecked
¶ Gets the checked status for given menu item
Signature
GetItemChecked(menuItemID)
Parameters: menuItemID (int) – Menu-item ID Returns: Status Return type: bool New in version NX7.5.0.
License requirements: None.
GetItemDefault¶
-
TreeListMenu.
GetItemDefault
¶ Gets the flag indicating whether the given menu item is default
Signature
GetItemDefault(menuItemID)
Parameters: menuItemID (int) – Menu-item ID Returns: Status Return type: bool New in version NX7.5.0.
License requirements: None.
GetItemDialogLaunching¶
-
TreeListMenu.
GetItemDialogLaunching
¶ Gets the flag indicating whether the given menu item is dialog lanching
Signature
GetItemDialogLaunching(menuItemID)
Parameters: menuItemID (int) – Menu-item ID Returns: Status Return type: bool New in version NX7.5.0.
License requirements: None.
GetItemDisable¶
-
TreeListMenu.
GetItemDisable
¶ Gets the flag indicating whether the given menu item is disabled
Signature
GetItemDisable(menuItemID)
Parameters: menuItemID (int) – Menu-item ID Returns: Status Return type: bool New in version NX7.5.0.
License requirements: None.
GetItemIcon¶
-
TreeListMenu.
GetItemIcon
¶ Gets the icon for given menu item
Signature
GetItemIcon(menuItemID)
Parameters: menuItemID (int) – Menu-item ID Returns: Display text Return type: str New in version NX7.5.0.
License requirements: None.
GetItemText¶
-
TreeListMenu.
GetItemText
¶ Gets the display text for given menu item
Signature
GetItemText(menuItemID)
Parameters: menuItemID (int) – Menu-item ID Returns: Display text Return type: str New in version NX7.5.0.
License requirements: None.
SetItemChecked¶
-
TreeListMenu.
SetItemChecked
¶ Sets the checked status for given menu item
Signature
SetItemChecked(menuItemID, checkedStatusStatus)
Parameters: - menuItemID (int) – Menu-item ID
- checkedStatusStatus (bool) – Status
New in version NX7.5.0.
License requirements: None.
SetItemDefault¶
-
TreeListMenu.
SetItemDefault
¶ Sets the flag indicating whether the given menu item is default
Signature
SetItemDefault(menuItemID, defaultStatus)
Parameters: - menuItemID (int) – Menu-item ID
- defaultStatus (bool) – Status
New in version NX7.5.0.
License requirements: None.
SetItemDialogLaunching¶
-
TreeListMenu.
SetItemDialogLaunching
¶ Sets the flag indicating whether the given menu item is dialog lanching
Signature
SetItemDialogLaunching(menuItemID, dialogLaunchingStaus)
Parameters: - menuItemID (int) – Menu-item ID
- dialogLaunchingStaus (bool) – Status
New in version NX7.5.0.
License requirements: None.
SetItemDisable¶
-
TreeListMenu.
SetItemDisable
¶ Sets the flag indicating whether the given menu item is disabled
Signature
SetItemDisable(menuItemID, disableStatus)
Parameters: - menuItemID (int) – Menu-item ID
- disableStatus (bool) – Status
New in version NX7.5.0.
License requirements: None.