| title | description | ms.assetid | ms.topic | ms.date |
|---|---|---|---|---|
Button (Windows Ribbon Framework) |
The Button is a control the user can click to provide input to an application. |
6d4aa571-dbea-4139-a6b7-45a85595dd04 |
article |
05/31/2018 |
The Button is a control the user can click to provide input to an application.
The following screen shot contains three examples of the Ribbon Button element.
The Ribbon framework defines a collection of property keys for the Button control.
Typically, a Button property is updated in the ribbon UI by invalidating the Command associated with the control through a call to the IUIFramework::InvalidateUICommand method. The invalidation event is handled, and the property updates defined, by the IUICommandHandler::UpdateProperty callback method.
The IUICommandHandler::UpdateProperty callback method is not executed, and the application queried for an updated property value, until the property is required by the framework. For example, when a tab is activated and a control revealed in the ribbon UI, or when a tooltip is displayed.
Note
In some cases, a property can be retrieved through the IUIFramework::GetUICommandProperty method and set with the IUIFramework::SetUICommandProperty method.
The following table lists the property keys that are associated with the Button control.
| Property Key | Notes |
|---|---|
| UI_PKEY_Enabled | Supports IUIFramework::GetUICommandProperty and IUIFramework::SetUICommandProperty. |
| UI_PKEY_Keytip | Can only be updated through invalidation. |
| UI_PKEY_Label | Can only be updated through invalidation. |
| UI_PKEY_LabelDescription | Can only be updated through invalidation. |
| UI_PKEY_LargeHighContrastImage | Can only be updated through invalidation. |
| UI_PKEY_LargeImage | Can only be updated through invalidation. |
| UI_PKEY_SmallHighContrastImage | Can only be updated through invalidation. |
| UI_PKEY_SmallImage | Can only be updated through invalidation. |
| UI_PKEY_TooltipDescription | Can only be updated through invalidation. |
| UI_PKEY_TooltipTitle | Can only be updated through invalidation. |