Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Group organizes related Commands and controls within a Tab.
Details
The following screen shot illustrates the Ribbon Group control.
Group Properties
The Ribbon framework defines a collection of property keys for the Group control.
Typically, a Group 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 Group control.
| Property Key | Notes |
|---|---|
| UI_PKEY_Keytip | Can only be updated through invalidation. Note: The framework requires that the value of UI_PKEY_Keytip for a Group control begins with the upper-case letter Z. If the value supplied by the application in the IUICommandHandler::UpdateProperty callback method does not begin with the letter Z, this value is ignored and a value is generated by the framework instead. The framework value is the letter Z followed by a numeric value starting at 1 and increasing sequentially, as required, for subsequent Group controls (Z1, Z2, ..., Zx). |
| UI_PKEY_Label | 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. |