NXOpen .NET Reference  12.0.0
Classes | Public Member Functions | Protected Member Functions | List of all members
NXOpen.CustomPopupMenuHandler Class Reference

Represents Custom Popup Menu Handler class More...

Inheritance diagram for NXOpen.CustomPopupMenuHandler:

Classes

class  _CustomPopupMenuHandlerAddCustomPopupMenuCallbackAdapter
 
class  _CustomPopupMenuHandlerCustomPopupMenuInvokedCallbackAdapter
 

Public Member Functions

delegate int AddCustomPopupMenuCallback ()
 This callback will be invoked by NX application when a RMB click is performed on NX Tc Navigator application. More...
 
delegate int CustomPopupMenuInvokedCallback ()
 This callback will be invoked by NX when user clicks on a custom menu item. More...
 
unsafe void RegisterAddCustomPopupMenuCallback (NXOpen.CustomPopupMenuHandler.AddCustomPopupMenuCallback popupCb)
 Registers the add_custom_popup_menu_callback callback method with the popup menu handler object. More...
 
unsafe void RegisterCustomPopupMenuInvokedCallback (NXOpen.CustomPopupMenuHandler.CustomPopupMenuInvokedCallback popupCb)
 Registers the add_custom_popup_menu_callback callback method with the popup menu handler object. More...
 
unsafe void GetSelectedNodes (out NXOpen.TreeListNode[] selectedNodes)
 Returns a list of node(s) selected during a RMB click. More...
 
unsafe NXOpen.CustomPopupMenuItem GetInvokedCommand ()
 Returns the menu item for the command invoked More...
 
unsafe NXOpen.CustomPopupMenu AddMenu (int menuId, string menuName)
 Adds and returns a menu to the COTS (Commercial, off-the-shelf) RMB menu More...
 
unsafe NXOpen.CustomPopupMenuItem AddMenuItem (int menuItemId, string menuItemName)
 Adds and returns a menu item to the COTS (Commercial, off-the-shelf) RMB menu More...
 
unsafe void AddMenuSeparator ()
 Adds a separator to the COTS (Commercial, off-the-shelf) RMB menu More...
 

Protected Member Functions

override void FreeResource ()
 Frees the object from memory. More...
 

Detailed Description

Represents Custom Popup Menu Handler class

Created in NX6.0.4

Member Function Documentation

delegate int NXOpen.CustomPopupMenuHandler.AddCustomPopupMenuCallback ( )

This callback will be invoked by NX application when a RMB click is performed on NX Tc Navigator application.

Customer can query the selected object(s) and set the cascading custom popup menu to be appended to the existing COTS (Commercial, off-the-shelf) RMB popup menu.

Created in NX6.0.4

License requirements: None.

unsafe NXOpen.CustomPopupMenu NXOpen.CustomPopupMenuHandler.AddMenu ( int  menuId,
string  menuName 
)

Adds and returns a menu to the COTS (Commercial, off-the-shelf) RMB menu

Created in NX6.0.4

License requirements: None.

Parameters
menuIdId of the menu
menuNamename of the menu
Returns
menu
unsafe NXOpen.CustomPopupMenuItem NXOpen.CustomPopupMenuHandler.AddMenuItem ( int  menuItemId,
string  menuItemName 
)

Adds and returns a menu item to the COTS (Commercial, off-the-shelf) RMB menu

Created in NX6.0.4

License requirements: None.

Parameters
menuItemIdId of the menu item
menuItemNamename of the menu item
Returns
menu item
unsafe void NXOpen.CustomPopupMenuHandler.AddMenuSeparator ( )

Adds a separator to the COTS (Commercial, off-the-shelf) RMB menu

Created in NX6.0.4

License requirements: None.

delegate int NXOpen.CustomPopupMenuHandler.CustomPopupMenuInvokedCallback ( )

This callback will be invoked by NX when user clicks on a custom menu item.

The picked menu and object(s) selected can be queried from within this callback.The custom implementation can perform appropriate action associated with this menu pick.

Created in NX6.0.4

License requirements: None.

override void NXOpen.CustomPopupMenuHandler.FreeResource ( )
protected

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX6.0.4

License requirements: None.

unsafe NXOpen.CustomPopupMenuItem NXOpen.CustomPopupMenuHandler.GetInvokedCommand ( )

Returns the menu item for the command invoked

Created in NX6.0.4

License requirements: None.

Returns
menu item
unsafe void NXOpen.CustomPopupMenuHandler.GetSelectedNodes ( out NXOpen.TreeListNode[]  selectedNodes)

Returns a list of node(s) selected during a RMB click.

Customer can call this query API inside the implementation of NXOpen.CustomPopupMenuHandler.AddCustomPopupMenuCallback or NXOpen.CustomPopupMenuHandler.CustomPopupMenuInvokedCallback to obtain additional information

Created in NX6.0.4

License requirements: None.

Parameters
selectedNodesSelected Nodes
unsafe void NXOpen.CustomPopupMenuHandler.RegisterAddCustomPopupMenuCallback ( NXOpen.CustomPopupMenuHandler.AddCustomPopupMenuCallback  popupCb)

Registers the add_custom_popup_menu_callback callback method with the popup menu handler object.

Created in NX6.0.4

License requirements: None.

Parameters
popupCb
unsafe void NXOpen.CustomPopupMenuHandler.RegisterCustomPopupMenuInvokedCallback ( NXOpen.CustomPopupMenuHandler.CustomPopupMenuInvokedCallback  popupCb)

Registers the add_custom_popup_menu_callback callback method with the popup menu handler object.

Created in NX6.0.4

License requirements: None.

Parameters
popupCb

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.