IUIFramework interface

The IUIFramework interface is implemented by the Windows Ribbon framework and defines the methods that provide the core functionality for the framework.

When to implement

Client applications do not implement this interface; custom implementations are not supported.

When to use

Client applications use this interface to instantiate and interact with the Ribbon framework. An implementation is provided by UIRibbonFramework.

Members

The IUIFramework interface inherits from the IUnknown interface. IUIFramework also has these types of members:

Methods

The IUIFramework interface has these methods.

MethodDescription
Destroy

Terminates and releases all objects, hooks, and references for an instance of the Ribbon framework.

FlushPendingInvalidations

Processes all pending Command updates.

GetUICommandProperty

Retrieves a command property, value, or state.

GetView

Retrieves the address of a pointer to an interface that represents a Ribbon framework View, such as IUIRibbon or IUIContextualUI.

Initialize

Connects the host application to the Ribbon framework.

InvalidateUICommand

Invalidates a Ribbon framework Command property, value, or state.

LoadUI

Loads the Ribbon framework UI resource, or compiled markup, file.

SetModes

Specifies the application modes to enable.

SetUICommandProperty

Sets a command property, value, or state.

 

Remarks

This interface is used to initialize and dismantle the Ribbon framework.

Ribbon framework UI functionality is differentiated by Views, which are essentially built-in core controls, such as the Ribbon and ContextPopup.

To get an interface pointer to the implementation of IUIFramework, use CoCreateInstance to create a COM object with the class identifier (CLSID) of CLSID_UIRibbonFramework.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]

Header

Uiribbon.h

IDL

Uiribbon.idl

DLL

Uiribbon.dll

See also

Windows Ribbon Framework Samples

 

 

Community Additions

ADD
Show:
© 2014 Microsoft