Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission.

Properties

m_bFileTabButtonDisplaysText Specifies whether the ribbon file button displays text instead of icon if set to true. By default is set to false. This flag property affects only on UI themes which use tab like ribbon file button
m_pBackstageViewWnd Specifies pointer to a backstage view window which ribbon file button should display. If set to NULL, then file button should display ribbon file menu. Default value is NULL.
m_strCaptionDelimiter Symbol which allows you to colorize the application caption.

Classes

BackstageView_EnsureHidden Hides a backstage view window.
BackstageView_EnsureVisible Shows a backstage view window and, optionally, activates its key tips.
BackstageView_IsSupported Returns true if backstage view is attached to this ribbon bar (if m_pBackstageViewWnd property is not NULL). Otherwise returns false.
BackstageView_IsVisible Returns true if backstage view is displayed. Otherwise returns false.
BackstageView_Toggle Toggles visibility of a backstage view window and, optionally, activates its key tips.
~CExtRibbonBar Destructor.
CExtRibbonBar Default constructor.
Ribbon_AutoHideModeDoExpanding Expands the current ribbon page and returns true if succeeded or false otherwise.
Ribbon_AutoHideModeEnabledGet Returns true if the ribbon in the auto-hide mode or false otherwise.
Ribbon_AutoHideModeEnabledSet Turns on/off the auto-hide mode.
Ribbon_GetFileRootNode Returns a pointer to the command tree node associated with the file button.
Ribbon_GetQuickAccessRootNode Returns a pointer to the command tree node associated with the Quick Access Toolbar.
Ribbon_GetRightRootNode Returns a pointer to the command tree node which is the parent of the nodes associated with the buttons located above the ribbon pages on the right side.
Ribbon_GetTabPageRootNode Returns a pointer to the command tree node that is the parent of the nodes associated with the ribbon tabs.
Ribbon_PageSelectionGet Returns a zero-based index of the currently selected tab.
Ribbon_PageSelectionSet Selects the tab and shows the ribbon page associated with it.
Ribbon_QuickAccessContentExpandButtonGet Gets a pointer to the rightmost (chevron) button in the Quick Access Toolbar.
Ribbon_QuickAccessContentExpandButtonPaint Paints the rightmost (chevron) button in the Quick Access Toolbar and returns true if succeeded or false otherwise.
SetButtons Sets a pointer to the command tree node button.

Overridables

OnRibbonFileMenuButtonInvocation Called when the user clicks the Exit or Options button in the File pop-up menu.
OnRibbonPrepareBarContextMenu Invoked for modifying constructed by default context menu which is to be displayed over the ribbon bar but not over any of its buttons. You can cancel the menu by returning false in the overridden method.
OnRibbonPrepareButtonContextMenu Invoked for modifying constructed by default context menu which is to be displayed over the ribbon button. You can cancel the menu by returning false in the overridden method.
OnRibbonTrackButtonContextMenu Called when the context pop-up menu is about to be displayed. The method is called if the mouse pointer is located over the specified ribbon bar button. You can cancel the menu by returning false in the overridden method.
OnRibbonFileMenuButtonQuery Called when the File pop-up is about to be displayed and allows you to change the icon and text for the Exit or Options buttons.
OnRibbonTrackBarContextMenu Called when the context pop-up is about to be displayed. The method is called if the mouse pointer is located outside any of ribbon bar button. You can cancel the menu by returning false in the overridden method.

See Also

CExtRibbonBar Overview | Hierarchy Chart