Метод IUIFramework::LoadUI (uiribbon.h)

Статья
03/13/2024

Загружает файл ресурса пользовательского интерфейса платформы ленты Windows или скомпилированной разметки.

Синтаксис

HRESULT LoadUI(
  [in] HINSTANCE instance,
  [in] LPCWSTR   resourceName
);

Параметры

[in] instance

Тип: HINSTANCE

Дескриптор экземпляра приложения ленты.

[in] resourceName

Тип: LPCWSTR

Имя ресурса, содержащего скомпилированную двоичную разметку.

Примечание Для успешной инициализации ленты скомпилированный файл разметки ленты должен быть доступен в качестве ресурса. Этот файл разметки является неотъемлемой частью платформы ленты; он указывает элементы управления для использования и их макет.

Возвращаемое значение

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

IUIFramework::LoadUI следует вызывать при инициализации. Этот метод можно вызывать несколько раз в течение жизненного цикла приложения, например для отображения или скрытия ленты, при условии, что между ними вызывается IUIFramework::D eвыработка .

OnCreateUICommand и OnViewChanged вызываются во время выполнения IUIFramework::LoadUI.

Примеры

В следующем примере демонстрируется базовая функция инициализации платформы.

//
//  FUNCTION:    InitializeFramework(HWND)
//
//  PURPOSE:    Initialize the Ribbon framework and bind a Ribbon to the application.
//
//  PARAMETERS:    
//                hWnd - Handle to the Ribbon host application window. 
//
//  COMMENTS:
//
//    In order to get a Ribbon to display, the Ribbon framework must be initialized. 
//    This involves three important steps:
//      1) Instantiate the Ribbon framework object (CLSID_UIRibbonFramework).
//      2) Pass the host HWND and IUIApplication object to the framework.
//      3) Load the binary markup compiled by the UI Command Compiler (UICC.exe).
//
//
bool InitializeFramework(HWND hWnd)
{
    // Instantiate the Ribbon framework object.
    HRESULT hr = CoCreateInstance(
        CLSID_UIRibbonFramework, 
        NULL, 
        CLSCTX_INPROC_SERVER, 
        IID_PPV_ARGS(&g_pFramework));
    if (!SUCCEEDED(hr))
    {
        return false;
    }    

    // Create the application object (IUIApplication) and call the 
    // framework Initialize method, passing the application object and the 
    // host HWND that the Ribbon will attach itself to.
    CComObject<CApplication> *pApplication = NULL;
    CComObject<CApplication>::CreateInstance(&pApplication);
    hr = pApplication->QueryInterface(&g_pApplication);
    if (!SUCCEEDED(hr))
    {
        return false;
    } 

    hr = g_pFramework->Initialize(hWnd, g_pApplication);
    if (!SUCCEEDED(hr))
    {
        return false;
    }

    // Load the binary markup.  
    // Initiate callbacks to the IUIApplication object that was 
    // provided to the framework earlier and bind command handler(s) 
    // to individual commands.
    hr = g_pFramework->LoadUI(GetModuleHandle(NULL), L"APPLICATION_RIBBON");
    if (!SUCCEEDED(hr))
    {
        return false;
    }
    return true;
}

Требования

Требование	Значение
Минимальная версия клиента	Windows 7 [только классические приложения]
Минимальная версия сервера	Windows Server 2008 R2 [только классические приложения]
Целевая платформа	Windows
Header	uiribbon.h
DLL	Mshtml.dll