NX二次開發-自定義添加右鍵菜單RegisterConfigureContextMenuCallback

首先聲明這個知識我以前不知道，是夏天的時候看到別人在唐工的QQ群里問的，唐工說西門子官方有這個例子。那個時候我因為在忙其他事情，也就沒去研究那個右鍵菜單到底是怎么做的。關於自定義添加右鍵菜單RegisterConfigureContextMenuCallback相關內容，可以去UGOPEN里研究ConfigureContextMenu這個例子。

結合NXOPEN幫助對照函數一步步去理解，是怎么使用的。

在線幫助地址https://docs.plm.automation.siemens.com/data_services/resources/nx/11/nx_api/custom/en_US/open_c++_ref/a12985.html

都在MenuBar命名空間里,用的下面幾個類里的方法

//NX11_NXOpenCPP_Wizard1

// Mandatory UF Includes
#include <uf.h>
#include <uf_object_types.h>

// Internal Includes
#include <NXOpen/ListingWindow.hxx>
#include <NXOpen/NXMessageBox.hxx>
#include <NXOpen/UI.hxx>

// Internal+External Includes
#include <NXOpen/Annotations.hxx>
#include <NXOpen/Assemblies_Component.hxx>
#include <NXOpen/Assemblies_ComponentAssembly.hxx>
#include <NXOpen/Body.hxx>
#include <NXOpen/BodyCollection.hxx>
#include <NXOpen/Face.hxx>
#include <NXOpen/Line.hxx>
#include <NXOpen/NXException.hxx>
#include <NXOpen/NXObject.hxx>
#include <NXOpen/Part.hxx>
#include <NXOpen/PartCollection.hxx>
#include <NXOpen/Session.hxx>

//頭文件
#include <NXOpen/Session.hxx>
#include <NXOpen/MenuBar_ContextMenu.hxx>
#include <NXOpen/MenuBar_ContextMenuEntry.hxx>
#include <NXOpen/MenuBar_ContextMenuProperties.hxx>
#include <NXOpen/MenuBar_MenuBarManager.hxx>
#include <NXOpen/MenuBar_MenuButton.hxx>
#include <NXOpen/MenuBar_MenuButtonEvent.hxx>
#include <NXOpen/UI.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/NXException.hxx>

//命名空間
using namespace NXOpen;
using namespace MenuBar;

// Std C++ Includes
#include <iostream>
#include <sstream>

using std::string;
using std::exception;
using std::stringstream;
using std::endl;
using std::cout;
using std::cerr;


//------------------------------------------------------------------------------
// NXOpen c++ test class 
//------------------------------------------------------------------------------
class MyClass
{
    // class members
public:
    static Session *theSession;
    static UI *theUI;

    MyClass();
    ~MyClass();

    void do_it();
    void print(const NXString &);
    void print(const string &);
    void print(const char*);

    //聲明函數
    int CustomizeMenu(MenuBar::ContextMenu* menu, MenuBar::ContextMenuProperties* props);

private:
    Part *workPart, *displayPart;
    NXMessageBox *mb;
    ListingWindow *lw;
    LogFile *lf;
};

//------------------------------------------------------------------------------
// Initialize static variables
//------------------------------------------------------------------------------
Session *(MyClass::theSession) = NULL;
UI *(MyClass::theUI) = NULL;

static MyClass* theConfigureContextMenu = NULL;
//------------------------------------------------------------------------------
// Constructor 
//------------------------------------------------------------------------------
MyClass::MyClass()
{

    // Initialize the NX Open C++ API environment
    MyClass::theSession = NXOpen::Session::GetSession();
    MyClass::theUI = UI::GetUI();
    mb = theUI->NXMessageBox();
    lw = theSession->ListingWindow();
    lf = theSession->LogFile();

    workPart = theSession->Parts()->Work();
    displayPart = theSession->Parts()->Display();
    
    //注冊一個回調,每當要顯示可自定義的右鍵菜單時調用該回調
    MyClass::theUI->MenuBarManager()->RegisterConfigureContextMenuCallback("ConfigureContextMenu.cpp",
        "An example of context menu customization demonstrating various functions.",
        make_callback(this, &MyClass::CustomizeMenu));
}

//------------------------------------------------------------------------------
// Destructor
//------------------------------------------------------------------------------
MyClass::~MyClass()
{
}

//------------------------------------------------------------------------------
// Print string to listing window or stdout
//------------------------------------------------------------------------------
void MyClass::print(const NXString &msg)
{
    if(! lw->IsOpen() ) lw->Open();
    lw->WriteLine(msg);
}
void MyClass::print(const string &msg)
{
    if(! lw->IsOpen() ) lw->Open();
    lw->WriteLine(msg);
}
void MyClass::print(const char * msg)
{
    if(! lw->IsOpen() ) lw->Open();
    lw->WriteLine(msg);
}


