Windows Ribbon Framework

Overview of the Windows Ribbon Framework technology.

To develop Windows Ribbon Framework, you need these headers:

For programming guidance for this technology, see:

Enumerations

Title Description
UI_COLLECTIONCHANGE Specifies values that identify the types of changes that can be made to a collection.
UI_COMMANDTYPE Specifies values that identify the type of Command associated with a Ribbon control.
UI_CONTEXTAVAILABILITY Specifies values that identify the availability of a contextual tab.
UI_CONTROLDOCK Specifies values that identify the dock state of the Quick Access Toolbar (QAT).
UI_EVENTLOCATION Identifies the locations where events associated with a Ribbon control can originate.
UI_EVENTTYPE Identifies the types of events associated with a Ribbon.
UI_EXECUTIONVERB Specifies values that identify the execution IDs that map to actions a user can initiate on a Command.
UI_FONTDELTASIZE Specifies values that identify whether the font size of a highlighted text run should be incremented or decremented.
UI_FONTPROPERTIES Specifies values that identify the font property state of a FontControl, such as Strikethrough.
UI_FONTUNDERLINE Specifies values that identify the underline state of a FontControl.
UI_FONTVERTICALPOSITION Specifies values that identify the vertical-alignment state of a FontControl.
UI_INVALIDATIONS Specifies values that identify the aspect of a Command to invalidate.
UI_OWNERSHIP Specifies values that identify the ownership conditions under which an image is created by the Windows Ribbon framework.
UI_SWATCHCOLORMODE Specifies whether a swatch has normal or monochrome mode.
UI_SWATCHCOLORTYPE Specifies the values that identify how a color swatch in a DropDownColorPicker or a FontControl color picker (Text color or Text highlight) is filled.Note  These are recommendations only.
UI_VIEWTYPE Specifies values that identify the Ribbon framework View.
UI_VIEWVERB Specifies values that identify the type of action to complete on a Ribbon framework View.

Functions

Title Description
Add Adds an item to the end of the IUICollection.
Clear Deletes all items from the IUICollection.
CreateImage Creates an IUIImage object from a bitmap image.
Destroy Terminates and releases all objects, hooks, and references for an instance of the Windows Ribbon framework.
Execute Responds to execute events on Commands bound to the Command handler.
FlushPendingInvalidations Processes all pending Command updates.
GetBitmap Retrieves a bitmap to display as an icon in the ribbon and context popup UI of the Windows Ribbon framework.
GetCount Retrieves the number of items contained in the IUICollection.
GetHeight Retrieves the height of the ribbon.
GetItem Retrieves an item from the IUICollection at the specified index.
GetUICommandProperty Retrieves a command property, value, or state.
GetValue Retrieves the value identified by a property key.
GetView Retrieves the address of a pointer to an interface that represents a Windows Ribbon framework View, such as IUIRibbon or IUIContextualUI.
Initialize Connects the host application to the Windows Ribbon framework.
Insert Inserts an item into the IUICollection at the specified index.
InvalidateUICommand Invalidates a Windows Ribbon framework Command property, value, or state.
LoadSettingsFromStream Reads ribbon settings from a binary stream.
LoadUI Loads the Windows Ribbon framework UI resource, or compiled markup, file.
OnChanged Called when an IUICollection changes.
OnCreateUICommand Called for each Command specified in the Windows Ribbon framework markup to bind the Command to an IUICommandHandler.
OnDestroyUICommand Called for each Command specified in the Windows Ribbon framework markup when the application window is destroyed.
OnUIEvent Receives notifications that a ribbon event has occurred.
OnViewChanged Called when the state of a View changes.
RemoveAt Removes an item from the IUICollection at the specified index.
Replace Replaces an item at the specified index of the IUICollection with another item.
SaveSettingsToStream Writes ribbon settings to a binary stream.
SetEventLogger Sets the event logger for ribbon events.
SetModes Specifies the application modes to enable.
SetUICommandProperty Sets a command property, value, or state.
ShowAtLocation Displays a ContextPopup.
UpdateProperty Responds to property update requests from the Windows Ribbon framework.

Interfaces

Title Description
IUIApplication The IUIApplication interface is implemented by the application and defines the callback entry-point methods for the Windows Ribbon framework.
IUICollection The IUICollection interface is implemented by the Ribbon framework.
IUICollectionChangedEvent The IUICollectionChangedEvent interface is implemented by the application and defines the method required to handle changes to a collection at run time.
IUICommandHandler The IUICommandHandler interface is implemented by the application and defines the methods for gathering Command information and handling Command events from the Windows Ribbon framework.
IUIContextualUI The IUIContextualUI interface is implemented by the Ribbon framework and provides the core functionality for the Context Popup View.
IUIEventingManager The IUIEventingManager interface is implemented by the Ribbon framework and provides the notification functionality for applications that register for ribbon events.
IUIEventLogger The IUIEventLogger interface is implemented by the application and defines the ribbon events callback method.
IUIFramework The IUIFramework interface is implemented by the Windows Ribbon framework and defines the methods that provide the core functionality for the framework.
IUIImage The IUIImage interface is implemented by the application and defines the method for retrieving an image to display in the ribbon and context popup UI of the Windows Ribbon framework .
IUIImageFromBitmap IUIImageFromBitmap is a factory interface implemented by the Windows Ribbon framework that defines the method for creating an IUIImage object.
IUIRibbon The IUIRibbon interface is implemented by the Windows Ribbon framework and provides the ability to specify settings and properties for a ribbon.
IUISimplePropertySet IUISimplePropertySet is a read-only interface that defines a method for retrieving the value identified by a property key.

Structures

Title Description
UI_EVENTPARAMS Contains information about a Ribbon event.
UI_EVENTPARAMS_COMMAND Contains information about a Command associated with a event.