int MyClass::CustomizeMenu(MenuBar::ContextMenu* menu, MenuBar::ContextMenuProperties* props)
{
    try
    {
        //查找與給定名稱關聯的MenuButton,此名稱必須與.men文件中使用的按鈕名稱匹配
        MenuBar::MenuButton* newButton1 = theUI->MenuBarManager()->GetButtonFromName("NuoPuWrite_Dim_NameTools");

        //查找與給定名稱關聯的MenuButton,此名稱必須與.men文件中使用的按鈕名稱匹配
        MenuBar::MenuButton* newButton2 = theUI->MenuBarManager()->GetButtonFromName("OpenTxtWriteExp");

        //查找與給定名稱關聯的MenuButton,此名稱必須與.men文件中使用的按鈕名稱匹配
        MenuBar::MenuButton* newButton3 = theUI->MenuBarManager()->GetButtonFromName("RenameComponent");

        //將菜單欄按鈕添加到右鍵菜單
        menu->AddMenuButton(newButton1, 0);//創建新按鈕的位置,0是第一個,使用-1將按鈕添加到菜單的末尾

        //在右鍵菜單中添加一個分隔符
        menu->AddSeparator(1);

        //在右鍵菜單中添加一個子菜單
        MenuBar::ContextMenu* subMenu = menu->AddSubmenu("用戶自定義子菜單", 2);
        subMenu->AddMenuButton(newButton2, 0);
        subMenu->AddMenuButton(newButton3, 1);

        //將標簽添加到右鍵菜單
        menu->AddMenuLabel("這是標簽", 3);

        //指示右鍵菜單是否包含具有給定的名稱
        if (menu->HasEntryWithName("UG_EDIT_DELETE"))
        {
            MenuBar::ContextMenuEntry* deleteMenuEntry = menu->GetEntryWithName("UG_EDIT_DELETE");

            //防止所指示的菜單項顯示在右鍵菜單上
            menu->HideEntry(deleteMenuEntry);
        }

        //查找菜單上最后一個可見的按鈕項
        MenuBar::ContextMenuEntry* entry = NULL;
        //返回右鍵菜單中按鈕的數量
        int numMenuEntries = menu->NumberOfEntries();
        for (int i = 0; i < numMenuEntries; i++)
        {
            //返回右鍵菜單中指定索引處
            MenuBar::ContextMenuEntry* entry2 = menu->GetEntry(i);

            //EntryType返回此菜單項的類型
            //IsHidden如果此項在右鍵菜單上隱藏,則返回true
            //IsSensitive如果可以運行與此條目對應的命令,則返回true
            if (entry2->EntryType() == MenuBar::ContextMenuEntry::TypePushButton &&
                !entry2->IsHidden() && entry2->IsSensitive())
            {
                entry = entry2;
            }
        }

        //對已有的右鍵菜單重新排序
        //將標識項設置為默認項並移動到菜單的頂部
        if (entry != NULL)
        {
            //使指定的菜單項成為右鍵菜單的默認項
            menu->SetDefaultEntry(entry);

            //重新排序菜單,以將菜單項移動到列表中的新位置
            menu->MoveEntry(entry, 4);
        }


    }
    catch (const NXOpen::NXException& ex)
    {
        std::cerr << "Caught exception" << ex.Message() << std::endl;
    }

    return 0;

}


//------------------------------------------------------------------------------
// Do something
//------------------------------------------------------------------------------
void MyClass::do_it()
{

    // TODO: add your code here
    
}

//------------------------------------------------------------------------------
// Entry point(s) for unmanaged internal NXOpen C/C++ programs
//------------------------------------------------------------------------------
//  NX Startup
//ufsta在NX啟動時調用,向NX注冊回調
extern "C" DllExport void ufsta( char *param, int *returnCode, int rlen )
{
    try
    {
        // Create NXOpen C++ class instance
        MyClass *theMyClass;
        theMyClass = new MyClass();
        theMyClass->do_it();
        delete theMyClass;
    }
    catch (const NXException& e1)
    {
        UI::GetUI()->NXMessageBox()->Show("NXException", NXOpen::NXMessageBox::DialogTypeError, e1.Message());
    }
    catch (const exception& e2)
    {
        UI::GetUI()->NXMessageBox()->Show("Exception", NXOpen::NXMessageBox::DialogTypeError, e2.what());
    }
    catch (...)
    {
        UI::GetUI()->NXMessageBox()->Show("Exception", NXOpen::NXMessageBox::DialogTypeError, "Unknown Exception.");
    }
}


//------------------------------------------------------------------------------
// Unload Handler
//------------------------------------------------------------------------------
extern "C" DllExport int ufusr_ask_unload()
{
    return (int)NXOpen::Session::LibraryUnloadOptionAtTermination;//卸載方式一定要用這個
}


Caesar盧尚宇
2019年11月24日